fr.cnes.sirius.patrius.forces.gravity

Class AbstractBodyAttraction

java.lang.Object

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

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

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

All Implemented Interfaces:

ForceModel, GradientModel, IJacobiansParameterizable, IParameterizable, Serializable

Direct Known Subclasses:

DirectBodyAttraction, ThirdBodyAttraction

public abstract class AbstractBodyAttraction
extends JacobiansParameterizable
implements ForceModel, GradientModel

Abstract body attraction force model. HISTORY VERSION:4.11:DM:DM-40:22/05/2023:[PATRIUS] Gestion derivees par rapport au coefficient k dans les GravityModel VERSION:4.11:DM:DM-3282:22/05/2023:[PATRIUS] Amelioration de la gestion des attractions gravitationnelles dans le propagateur END-HISTORY

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	computePartialDerivativesWrtPosition True if acceleration partial derivatives with respect to position have to be computed.
protected GravityModel	gravityModel The gravitational attraction model to consider.
static String	K_FACTOR Parameter name for central attraction coefficient.

Constructor Summary

Constructors

Constructor and Description
AbstractBodyAttraction(GravityModel gravityModelIn, boolean computePD, double k) Simple constructor.
AbstractBodyAttraction(GravityModel gravityModelIn, boolean computePD, Parameter k) Simple constructor.

Method Summary

Modifier and Type	Method and Description
void	addContribution(SpacecraftState state, TimeDerivativesEquations adder) Compute the contribution of the force model to the perturbing acceleration.
void	addDAccDParam(SpacecraftState state, Parameter param, double[] dAccdParam) Compute acceleration derivatives with respect to additional parameters.
void	addDAccDParam(Vector3D pos, Frame frame, AbsoluteDate date, Parameter param, double[] dAccdParam) Compute acceleration derivatives with respect to additional parameters.
void	addDAccDState(SpacecraftState state, double[][] dAccdPos, double[][] dAccdVel) Compute acceleration derivatives with respect to state parameters.
void	addDAccDState(Vector3D pos, Frame frame, AbsoluteDate date, double[][] dAccdPos) Compute acceleration derivatives with respect to the position of the spacecraft.
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].
Vector3D	computeAcceleration(SpacecraftState state) Compute the acceleration due to the force.
abstract Vector3D	computeAcceleration(Vector3D pos, Frame frame, AbsoluteDate date) Compute the acceleration due to the force.
boolean	computeGradientPosition() This method returns true if the acceleration partial derivatives with respect to position have to be computed.
boolean	computeGradientVelocity() This method returns true if the acceleration partial derivatives with respect to velocity have to be computed.
EventDetector[]	getEventsDetectors() Get the discrete events related to the model.
GravityModel	getGravityModel() Get the gravitational attraction model.
double	getMultiplicativeFactor() Get the force multiplicative factor.
Parameter	getMultiplicativeFactorParameter() Get the force multiplicative factor parameter
void	setMultiplicativeFactor(double factor) Set the multiplicative factor.

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

Field Detail

K_FACTOR

public static final String K_FACTOR

Parameter name for central attraction coefficient.

See Also:

Constant Field Values

gravityModel

protected final GravityModel gravityModel

The gravitational attraction model to consider.

computePartialDerivativesWrtPosition

protected final boolean computePartialDerivativesWrtPosition

True if acceleration partial derivatives with respect to position have to be computed.

Constructor Detail

AbstractBodyAttraction

public AbstractBodyAttraction(GravityModel gravityModelIn,
                              boolean computePD,
                              double k)

Simple constructor. Only central term of direct body is considered.

Parameters:

gravityModelIn - the gravitational attraction model to consider

computePD - true if partial derivatives have to be computed

k - multiplicative factor

AbstractBodyAttraction

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

Simple constructor. Only central term of direct body is considered.

Parameters:

gravityModelIn - the gravitational attraction model to consider

computePD - true if partial derivatives have to be computed

k - multiplicative factor

Method Detail

computeGradientPosition

public boolean computeGradientPosition()

This method returns true if the acceleration partial derivatives with respect to position have to be computed.

Specified by:

computeGradientPosition in interface GradientModel

Returns:

true if the derivatives have to be computed, false otherwise

computeGradientVelocity

public boolean computeGradientVelocity()

This method returns true if the acceleration partial derivatives with respect to velocity have to be computed.

Specified by:

computeGradientVelocity in interface GradientModel

Returns:

true if the derivatives have to be computed, false otherwise

addContribution

public void addContribution(SpacecraftState state,
                            TimeDerivativesEquations adder)
                     throws PatriusException

Compute the contribution of the force model to the perturbing acceleration.

Specified by:

addContribution in interface ForceModel

Parameters:

state - current state information: date, kinematics, attitude

adder - object where the contribution should be added

Throws:

PatriusException - if some specific error occurs

computeAcceleration

public Vector3D computeAcceleration(SpacecraftState state)
                             throws PatriusException

Compute the acceleration due to the force.

Specified by:

computeAcceleration in interface ForceModel

Parameters:

state - current state information: date, kinematics, attitude

Returns:

acceleration in the SpacecraftState frame

Throws:

PatriusException - if some specific error occurs

computeAcceleration

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

Compute the acceleration due to the force.

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

addDAccDState

public void addDAccDState(SpacecraftState state,
                          double[][] dAccdPos,
                          double[][] dAccdVel)
                   throws PatriusException

Compute acceleration derivatives with respect to state parameters.

Specified by:

addDAccDState in interface IJacobiansParameterizable

Parameters:

state - spacecraft state

dAccdPos - acceleration derivatives with respect to position

dAccdVel - acceleration derivatives with respect to velocity

Throws:

PatriusException - if derivatives cannot be computed

addDAccDState

public void addDAccDState(Vector3D pos,
                          Frame frame,
                          AbsoluteDate date,
                          double[][] dAccdPos)
                   throws PatriusException

Compute acceleration derivatives with respect to the position of the spacecraft.

Parameters:

pos - position of the spacecraft

frame - frame in which the acceleration derivatives are computed

date - date

dAccdPos - acceleration derivatives with respect to position

Throws:

PatriusException - if derivatives cannot be computed

addDAccDParam

public void addDAccDParam(SpacecraftState state,
                          Parameter param,
                          double[] dAccdParam)
                   throws PatriusException

Compute acceleration derivatives with respect to additional parameters.

Specified by:

addDAccDParam in interface IJacobiansParameterizable

Parameters:

state - spacecraft state

param - the parameter with respect to which derivatives are required

dAccdParam - acceleration derivatives with respect to specified parameters

Throws:

PatriusException - if derivatives cannot be computed

addDAccDParam

public void addDAccDParam(Vector3D pos,
                          Frame frame,
                          AbsoluteDate date,
                          Parameter param,
                          double[] dAccdParam)
                   throws PatriusException

Compute acceleration derivatives with respect to additional parameters.

Parameters:

pos - position of the spacecraft

frame - frame in which the acceleration derivatives are computed

date - date

param - the parameter with respect to which derivatives are required

dAccdParam - acceleration derivatives with respect to specified parameters

Throws:

PatriusException - if derivatives cannot be computed

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]).

Specified by:

checkData in interface ForceModel

Parameters:

start - range start date

end - range end date

Throws:

PatriusException - thrown if some data is missing

getEventsDetectors

public EventDetector[] getEventsDetectors()

Get the discrete events related to the model.

Specified by:

getEventsDetectors in interface ForceModel

Returns:

array of events detectors or null if the model is not related to any discrete events

getMultiplicativeFactor

public double getMultiplicativeFactor()

Get the force multiplicative factor.

Returns:

the force multiplicative factor

getMultiplicativeFactorParameter

public Parameter getMultiplicativeFactorParameter()

Get the force multiplicative factor parameter

Returns:

the force multiplicative factor parameter

setMultiplicativeFactor

public void setMultiplicativeFactor(double factor)

Set the multiplicative factor.

Parameters:

factor - the force multiplicative factor to set.

getGravityModel

public GravityModel getGravityModel()

Get the gravitational attraction model.

Returns:

the gravitational attraction model