fr.cnes.sirius.patrius.forces.gravity

Class ThirdBodyAttraction

java.lang.Object

fr.cnes.sirius.patrius.math.parameter.Parameterizable

fr.cnes.sirius.patrius.math.parameter.JacobiansParameterizable

fr.cnes.sirius.patrius.forces.gravity.AbstractBodyAttraction

fr.cnes.sirius.patrius.forces.gravity.ThirdBodyAttraction

All Implemented Interfaces:

ForceModel, GradientModel, IJacobiansParameterizable, IParameterizable, Serializable

public class ThirdBodyAttraction
extends AbstractBodyAttraction

Third body attraction force model.

This attraction is a differential attraction of the body between the spacecraft and the central body. It can be synthesized as:
gamma = gamma(body->spacecraft) - gamma(body->centralBody)
Note that the expression of gamma(body->centralBody) is theoretically computed with a complex formula including the complete potential of the two bodies and a coupled term (see N. Borderies. Mutual gravitational potential of n solid bodies for more information).
In this implementation the coupled term is neglected. Beware that the coupled term coming from the low degrees might overcome the high degree independent terms of the gamma(body->centralBody) contribution.

Author:

Fabien Maussion, Véronique Pommier-Maurussane

See Also:

Serialized Form

Field Summary

Fields inherited from class fr.cnes.sirius.patrius.forces.gravity.AbstractBodyAttraction

computePartialDerivativesWrtPosition, K_FACTOR

Constructor Summary

Constructors

Constructor and Description
ThirdBodyAttraction(GravityModel gravityModelIn) Constructor.
ThirdBodyAttraction(GravityModel gravityModelIn, AbstractHarmonicGravityModel centralBodyGravityModel) Constructor.
ThirdBodyAttraction(GravityModel gravityModelIn, AbstractHarmonicGravityModel centralBodyGravityModel, boolean computePD) Constructor.
ThirdBodyAttraction(GravityModel gravityModelIn, AbstractHarmonicGravityModel centralBodyGravityModel, boolean computePD, Parameter k) Constructor.
ThirdBodyAttraction(GravityModel gravityModelIn, boolean computePD) Constructor.
ThirdBodyAttraction(GravityModel gravityModelIn, boolean computePD, Parameter k) Constructor.

Method Summary

Modifier and Type	Method and Description
void	checkData(AbsoluteDate start, AbsoluteDate end) This methods throws an exception if the user did not provide all the required data to perform model call on provided range [start; end].
protected Vector3D	computeAcceleration(Vector3D positionInBodyFrame, AbsoluteDate date, Transform scFrameToBodyFrame) Abstract method to compute the acceleration of the implementation

Methods inherited from class fr.cnes.sirius.patrius.forces.gravity.AbstractBodyAttraction

addContribution, addDAccDParam, addDAccDParam, addDAccDState, addDAccDState, computeAcceleration, computeGradientPosition, computeGradientVelocity, getEventsDetectors, getGravityModel, getMultiplicativeFactor, getMultiplicativeFactorParameter, setMultiplicativeFactor

Methods inherited from class fr.cnes.sirius.patrius.math.parameter.JacobiansParameterizable

addJacobiansParameter, addJacobiansParameter, addJacobiansParameter, supportsJacobianParameter

Methods inherited from class fr.cnes.sirius.patrius.math.parameter.Parameterizable

addAllParameters, addAllParameters, addParameter, getParameters, supportsParameter

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sirius.patrius.math.parameter.IParameterizable

getParameters, supportsParameter

Constructor Detail

ThirdBodyAttraction

public ThirdBodyAttraction(GravityModel gravityModelIn)

Constructor.
Partial derivative computation is enabled by default.

Parameters:

gravityModelIn - the gravitational attraction model to consider

Throws:

NullArgumentException - if gravityModelIn is null

ThirdBodyAttraction

public ThirdBodyAttraction(GravityModel gravityModelIn,
                           AbstractHarmonicGravityModel centralBodyGravityModel)

Constructor.
Partial derivative computation is enabled by default.

Parameters:

gravityModelIn - the gravitational attraction model to consider

centralBodyGravityModel - The central body gravity model to take into account the harmonic contribution in the gamma(body->centralBody) term.
Can be null.
Note: NewtonianGravityModel isn't supported, the model will be set as null if it is Newtonian.

Throws:

NullArgumentException - if gravityModelIn is null

ThirdBodyAttraction

public ThirdBodyAttraction(GravityModel gravityModelIn,
                           boolean computePD)

Constructor.

Parameters:

gravityModelIn - the gravitational attraction model to consider

computePD - true if partial derivatives have to be computed, false otherwise

Throws:

NullArgumentException - if gravityModelIn is null

ThirdBodyAttraction

public ThirdBodyAttraction(GravityModel gravityModelIn,
                           AbstractHarmonicGravityModel centralBodyGravityModel,
                           boolean computePD)

Constructor.

Parameters:

gravityModelIn - the gravitational attraction model to consider

centralBodyGravityModel - The central body gravity model to take into account the harmonic contribution in the gamma(body->centralBody) term.
Can be null.
Note: NewtonianGravityModel isn't supported, the model will be set as null if it is Newtonian.

computePD - true if partial derivatives have to be computed, false otherwise

Throws:

NullArgumentException - if gravityModelIn is null

ThirdBodyAttraction

public ThirdBodyAttraction(GravityModel gravityModelIn,
                           boolean computePD,
                           Parameter k)

Constructor.
Only central term of third body is considered.

Parameters:

gravityModelIn - the gravitational attraction model to consider

computePD - true if partial derivatives have to be computed

k - multiplicative coefficient

Throws:

NullArgumentException - if gravityModelIn is null

ThirdBodyAttraction

public ThirdBodyAttraction(GravityModel gravityModelIn,
                           AbstractHarmonicGravityModel centralBodyGravityModel,
                           boolean computePD,
                           Parameter k)

Constructor.

Parameters:

gravityModelIn - the gravitational attraction model to consider

centralBodyGravityModel - The central body gravity model to take into account the harmonic contribution in the gamma(body->centralBody) term.
Can be null.
Note: NewtonianGravityModel isn't supported, the model will be set as null if it is Newtonian.

computePD - true if partial derivatives have to be computed

k - multiplicative coefficient

Throws:

NullArgumentException - if gravityModelIn is null

Method Detail

computeAcceleration

protected Vector3D computeAcceleration(Vector3D positionInBodyFrame,
                                       AbsoluteDate date,
                                       Transform scFrameToBodyFrame)
                                throws PatriusException

Abstract method to compute the acceleration of the implementation.

Specified by:

computeAcceleration in class AbstractBodyAttraction

Parameters:

positionInBodyFrame - position in body frame

date - date

scFrameToBodyFrame - transform from spacecraft frame to body frame

Returns:

acceleration in body frame

Throws:

PatriusException - thrown if computation failed

checkData

public void checkData(AbsoluteDate start,
                      AbsoluteDate end)

This methods throws an exception if the user did not provide all the required data to perform model call on provided range [start; end]. It is the responsibility of the model implementation to properly throw exceptions (for example DragForce will throw an exception if solar activity data is missing in the range [start, end]).

Parameters:

start - range start date

end - range end date