org.orekit.forces.gravity

Class DeSitterRelativity

java.lang.Object

org.orekit.forces.AbstractForceModel

org.orekit.forces.gravity.DeSitterRelativity

All Implemented Interfaces:

ForceModel, ParametersDriversProvider

public class DeSitterRelativity
extends AbstractForceModel

De Sitter post-Newtonian correction force due to general relativity.

De Sitter term causes a precession of the orbital plane at a rate of 19 mas per year.

Since:

10.3

Author:

Bryan Cazabonne

See Also:

"Petit, G. and Luzum, B. (eds.), IERS Conventions (2010), Chapter 10, General relativistic models for space-time coordinates and equations of motion (2010)"

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRACTION_COEFFICIENT_SUFFIX Suffix for parameter name for attraction coefficient enabling Jacobian processing.

Constructor Summary

Constructors

Constructor and Description
DeSitterRelativity() Constructor.
DeSitterRelativity(CelestialBody earth, CelestialBody sun) Simple constructor.

Method Summary

Modifier and Type	Method and Description
<T extends CalculusFieldElement<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.
CelestialBody	getEarth() Get the Earth model used to compute De Sitter effect.
Stream<EventDetector>	getEventsDetectors() Get the discrete events related to the model.
<T extends CalculusFieldElement<T>> Stream<FieldEventDetector<T>>	getFieldEventsDetectors(Field<T> field) Get the discrete events related to the model.
List<ParameterDriver>	getParametersDrivers() Get the drivers for parameters.
CelestialBody	getSun() Get the sun model used to compute De Sitter effect.

Methods inherited from class org.orekit.forces.AbstractForceModel

complainIfNotSupported, getParameterDriver, isSupported

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.forces.ForceModel

addContribution, addContribution, getParameters, getParameters, init, init

Field Detail

ATTRACTION_COEFFICIENT_SUFFIX

public static final String ATTRACTION_COEFFICIENT_SUFFIX

Suffix for parameter name for attraction coefficient enabling Jacobian processing.

See Also:

Constant Field Values

Constructor Detail

DeSitterRelativity

@DefaultDataContext
public DeSitterRelativity()

Constructor.

It uses the DataContext.getDefault() to initialize the celestial bodies.

DeSitterRelativity

public DeSitterRelativity(CelestialBody earth,
                          CelestialBody sun)

Simple constructor.

Parameters:

earth - the Earth

sun - the Sun

Method Detail

getSun

public CelestialBody getSun()

Get the sun model used to compute De Sitter effect.

Returns:

the sun model

getEarth

public CelestialBody getEarth()

Get the Earth model used to compute De Sitter effect.

Returns:

the earth model

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)

Compute acceleration.

Parameters:

s - current state information: date, kinematics, attitude

parameters - values of the force model parameters

Returns:

acceleration in same frame as state

acceleration

public <T extends CalculusFieldElement<T>> FieldVector3D<T> acceleration(FieldSpacecraftState<T> s,
                                                                         T[] parameters)

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

getEventsDetectors

public Stream<EventDetector> getEventsDetectors()

Get the discrete events related to the model.

Returns:

stream of events detectors

getFieldEventsDetectors

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

Get the discrete events related to the model.

Type Parameters:

T - extends CalculusFieldElement<T>

Parameters:

field - field to which the state belongs

Returns:

stream of events detectors

getParametersDrivers

public List<ParameterDriver> getParametersDrivers()

Get the drivers for parameters.

Returns:

drivers for parameters