fr.cnes.sirius.patrius.forces.gravity

Class DirectBodyAttraction

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

All Implemented Interfaces:

ForceModel, GradientModel, IJacobiansParameterizable, IParameterizable, Serializable

public class DirectBodyAttraction
extends AbstractBodyAttraction

Direct body attraction force model.

The implementation of this class enables the computation of partial derivatives by finite differences with respect to the central attraction coefficient.

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
DirectBodyAttraction(GravityModel gravityModelIn) Simple constructor.
DirectBodyAttraction(GravityModel gravityModelIn, boolean computePD) Simple constructor.
DirectBodyAttraction(GravityModel gravityModelIn, boolean computePD, Parameter k) Simple 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

DirectBodyAttraction

public DirectBodyAttraction(GravityModel gravityModelIn)

Simple constructor. Partial derivative computation is set to true by default.

Parameters:

gravityModelIn - the gravitational attraction model to consider

Throws:

NullArgumentException - if gravityModelIn is null

DirectBodyAttraction

public DirectBodyAttraction(GravityModel gravityModelIn,
                            boolean computePD)

Simple constructor.

Parameters:

gravityModelIn - the gravitational attraction model to consider

computePD - true if partial derivatives have to be computed

Throws:

NullArgumentException - if gravityModelIn is null

DirectBodyAttraction

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

Simple constructor.

Parameters:

gravityModelIn - the gravitational attraction model to consider

computePD - true if partial derivatives have to be computed

k - The multiplicative coefficient parameter

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)
               throws PatriusException

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

Throws:

PatriusException - thrown if some data is missing