org.orekit.data

Class FundamentalNutationArguments

java.lang.Object

org.orekit.data.FundamentalNutationArguments

All Implemented Interfaces:

Serializable

public class FundamentalNutationArguments
extends Object
implements Serializable

Class computing the fundamental arguments for nutation and tides.

The fundamental arguments are split in two sets:

• the Delaunay arguments for Moon and Sun effects
• the planetary arguments for other planets

Author:

Luc Maisonobe

See Also:

SeriesTerm, PoissonSeries, BodiesElements, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FundamentalNutationArguments(IERSConventions conventions, TimeScale timeScale, InputStream stream, String name) Build a model of fundamental arguments from an IERS table file.
FundamentalNutationArguments(IERSConventions conventions, TimeScale timeScale, InputStream stream, String name, TimeScales timeScales) Build a model of fundamental arguments from an IERS table file.
FundamentalNutationArguments(IERSConventions conventions, TimeScale timeScale, List<double[]> coefficients) Build a model of fundamental arguments from an IERS table file.
FundamentalNutationArguments(IERSConventions conventions, TimeScale timeScale, List<double[]> coefficients, TimeScales timeScales) Build a model of fundamental arguments from an IERS table file.

Method Summary

Modifier and Type	Method and Description
BodiesElements	evaluateAll(AbsoluteDate date) Evaluate all fundamental arguments for the current date (Delaunay plus planetary).
<T extends CalculusFieldElement<T>> FieldBodiesElements<T>	evaluateAll(FieldAbsoluteDate<T> date) Evaluate all fundamental arguments for the current date (Delaunay plus planetary).

Methods inherited from class java.lang.Object

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

Constructor Detail

FundamentalNutationArguments

@DefaultDataContext
public FundamentalNutationArguments(IERSConventions conventions,
                                                        TimeScale timeScale,
                                                        InputStream stream,
                                                        String name)

Build a model of fundamental arguments from an IERS table file.

This method uses the default data context.

Parameters:

conventions - IERS conventions to use

timeScale - time scale for GMST computation (may be null if tide parameter γ = GMST + π is not needed)

stream - stream containing the IERS table

name - name of the resource file (for error messages only)

See Also:

FundamentalNutationArguments(IERSConventions, TimeScale, List, TimeScales), FundamentalNutationArguments(IERSConventions, TimeScale, InputStream, String, TimeScales)

FundamentalNutationArguments

public FundamentalNutationArguments(IERSConventions conventions,
                                    TimeScale timeScale,
                                    InputStream stream,
                                    String name,
                                    TimeScales timeScales)

Build a model of fundamental arguments from an IERS table file.

Parameters:

conventions - IERS conventions to use

timeScale - time scale for GMST computation (may be null if tide parameter γ = GMST + π is not needed)

stream - stream containing the IERS table

name - name of the resource file (for error messages only)

timeScales - TAI time scale

Since:

10.1

See Also:

FundamentalNutationArguments(IERSConventions, TimeScale, List, TimeScales)

FundamentalNutationArguments

@DefaultDataContext
public FundamentalNutationArguments(IERSConventions conventions,
                                                        TimeScale timeScale,
                                                        List<double[]> coefficients)

Build a model of fundamental arguments from an IERS table file.

This method uses the default data context.

Parameters:

conventions - IERS conventions to use

timeScale - time scale for GMST computation (may be null if tide parameter γ = GMST + π is not needed)

coefficients - list of coefficients arrays (all 14 arrays must be provided, the 5 Delaunay first and the 9 planetary afterwards)

Since:

6.1

See Also:

FundamentalNutationArguments(IERSConventions, TimeScale, List, TimeScales)

FundamentalNutationArguments

public FundamentalNutationArguments(IERSConventions conventions,
                                    TimeScale timeScale,
                                    List<double[]> coefficients,
                                    TimeScales timeScales)

Build a model of fundamental arguments from an IERS table file.

Parameters:

conventions - IERS conventions to use

timeScale - time scale for GMST computation (may be null if tide parameter γ = GMST + π is not needed)

coefficients - list of coefficients arrays (all 14 arrays must be provided, the 5 Delaunay first and the 9 planetary afterwards)

timeScales - used in the computation.

Since:

10.1

Method Detail

evaluateAll

public BodiesElements evaluateAll(AbsoluteDate date)

Evaluate all fundamental arguments for the current date (Delaunay plus planetary).

Parameters:

date - current date

Returns:

all fundamental arguments for the current date (Delaunay plus planetary)

evaluateAll

public <T extends CalculusFieldElement<T>> FieldBodiesElements<T> evaluateAll(FieldAbsoluteDate<T> date)

Evaluate all fundamental arguments for the current date (Delaunay plus planetary).

Type Parameters:

T - type of the field elements

Parameters:

date - current date

Returns:

all fundamental arguments for the current date (Delaunay plus planetary)