Class OceanLoadingCoefficients

    • Constructor Detail

      • OceanLoadingCoefficients

        public OceanLoadingCoefficients​(String siteName,
                                        GeodeticPoint siteLocation,
                                        Tide[][] tides,
                                        double[][] zAmplitude,
                                        double[][] zPhase,
                                        double[][] wAmplitude,
                                        double[][] wPhase,
                                        double[][] sAmplitude,
                                        double[][] sPhase)
        Simple constructor.

        Arrays must be organized by species and sorted in increasing rate order.

        Parameters:
        siteName - site name
        siteLocation - site location
        tides - main tides, by species and increasing rate
        zAmplitude - amplitude along zenith axis
        zPhase - phase along zenith axis
        wAmplitude - amplitude along West
        wPhase - phase along West axis
        sAmplitude - amplitude along South
        sPhase - phase along South axis
    • Method Detail

      • getSiteName

        public String getSiteName()
        Get the site name.
        Returns:
        site name
      • getSiteLocation

        public GeodeticPoint getSiteLocation()
        Get the site location.
        Returns:
        site location
      • getTide

        public Tide getTide​(int i,
                            int j)
        Get the tide.
        Parameters:
        i - species
        j - tide in the species
        Returns:
        tide
      • getZenithAmplitude

        public double getZenithAmplitude​(int i,
                                         int j)
        Get the amplitude along zenith axis.
        Parameters:
        i - species
        j - tide in the species
        Returns:
        amplitude along zenith axis
      • getZenithPhase

        public double getZenithPhase​(int i,
                                     int j)
        Get the phase along zenith axis.
        Parameters:
        i - species
        j - tide in the species
        Returns:
        phase along zenith axis
      • getWestAmplitude

        public double getWestAmplitude​(int i,
                                       int j)
        Get the amplitude along west axis.
        Parameters:
        i - species
        j - tide in the species
        Returns:
        amplitude along west axis
      • getWestPhase

        public double getWestPhase​(int i,
                                   int j)
        Get the phase along West axis.
        Parameters:
        i - species
        j - tide in the species
        Returns:
        phase along West axis
      • getSouthAmplitude

        public double getSouthAmplitude​(int i,
                                        int j)
        Get the amplitude along South axis.
        Parameters:
        i - species
        j - tide in the species
        Returns:
        amplitude along South axis
      • getSouthPhase

        public double getSouthPhase​(int i,
                                    int j)
        Get the phase along South axis.
        Parameters:
        i - species
        j - tide in the species
        Returns:
        phase along South axis
      • getNbSpecies

        public int getNbSpecies()
        Get the number of species.
        Returns:
        number of species
      • getNbTides

        public int getNbTides​(int species)
        Get the number of tides for one species.
        Parameters:
        species - species index
        Returns:
        number of tides for one species