fr.cnes.sirius.patrius.forces.gravity.tides.coefficients

Interface OceanTidesCoefficientsProvider

All Known Subinterfaces:

IOceanTidesDataProvider

All Known Implementing Classes:

FES2004FormatReader, OceanTidesCoefficientsReader, OceanTidesDataProvider

public interface OceanTidesCoefficientsProvider

Interface for ocean tides coefficients provider.
The proper way to use this it to call the getCoefficientProvider method. Indeed, the OceanTidesCoefficientsFactory will determine the best reader to use, depending on file available in the file system.

Since:

1.2

Version:

$Id: OceanTidesCoefficientsProvider.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Rami Houdroge

Method Summary

Modifier and Type	Method and Description
double[]	getCpmEpm(double nDoodson, int l, int m) Get the Clm± and εlm± for given wave
double[]	getCpmSpm(double nDoodson, int l, int m) Get the Clm± and Slm± for given wave
double[]	getDoodsonNumbers() Get available Doodson numbers
int	getMaxDegree(double doodson, int order) Get maximum degree for given wave and order
int	getMaxOrder(double doodson) Get maximum order for given wave
int	getMinDegree(double doodson, int order) Get min degree for given wave and order

Method Detail

getCpmSpm

double[] getCpmSpm(double nDoodson,
                   int l,
                   int m)

Get the C_lm^± and S_lm^± for given wave

Parameters:

nDoodson - doodson number

l - order

m - degree

Returns:

double[4] array containing {C_lm⁺, C_lm^-, S_lm⁺, S_lm^-}

getCpmEpm

double[] getCpmEpm(double nDoodson,
                   int l,
                   int m)

Get the C_lm^± and ε_lm^± for given wave

Parameters:

nDoodson - doodson number doodson number

l - order

m - degree

Returns:

double[4] array containing {C_lm⁺, C_lm^-, ε_lm⁺, ε_lm^-}

getDoodsonNumbers

double[] getDoodsonNumbers()

Get available Doodson numbers

Returns:

array of Doodson numbers

getMaxDegree

int getMaxDegree(double doodson,
                 int order)

Get maximum degree for given wave and order

Parameters:

doodson - number

order - of wave

Returns:

Max degree for given wave

getMinDegree

int getMinDegree(double doodson,
                 int order)

Get min degree for given wave and order

Parameters:

doodson - number

order - of wave

Returns:

Min degree for given wave

getMaxOrder

int getMaxOrder(double doodson)

Get maximum order for given wave

Parameters:

doodson - number

Returns:

Max order for given wave