fr.cnes.sirius.patrius.data

Class SeriesTerm

java.lang.Object

fr.cnes.sirius.patrius.data.SeriesTerm

All Implemented Interfaces:

Serializable

public abstract class SeriesTerm
extends Object
implements Serializable

Base class for nutation series terms.

Author:

Luc Maisonobe

See Also:

PoissonSeries, Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SeriesTerm(double sinCoeffIn, double cosCoeffIn) Simple constructor for the base class.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract double	argument(BodiesElements elements) Compute the argument for the current date.
static SeriesTerm	buildTerm(double sinCoeff, double cosCoeff, int cL, int cLPrime, int cF, int cD, int cOmega, int cMe, int cVe, int cE, int cMa, int cJu, int cSa, int cUr, int cNe, int cPa) Factory method for building the appropriate object.
double	value(BodiesElements elements) Compute the value of the term for the current date.
double[]	value(BodiesElements elements, BodiesElements elementsP) Compute the value of the term for the current date and its first time derivative.

Methods inherited from class java.lang.Object

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

Constructor Detail

SeriesTerm

protected SeriesTerm(double sinCoeffIn,
          double cosCoeffIn)

Simple constructor for the base class.

Parameters:

sinCoeffIn - coefficient for the sine of the argument

cosCoeffIn - coefficient for the cosine of the argument

Method Detail

value

public double value(BodiesElements elements)

Compute the value of the term for the current date.

Parameters:

elements - luni-solar and planetary elements for the current date

Returns:

current value of the term

value

public double[] value(BodiesElements elements,
             BodiesElements elementsP)

Compute the value of the term for the current date and its first time derivative.

Parameters:

elements - luni-solar and planetary elements for the current date

elementsP - luni-solar and planetary time derivative elements for the current date

Returns:

current value of the term

argument

protected abstract double argument(BodiesElements elements)

Compute the argument for the current date.

Parameters:

elements - luni-solar and planetary elements for the current date

Returns:

current value of the argument

buildTerm

public static SeriesTerm buildTerm(double sinCoeff,
                   double cosCoeff,
                   int cL,
                   int cLPrime,
                   int cF,
                   int cD,
                   int cOmega,
                   int cMe,
                   int cVe,
                   int cE,
                   int cMa,
                   int cJu,
                   int cSa,
                   int cUr,
                   int cNe,
                   int cPa)

Factory method for building the appropriate object.

The method checks the null coefficients and build an instance of an appropriate type to avoid too many unnecessary multiplications by zero coefficients.

Parameters:

sinCoeff - coefficient for the sine of the argument

cosCoeff - coefficient for the cosine of the argument

cL - coefficient for mean anomaly of the Moon

cLPrime - coefficient for mean anomaly of the Sun

cF - coefficient for L - Ω where L is the mean longitude of the Moon

cD - coefficient for mean elongation of the Moon from the Sun

cOmega - coefficient for mean longitude of the ascending node of the Moon

cMe - coefficient for mean Mercury longitude

cVe - coefficient for mean Venus longitude

cE - coefficient for mean Earth longitude

cMa - coefficient for mean Mars longitude

cJu - coefficient for mean Jupiter longitude

cSa - coefficient for mean Saturn longitude

cUr - coefficient for mean Uranus longitude

cNe - coefficient for mean Neptune longitude

cPa - coefficient for general accumulated precession in longitude

Returns:

a nutation serie term instance well suited for the set of coefficients