fr.cnes.sirius.patrius.forces.gravity

Class BalminoAttractionModel

java.lang.Object

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

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

fr.cnes.sirius.patrius.forces.gravity.BalminoAttractionModel

All Implemented Interfaces:

ForceModel, GradientModel, AttractionModel, IJacobiansParameterizable, IParameterizable, Serializable

public class BalminoAttractionModel
extends JacobiansParameterizable
implements ForceModel, GradientModel, AttractionModel

Computation of central body attraction with normalized coefficients and Helmholtz Polynomials.

The algorithm implemented in this class has been designed by Balmino Georges (Observatoire Midi-Pyrénées/ Groupe de Recherche de Géodésie Spatiale (GRGS) / Centre National d’Etudes Spatiales (CNES), France) in his 1990 paper: Non-singular formulation of the gravity vector and gravity gradient tensor in spherical harmonics. (Manuscr. Geod., Vol. 15, No. 1, p. 11 - 16, 02/1990). It uses normalized C and S coefficients for greater accuracy.

Warning: using a 0x0 Earth potential model is equivalent to a simple Newtonian attraction. However computation times will be much slower since this case is not particularized and hence conversion from body frame (often ITRF) to integration frame is necessary.

Since:

2.1

Version:

$Id: BalminoAttractionModel.java 18094 2017-10-02 17:18:57Z bignon $

Author:

Rami Houdroge

See Also:

Serialized Form

Concurrency :

not thread-safe, uses internal mutable attributes

Field Summary

Fields

Modifier and Type	Field and Description
static String	RADIUS Parameter name for equatorial radius.

Fields inherited from interface fr.cnes.sirius.patrius.forces.gravity.AttractionModel

MU

Constructor Summary

Constructors

Constructor and Description
BalminoAttractionModel(Frame frame, double ae, double mu, double[][] cCoefs, double[][] sCoefs) Create an instance of a normalized gravity computation model using normalized coefficients.
BalminoAttractionModel(Frame frame, double ae, double mu, double[][] cCoefs, double[][] sCoefs, int degreePD, int orderPD) Create an instance of a normalized gravity computation model using normalized coefficients.
BalminoAttractionModel(Frame frame, Parameter ae, Parameter mu, double[][] cCoefs, double[][] sCoefs) Create an instance of a normalized gravity computation model using normalized coefficients.
BalminoAttractionModel(Frame frame, Parameter ae, Parameter mu, double[][] cCoefs, double[][] sCoefs, int degreePD, int orderPD) Create an instance of a normalized gravity computation model using normalized coefficients.

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	addDAccDState(SpacecraftState state, 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].
Vector3D	computeAcceleration(PVCoordinates pv) Acceleration in body frame.
Vector3D	computeAcceleration(SpacecraftState state) 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.
Frame	getBodyFrame() Get the central body frame
double[][]	getC()
EventDetector[]	getEventsDetectors() Get the discrete events related to the model.
double	getMu() Get the central attraction coefficient &mu.
double	getMultiplicativeFactor() Get the force multiplicative factor.
double[][]	getS()
void	setMultiplicativeFactor(double coefficient) 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

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

RADIUS

public static final String RADIUS

Parameter name for equatorial radius.

See Also:

Constant Field Values

Constructor Detail

BalminoAttractionModel

public BalminoAttractionModel(Frame frame,
                              double ae,
                              double mu,
                              double[][] cCoefs,
                              double[][] sCoefs)

Create an instance of a normalized gravity computation model using normalized coefficients.

Parameters:

frame - central body frame

ae - equatorial radius constant

mu - standard gravitational constant

cCoefs - Normalized c coefficients

sCoefs - Normalized s coefficients

BalminoAttractionModel

public BalminoAttractionModel(Frame frame,
                              double ae,
                              double mu,
                              double[][] cCoefs,
                              double[][] sCoefs,
                              int degreePD,
                              int orderPD)

Create an instance of a normalized gravity computation model using normalized coefficients.

Parameters:

frame - central body frame

ae - equatorial radius constant

mu - standard gravitational constant

cCoefs - Normalized c coefficients for acceleration computation

sCoefs - Normalized s coefficients for acceleration computation

degreePD - degree for partial derivatives

orderPD - order for partial derivatives

BalminoAttractionModel

public BalminoAttractionModel(Frame frame,
                              Parameter ae,
                              Parameter mu,
                              double[][] cCoefs,
                              double[][] sCoefs)

Create an instance of a normalized gravity computation model using normalized coefficients.

Parameters:

frame - central body frame

ae - parameter storing equatorial radius

mu - parameter storing standard gravitational

cCoefs - Normalized c coefficients

sCoefs - Normalized s coefficients

BalminoAttractionModel

public BalminoAttractionModel(Frame frame,
                              Parameter ae,
                              Parameter mu,
                              double[][] cCoefs,
                              double[][] sCoefs,
                              int degreePD,
                              int orderPD)

Create an instance of a normalized gravity computation model using normalized coefficients.

Parameters:

frame - central body frame

ae - parameter storing equatorial radius

mu - parameter storing standard gravitational

cCoefs - Normalized c coefficients for acceleration computation

sCoefs - Normalized s coefficients for acceleration computation

degreePD - degree for partial derivatives

orderPD - order for partial derivatives

Method Detail

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 final Vector3D computeAcceleration(PVCoordinates pv)

Acceleration in body frame.

Parameters:

pv - the PVCoordinates of the spacecraft in the body frame

Returns:

the computed acceleration

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

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

addDAccDState

public final 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

addDAccDParam

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

Compute acceleration derivatives with respect to additional parameters.. No parameter is supported by this force model.

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

getMu

public double getMu()

Get the central attraction coefficient &mu..

Specified by:

getMu in interface AttractionModel

Returns:

mu central attraction coefficient (m³/s²)

getC

public double[][] getC()

Returns:

the normalized C coefficients.

getS

public double[][] getS()

Returns:

the normalized S coefficients.

getBodyFrame

public Frame getBodyFrame()

Get the central body frame

Returns:

the bodyFrame

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

getMultiplicativeFactor

public double getMultiplicativeFactor()

Get the force multiplicative factor.

Specified by:

getMultiplicativeFactor in interface AttractionModel

Returns:

the force multiplicative factor

setMultiplicativeFactor

public void setMultiplicativeFactor(double coefficient)

Set the multiplicative factor.

Specified by:

setMultiplicativeFactor in interface AttractionModel

Parameters:

coefficient - the factor to set.