fr.cnes.sirius.patrius.forces.drag

Class DragForce

java.lang.Object

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

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

fr.cnes.sirius.patrius.forces.drag.DragForce

All Implemented Interfaces:

ForceModel, GradientModel, IJacobiansParameterizable, IParameterizable, Serializable

public class DragForce
extends JacobiansParameterizable
implements ForceModel, GradientModel

Atmospheric drag force model.

The drag acceleration is computed as follows : γ = (1/2 * k * ρ * V² * S / Mass) * DragCoefVector
With:

• DragCoefVector = {Cx, Cy, Cz} and S given by the user through the interface DragSensitive.
• k: user-added multiplicative coefficient to atmospheric drag. Partial derivatives wrt this coefficient can be computed.

The implementation of this class enables the computation of partial derivatives with respect to normal and tangential ballistic coefficients.

Author:

Édouard Delente, Fabien Maussion, Véronique Pommier-Maurussane, Pascal Parraud

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	K_COEFFICIENT Parameter name for k coefficient.

Constructor Summary

Constructors

Constructor and Description
DragForce(Atmosphere atmosphereIn, DragSensitive spacecraftIn) Constructor with multiplicative factor k = 1.0.
DragForce(Atmosphere atmosphereIn, DragSensitive spacecraftIn, boolean computePDPos, boolean computePDVel) Constructor with multiplicative factor k = 1.0.
DragForce(double kIn, Atmosphere atmosphereIn, Assembly assembly) Creates a new instance.
DragForce(double kIn, Atmosphere atmosphereIn, DragSensitive spacecraftIn) Constructor with multiplicative factor k.
DragForce(double kIn, Atmosphere atmosphereIn, DragSensitive spacecraftIn, boolean computePDPos, boolean computePDVel) Constructor with multiplicative factor k.
DragForce(DragForce otherDragForce, Assembly assembly) Creates a new instance from the data in another one but with a different assembly.
DragForce(IParamDiffFunction kIn, Atmosphere atmosphereIn, DragSensitive spacecraftIn) Constructor with multiplicative factor k.
DragForce(IParamDiffFunction kIn, Atmosphere atmosphereIn, DragSensitive spacecraftIn, boolean computePDPos, boolean computePDVel) Constructor with multiplicative factor k.
DragForce(Parameter kIn, Atmosphere atmosphereIn, DragSensitive spacecraftIn) Constructor with multiplicative factor k.
DragForce(Parameter kIn, Atmosphere atmosphereIn, DragSensitive spacecraftIn, boolean computePDPos, boolean computePDVel) Constructor with multiplicative factor k.

Method Summary

Modifier and Type	Method and Description
void	addContribution(SpacecraftState s, TimeDerivativesEquations adder) Compute the contribution of the drag to the perturbing acceleration.
void	addDAccDParam(SpacecraftState s, Parameter param, double[] dAccdParam) Compute acceleration derivatives with respect to additional parameters.
void	addDAccDState(SpacecraftState s, double[][] dAccdPos, double[][] dAccdVel) Compute acceleration derivatives with respect to state parameters.
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].
static Vector3D	computeAcceleration(PVCoordinates pv, Frame frame, Atmosphere atm, AbsoluteDate date, double kD, double mass) Method to compute the acceleration.
Vector3D	computeAcceleration(SpacecraftState s) 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.
Atmosphere	getAtmosphere() Get the atmosphere model.
EventDetector[]	getEventsDetectors() There are no discrete events for this model.
IParamDiffFunction	getMultiplicativeFactor() Getter for the multiplicative factor.
double	getMultiplicativeFactor(SpacecraftState state) Getter for the multiplicative factor used at construction.

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_COEFFICIENT

public static final String K_COEFFICIENT

Parameter name for k coefficient.

See Also:

Constant Field Values

Constructor Detail

DragForce

public DragForce(Atmosphere atmosphereIn,
                 DragSensitive spacecraftIn)

Constructor with multiplicative factor k = 1.0.

Parameters:

atmosphereIn - atmospheric model

spacecraftIn - the object physical and geometrical information

DragForce

public DragForce(Atmosphere atmosphereIn,
                 DragSensitive spacecraftIn,
                 boolean computePDPos,
                 boolean computePDVel)

Constructor with multiplicative factor k = 1.0.

Parameters:

atmosphereIn - atmospheric model

spacecraftIn - the object physical and geometrical information

computePDPos - if partial derivatives wrt position have to be computed

computePDVel - if partial derivatives wrt velocity have to be computed

DragForce

public DragForce(double kIn,
                 Atmosphere atmosphereIn,
                 DragSensitive spacecraftIn)

Constructor with multiplicative factor k.

Parameters:

kIn - drag multiplicative factor

atmosphereIn - atmospheric model

spacecraftIn - the object physical and geometrical information

DragForce

public DragForce(double kIn,
                 Atmosphere atmosphereIn,
                 DragSensitive spacecraftIn,
                 boolean computePDPos,
                 boolean computePDVel)

Constructor with multiplicative factor k.

Parameters:

kIn - multiplicative factor

atmosphereIn - atmospheric model

spacecraftIn - the object physical and geometrical information

computePDPos - if partial derivatives wrt position have to be computed

computePDVel - if partial derivatives wrt velocity have to be computed

DragForce

public DragForce(Parameter kIn,
                 Atmosphere atmosphereIn,
                 DragSensitive spacecraftIn)

Constructor with multiplicative factor k.

Parameters:

kIn - parameter representing the multiplicative factor

atmosphereIn - atmospheric model

spacecraftIn - the object physical and geometrical information

DragForce

public DragForce(Parameter kIn,
                 Atmosphere atmosphereIn,
                 DragSensitive spacecraftIn,
                 boolean computePDPos,
                 boolean computePDVel)

Constructor with multiplicative factor k.

Parameters:

kIn - parameter representing the multiplicative factor

atmosphereIn - atmospheric model

spacecraftIn - the object physical and geometrical information

computePDPos - if partial derivatives wrt position have to be computed

computePDVel - if partial derivatives wrt velocity have to be computed

DragForce

public DragForce(IParamDiffFunction kIn,
                 Atmosphere atmosphereIn,
                 DragSensitive spacecraftIn)

Constructor with multiplicative factor k.

Parameters:

kIn - parameterizable function representing the multiplicative factor

atmosphereIn - atmospheric model

spacecraftIn - the object physical and geometrical information

DragForce

public DragForce(IParamDiffFunction kIn,
                 Atmosphere atmosphereIn,
                 DragSensitive spacecraftIn,
                 boolean computePDPos,
                 boolean computePDVel)

Constructor with multiplicative factor k.

Parameters:

kIn - parameterizable function representing the multiplicative factor

atmosphereIn - atmospheric model

spacecraftIn - the object physical and geometrical information

computePDPos - if partial derivatives wrt position have to be computed

computePDVel - if partial derivatives wrt velocity have to be computed

DragForce

public DragForce(double kIn,
                 Atmosphere atmosphereIn,
                 Assembly assembly)
          throws PatriusException

Creates a new instance.

Parameters:

kIn - multiplicative factor

atmosphereIn - atmosphere model

assembly - assembly with aerodynamic properties

Throws:

PatriusException - if the assembly does not have only one valid aerodynamic property.

DragForce

public DragForce(DragForce otherDragForce,
                 Assembly assembly)
          throws PatriusException

Creates a new instance from the data in another one but with a different assembly.

Parameters:

otherDragForce - the other instance

assembly - the new assembly

Throws:

PatriusException - if the assembly does not have only one valid aerodynamic property.

Method Detail

addContribution

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

Compute the contribution of the drag to the perturbing acceleration.

Specified by:

addContribution in interface ForceModel

Parameters:

s - the current state information : date, kinematics, attitude

adder - object where the contribution should be added

Throws:

PatriusException - if some specific error occurs

getEventsDetectors

public EventDetector[] getEventsDetectors()

There are no discrete events for this model.

Specified by:

getEventsDetectors in interface ForceModel

Returns:

an empty array

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

computeAcceleration

public Vector3D computeAcceleration(SpacecraftState s)
                             throws PatriusException

Compute the acceleration due to the force.

Specified by:

computeAcceleration in interface ForceModel

Parameters:

s - current state information: date, kinematics, attitude

Returns:

acceleration in the SpacecraftState frame

Throws:

PatriusException - if some specific error occurs

computeAcceleration

public static Vector3D computeAcceleration(PVCoordinates pv,
                                           Frame frame,
                                           Atmosphere atm,
                                           AbsoluteDate date,
                                           double kD,
                                           double mass)
                                    throws PatriusException

Method to compute the acceleration. This method has been implemented in order to validate the force model only. The reason is that for the validation context, we do not want to set up an instance of the SpacecraftState object to avoid the inertial frame of the spacecraft orbit.

(see Story #V84 and Feature #34 on https://www.orekit.org/forge/issues/34)

Out of the validation context, one must use the method Vector3D computeAcceleration(final SpacecraftState s)

In the validation context, we assume that the multiplicative factor is equal to 1.

Parameters:

pv - PV coordinates of the spacecraft (spherical spacecraft only for the validation)

frame - frame in which the PV coordinates are given

atm - atmosphere

date - date

kD - Composite drag coefficient (S.Cd/2).

mass - mass of the spacecraft

Returns:

acceleration

Throws:

PatriusException - if an Orekit error occurs

addDAccDState

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

Compute acceleration derivatives with respect to state parameters.

Specified by:

addDAccDState in interface IJacobiansParameterizable

Parameters:

s - spacecraft state

dAccdPos - acceleration derivatives with respect to position

dAccdVel - acceleration derivatives with respect to velocity

Throws:

PatriusException - if derivatives cannot be computed

addDAccDParam

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

Compute acceleration derivatives with respect to additional parameters..

Specified by:

addDAccDParam in interface IJacobiansParameterizable

Parameters:

s - 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

getMultiplicativeFactor

public IParamDiffFunction getMultiplicativeFactor()

Getter for the multiplicative factor.

Returns:

the multiplicative factor

getMultiplicativeFactor

public double getMultiplicativeFactor(SpacecraftState state)

Getter for the multiplicative factor used at construction.

Parameters:

state - state

Returns:

the multiplicative factor.

getAtmosphere

public Atmosphere getAtmosphere()

Get the atmosphere model.

Returns:

the atmosphere

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