Package org.orekit.forces.gravity.potential

Class OceanTidesWave

java.lang.Object

org.orekit.forces.gravity.potential.OceanTidesWave

public class OceanTidesWave
extends Object

Container for ocen tides coefficients for one tide wave.

Since:

6.1

Author:

Luc Maisonobe

See Also:

OceanTides, OceanTidesReader

Constructor Summary

Constructors

Constructor	Description
OceanTidesWave(int doodson, int degree, int order, double[][][] coefficients)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
void	addContribution(BodiesElements elements, double[][] cnm, double[][] snm)	Add the contribution of the wave to Stokes coefficients.
int	getDoodson()	Get the Doodson number for the wave.
int	getMaxDegree()	Get the maximum supported degree.
int	getMaxOrder()	Get the maximum supported order.

Methods inherited from class java.lang.Object

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

Constructor Detail

OceanTidesWave

public OceanTidesWave(int doodson,
                      int degree,
                      int order,
                      double[][][] coefficients)

Simple constructor.

Parameters:

doodson - Doodson number for the wave

degree - max degree present in the coefficients array

order - max order present in the coefficients array

coefficients - C_n,m⁺, S_n,m⁺, C_n,m^- and S_n,m^- coefficients

Method Detail

getMaxDegree

public int getMaxDegree()

Get the maximum supported degree.

Returns:

maximum supported degree

getMaxOrder

public int getMaxOrder()

Get the maximum supported order.

Returns:

maximum supported order

getDoodson

public int getDoodson()

Get the Doodson number for the wave.

Returns:

Doodson number for the wave

addContribution

public void addContribution(BodiesElements elements,
                            double[][] cnm,
                            double[][] snm)

Add the contribution of the wave to Stokes coefficients.

Parameters:

elements - nutation elements

cnm - spherical harmonic cosine coefficients table to add contribution too

snm - spherical harmonic sine coefficients table to add contribution too