Package org.orekit.forces.gravity

Class OceanTides

java.lang.Object

org.orekit.forces.gravity.OceanTides

All Implemented Interfaces:

ForceModel, ForceModelModifier, EventDetectorsProvider, ParameterDriversProvider

public class OceanTides
extends Object
implements ForceModelModifier

Ocean 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
OceanTides(Frame centralBodyFrame, double ae, double mu, boolean poleTide, double step, int nbPoints, int degree, int order, IERSConventions conventions, UT1Scale ut1)	Simple constructor.
OceanTides(Frame centralBodyFrame, double ae, double mu, boolean poleTide, double step, int nbPoints, int degree, int order, IERSConventions conventions, UT1Scale ut1, GravityFields gravityFields)	Simple constructor.
OceanTides(Frame centralBodyFrame, double ae, double mu, int degree, int order, IERSConventions conventions, UT1Scale ut1)	Simple constructor.

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

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

OceanTides

@DefaultDataContext
public OceanTides(Frame centralBodyFrame,
                  double ae,
                  double mu,
                  int degree,
                  int order,
                  IERSConventions conventions,
                  UT1Scale ut1)

Simple constructor.

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

This constructor uses the default data context.

Parameters:

centralBodyFrame - rotating body frame

ae - central body reference radius

mu - central body attraction coefficient

degree - degree of the tide model to load

order - order of the tide model to load

conventions - IERS conventions used for loading ocean pole tide

ut1 - UT1 time scale

See Also:

DEFAULT_STEP, DEFAULT_POINTS, OceanTides(Frame, double, double, boolean, double, int, int, int, IERSConventions, UT1Scale), GravityFields.getOceanTidesWaves(int, int), OceanTides(Frame, double, double, boolean, double, int, int, int, IERSConventions, UT1Scale, GravityFields)

OceanTides

@DefaultDataContext
public OceanTides(Frame centralBodyFrame,
                  double ae,
                  double mu,
                  boolean poleTide,
                  double step,
                  int nbPoints,
                  int degree,
                  int order,
                  IERSConventions conventions,
                  UT1Scale ut1)

Simple constructor.

This constructor uses the default data context.

Parameters:

centralBodyFrame - rotating body frame

ae - central body reference radius

mu - central body attraction coefficient

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)

degree - degree of the tide model to load

order - order of the tide model to load

conventions - IERS conventions used for loading ocean pole tide

ut1 - UT1 time scale

See Also:

GravityFields.getOceanTidesWaves(int, int), OceanTides(Frame, double, double, boolean, double, int, int, int, IERSConventions, UT1Scale, GravityFields)

OceanTides

public OceanTides(Frame centralBodyFrame,
                  double ae,
                  double mu,
                  boolean poleTide,
                  double step,
                  int nbPoints,
                  int degree,
                  int order,
                  IERSConventions conventions,
                  UT1Scale ut1,
                  GravityFields gravityFields)

Simple constructor.

Parameters:

centralBodyFrame - rotating body frame

ae - central body reference radius

mu - central body attraction coefficient

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)

degree - degree of the tide model to load

order - order of the tide model to load

conventions - IERS conventions used for loading ocean pole tide

ut1 - UT1 time scale

gravityFields - used to compute ocean tides.

Since:

10.1

See Also:

GravityFields.getOceanTidesWaves(int, int)

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