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

Class OceanTidesDataProvider

java.lang.Object

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

All Implemented Interfaces:

OceanTidesCoefficientsProvider, IOceanTidesDataProvider

public class OceanTidesDataProvider
extends Object
implements IOceanTidesDataProvider

Ocean tides parameters given by the IERS 1996, 2003 or GINS 2004 standard.

Since:

2.3.1

Version:

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

Author:

maggioranic

Concurrency :

immutable

Constructor Summary

Constructors

Constructor and Description
OceanTidesDataProvider(OceanTidesCoefficientsProvider coefficientsProvider, TidesStandards.TidesStandard tideStandard) Simple constructor.

Method Summary

Methods

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
double[]	getLoveNumbers() Get love 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
TidesStandards.TidesStandard	getStandard() Get the ocean tides standard

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OceanTidesDataProvider

public OceanTidesDataProvider(OceanTidesCoefficientsProvider coefficientsProvider,
                      TidesStandards.TidesStandard tideStandard)

Simple constructor.

Parameters:

coefficientsProvider - the ocean tide coefficients provider

tideStandard - the ocean tide standard

Since:

2.3.1

Method Detail

getCpmSpm

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

Description copied from interface: OceanTidesCoefficientsProvider

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

Specified by:

getCpmSpm in interface OceanTidesCoefficientsProvider

Parameters:

nDoodson - doodson number

l - order

m - degree

Returns:

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

getCpmEpm

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

Description copied from interface: OceanTidesCoefficientsProvider

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

Specified by:

getCpmEpm in interface OceanTidesCoefficientsProvider

Parameters:

nDoodson - doodson number doodson number

l - order

m - degree

Returns:

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

getDoodsonNumbers

public double[] getDoodsonNumbers()

Description copied from interface: OceanTidesCoefficientsProvider

Get available Doodson numbers

Specified by:

getDoodsonNumbers in interface OceanTidesCoefficientsProvider

Returns:

array of Doodson numbers

getMaxDegree

public int getMaxDegree(double doodson,
               int order)

Description copied from interface: OceanTidesCoefficientsProvider

Get maximum degree for given wave and order

Specified by:

getMaxDegree in interface OceanTidesCoefficientsProvider

Parameters:

doodson - number

order - of wave

Returns:

Max degree for given wave

getMinDegree

public int getMinDegree(double doodson,
               int order)

Description copied from interface: OceanTidesCoefficientsProvider

Get min degree for given wave and order

Specified by:

getMinDegree in interface OceanTidesCoefficientsProvider

Parameters:

doodson - number

order - of wave

Returns:

Min degree for given wave

getMaxOrder

public int getMaxOrder(double doodson)

Description copied from interface: OceanTidesCoefficientsProvider

Get maximum order for given wave

Specified by:

getMaxOrder in interface OceanTidesCoefficientsProvider

Parameters:

doodson - number

Returns:

Max order for given wave

getLoveNumbers

public double[] getLoveNumbers()

Description copied from interface: IOceanTidesDataProvider

Get love numbers.

Specified by:

getLoveNumbers in interface IOceanTidesDataProvider

Returns:

the love numbers.

getStandard

public TidesStandards.TidesStandard getStandard()

Description copied from interface: IOceanTidesDataProvider

Get the ocean tides standard

Specified by:

getStandard in interface IOceanTidesDataProvider

Returns:

the ocean tides standard