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, gravityModel, 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
Vector3D	computeAcceleration(Vector3D pos, Frame frame, AbsoluteDate date) Compute the acceleration due to the force.

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

addContribution, addDAccDParam, addDAccDParam, addDAccDState, addDAccDState, checkData, 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

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

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

Method Detail

computeAcceleration

public Vector3D computeAcceleration(Vector3D pos,
                                    Frame frame,
                                    AbsoluteDate date)
                             throws PatriusException

Compute the acceleration due to the force..

Specified by:

computeAcceleration in class AbstractBodyAttraction

Parameters:

pos - position of the spacecraft

frame - frame in which the acceleration derivatives are computed

date - date

Returns:

acceleration in the given frame

Throws:

PatriusException - if some specific error occurs