Package org.orekit.forces.gravity

Class SolidTides

java.lang.Object

org.orekit.forces.gravity.SolidTides

All Implemented Interfaces:

ForceModel, ForceModelModifier, EventDetectorsProvider, ParameterDriversProvider

public class SolidTides
extends Object
implements ForceModelModifier

Solid tides force model.

Since:

6.1

Author:

Luc Maisonobe

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_POINTS	Default number of points tides field sampling.
static double	DEFAULT_STEP	Default step for tides field sampling (seconds).

Fields inherited from interface org.orekit.propagation.events.EventDetectorsProvider

DATATION_ACCURACY

Constructor Summary

Constructors

Constructor	Description
SolidTides(Frame centralBodyFrame, double ae, double mu, TideSystem centralTideSystem, boolean poleTide, double step, int nbPoints, IERSConventions conventions, UT1Scale ut1, CelestialBody... bodies)	Simple constructor.
SolidTides(Frame centralBodyFrame, double ae, double mu, TideSystem centralTideSystem, IERSConventions conventions, UT1Scale ut1, CelestialBody... bodies)	Simple constructor.
SolidTides(Frame centralBodyFrame, double ae, double mu, TideSystem centralTideSystem, LoveNumbers loveNumbers, double step, int nbPoints, CelestialBody... bodies)	Constructor with custom Love numbers for any central body.
SolidTides(Frame centralBodyFrame, double ae, double mu, TideSystem centralTideSystem, LoveNumbers loveNumbers, CelestialBody... bodies)	Constructor with custom Love numbers using default interpolation settings.

Method Summary

Modifier and Type	Method	Description
ForceModel	getUnderlyingModel()	Get the underlying force model.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.propagation.events.EventDetectorsProvider

getDateDetector, getEventDetectors, getFieldDateDetector, getFieldEventDetectors

Methods inherited from interface org.orekit.forces.ForceModel

addContribution, addContribution, getMassDerivative, getMassDerivative

Methods inherited from interface org.orekit.forces.ForceModelModifier

acceleration, acceleration, dependsOnAttitudeRate, dependsOnPositionOnly, getEventDetectors, getFieldEventDetectors, getParametersDrivers, init, init

Methods inherited from interface org.orekit.utils.ParameterDriversProvider

getNbParametersDriversValue, getParameterDriver, getParameters, getParameters, getParameters, getParameters, getParametersAllValues, getParametersAllValues, isSupported

Field Detail

DEFAULT_STEP

public static final double DEFAULT_STEP

Default step for tides field sampling (seconds).

See Also:

Constant Field Values

DEFAULT_POINTS

public static final int DEFAULT_POINTS

Default number of points tides field sampling.

See Also:

Constant Field Values

Constructor Detail

SolidTides

public SolidTides(Frame centralBodyFrame,
                  double ae,
                  double mu,
                  TideSystem centralTideSystem,
                  IERSConventions conventions,
                  UT1Scale ut1,
                  CelestialBody... bodies)

Simple constructor.

This constructor uses pole tides, the default step and default number of points for the tides field interpolation.

Parameters:

centralBodyFrame - rotating body frame

ae - central body reference radius

mu - central body attraction coefficient

centralTideSystem - tide system used in the central attraction model

conventions - IERS conventions used for loading Love numbers

ut1 - UT1 time scale

bodies - tide generating bodies (typically Sun and Moon)

See Also:

DEFAULT_STEP, DEFAULT_POINTS, SolidTides(Frame, double, double, TideSystem, boolean, double, int, IERSConventions, UT1Scale, CelestialBody...)

SolidTides

public SolidTides(Frame centralBodyFrame,
                  double ae,
                  double mu,
                  TideSystem centralTideSystem,
                  boolean poleTide,
                  double step,
                  int nbPoints,
                  IERSConventions conventions,
                  UT1Scale ut1,
                  CelestialBody... bodies)

Simple constructor.

Parameters:

centralBodyFrame - rotating body frame

ae - central body reference radius

mu - central body attraction coefficient

centralTideSystem - tide system used in the central attraction model

poleTide - if true, pole tide is computed

step - time step between sample points for interpolation

nbPoints - number of points to use for interpolation, if less than 2 then no interpolation is performed (thus greatly increasing computation cost)

conventions - IERS conventions used for loading Love numbers

ut1 - UT1 time scale

bodies - tide generating bodies (typically Sun and Moon)

SolidTides

public SolidTides(Frame centralBodyFrame,
                  double ae,
                  double mu,
                  TideSystem centralTideSystem,
                  LoveNumbers loveNumbers,
                  double step,
                  int nbPoints,
                  CelestialBody... bodies)

Constructor with custom Love numbers for any central body. This constructor allows using body-specific Love numbers (e.g. for the Moon) instead of IERS Earth conventions. Note that frequency-dependent corrections and pole tide are not applied, and only the frequency-independent tidal deformation (IERS 2010 equations 6.6 and 6.7) is computed.

Parameters:

centralBodyFrame - rotating body frame

ae - central body reference radius

mu - central body attraction coefficient

centralTideSystem - tide system used in the central attraction model

loveNumbers - body-specific Love numbers

step - time step between sample points for interpolation

nbPoints - number of points to use for interpolation, if less than 2 then no interpolation is performed (thus greatly increasing computation cost)

bodies - tide generating bodies (typically Sun and Moon)

Since:

14.0

SolidTides

public SolidTides(Frame centralBodyFrame,
                  double ae,
                  double mu,
                  TideSystem centralTideSystem,
                  LoveNumbers loveNumbers,
                  CelestialBody... bodies)

Constructor with custom Love numbers using default interpolation settings.

This constructor uses the default step and default number of points for the tides field interpolation.

Parameters:

centralBodyFrame - rotating body frame

ae - central body reference radius

mu - central body attraction coefficient

centralTideSystem - tide system used in the central attraction model

loveNumbers - body-specific Love numbers

bodies - tide generating bodies (typically Sun and Moon)

Since:

14.0

See Also:

DEFAULT_STEP, DEFAULT_POINTS, SolidTides(Frame, double, double, TideSystem, LoveNumbers, double, int, CelestialBody...)

Method Detail

getUnderlyingModel

public ForceModel getUnderlyingModel()

Description copied from interface: ForceModelModifier

Get the underlying force model.

Specified by:

getUnderlyingModel in interface ForceModelModifier

Returns:

underlying model