org.orekit.forces.gravity

Class ThirdBodyAttraction

java.lang.Object

org.orekit.forces.gravity.ThirdBodyAttraction

All Implemented Interfaces:

ForceModel, EventDetectorsProvider, ParameterDriversProvider

Direct Known Subclasses:

ThirdBodyAttractionEpoch

public class ThirdBodyAttraction
extends Object
implements ForceModel

Third body attraction force model.

Author:

Fabien Maussion, Véronique Pommier-Maurussane

Field Summary

Fields

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

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

DATATION_ACCURACY

Constructor Summary

Constructors

Constructor and Description
ThirdBodyAttraction(CelestialBody body) Simple constructor.

Method Summary

Modifier and Type	Method and Description
<T extends org.hipparchus.CalculusFieldElement<T>> org.hipparchus.geometry.euclidean.threed.FieldVector3D<T>	acceleration(FieldSpacecraftState<T> s, T[] parameters) Compute acceleration.
org.hipparchus.geometry.euclidean.threed.Vector3D	acceleration(SpacecraftState s, double[] parameters) Compute acceleration.
boolean	dependsOnPositionOnly() Check if force models depends on position only.
List<ParameterDriver>	getParametersDrivers() Get the drivers for parameters.

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, getEventDetectors, getFieldEventDetectors, init, init

Methods inherited from interface org.orekit.utils.ParameterDriversProvider

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

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

getEventDetectors, getFieldEventDetectors

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

ThirdBodyAttraction

public ThirdBodyAttraction(CelestialBody body)

Simple constructor.

Parameters:

body - the third body to consider (ex: CelestialBodies.getSun() or CelestialBodies.getMoon())

Method Detail

dependsOnPositionOnly

public boolean dependsOnPositionOnly()

Check if force models depends on position only.

Specified by:

dependsOnPositionOnly in interface ForceModel

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 org.hipparchus.geometry.euclidean.threed.Vector3D acceleration(SpacecraftState s,
                                                                      double[] parameters)

Compute acceleration.

Specified by:

acceleration in interface ForceModel

Parameters:

s - current state information: date, kinematics, attitude

parameters - values of the force model parameters at state date, only 1 value for each parameterDriver

Returns:

acceleration in same frame as state

acceleration

public <T extends org.hipparchus.CalculusFieldElement<T>> org.hipparchus.geometry.euclidean.threed.FieldVector3D<T> acceleration(FieldSpacecraftState<T> s,
                                                                                                                                 T[] parameters)

Compute acceleration.

Specified by:

acceleration in interface ForceModel

Type Parameters:

T - type of the elements

Parameters:

s - current state information: date, kinematics, attitude

parameters - values of the force model parameters at state date, only 1 value for each parameterDriver

Returns:

acceleration in same frame as state

getParametersDrivers

public List<ParameterDriver> getParametersDrivers()

Get the drivers for parameters.

Specified by:

getParametersDrivers in interface ParameterDriversProvider

Returns:

drivers for parameters