Package org.orekit.forces.gravity

Class OceanTides

java.lang.Object

org.orekit.forces.AbstractForceModel

org.orekit.forces.gravity.OceanTides

All Implemented Interfaces:

ForceModel

public class OceanTides
extends AbstractForceModel

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).

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, int degree, int order, IERSConventions conventions, UT1Scale ut1)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
<T extends RealFieldElement<T>> FieldVector3D<T>	acceleration(FieldSpacecraftState<T> s, T[] parameters)	Compute acceleration.
Vector3D	acceleration(SpacecraftState s, double[] parameters)	Compute acceleration.
boolean	dependsOnPositionOnly()	Check if force models depends on position only.
Stream<EventDetector>	getEventsDetectors()	Get the discrete events related to the model.
<T extends RealFieldElement<T>> Stream<FieldEventDetector<T>>	getFieldEventsDetectors(Field<T> field)	Get the discrete events related to the model.
ParameterDriver[]	getParametersDrivers()	Get the drivers for force model parameters.

Methods inherited from class org.orekit.forces.AbstractForceModel

complainIfNotSupported, getParameterDriver, isSupported

Methods inherited from interface org.orekit.forces.ForceModel

addContribution, addContribution, getParameters, getParameters, init

Methods inherited from class java.lang.Object

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

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

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

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

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

Throws:

OrekitException - if the ocean tides model cannot be read or the model does not support requested degree or order

See Also:

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

OceanTides

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

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

Throws:

OrekitException - if the ocean tides model cannot be read or the model does not support requested degree or order

See Also:

GravityFieldFactory.getOceanTidesWaves(int, int)

Method Detail

dependsOnPositionOnly

public boolean dependsOnPositionOnly()

Check if force models depends on position only.

Returns:

true if force model depends on position only, false if it depends on velocity, either directly or due to a dependency on attitude

acceleration

public Vector3D acceleration(SpacecraftState s,
                             double[] parameters)
                      throws OrekitException

Compute acceleration.

Parameters:

s - current state information: date, kinematics, attitude

parameters - values of the force model parameters

Returns:

acceleration in same frame as state

Throws:

OrekitException - if some specific error occurs

acceleration

public <T extends RealFieldElement<T>> FieldVector3D<T> acceleration(FieldSpacecraftState<T> s,
                                                                     T[] parameters)
                                                              throws OrekitException

Compute acceleration.

Type Parameters:

T - type of the elements

Parameters:

s - current state information: date, kinematics, attitude

parameters - values of the force model parameters

Returns:

acceleration in same frame as state

Throws:

OrekitException - if some specific error occurs

getEventsDetectors

public Stream<EventDetector> getEventsDetectors()

Get the discrete events related to the model.

Returns:

stream of events detectors

getFieldEventsDetectors

public <T extends RealFieldElement<T>> Stream<FieldEventDetector<T>> getFieldEventsDetectors(Field<T> field)

Get the discrete events related to the model.

Type Parameters:

T - extends RealFieldElement

Parameters:

field - field to which the state belongs

Returns:

stream of events detectors

getParametersDrivers

public ParameterDriver[] getParametersDrivers()

Get the drivers for force model parameters.

Returns:

drivers for force model parameters