fr.cnes.sirius.patrius.forces.gravity.variations

Class VariablePotentialGravityModel

java.lang.Object

fr.cnes.sirius.patrius.forces.gravity.AbstractGravityModel

fr.cnes.sirius.patrius.forces.gravity.AbstractHarmonicGravityModel

fr.cnes.sirius.patrius.forces.gravity.variations.VariablePotentialGravityModel

All Implemented Interfaces:

GravityModel, PotentialTimeVariations, Serializable

public class VariablePotentialGravityModel
extends AbstractHarmonicGravityModel
implements PotentialTimeVariations

This class represents a variable gravity field. It computes a static potential and a time variable potential. The C and S coefficients array are computed according to the algorithm given by

Since:

1.3

Version:

$Id: VariablePotentialAttractionModel.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Rami Houdroge

See Also:

GRACE / LAGEOS variable model, Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

not thread-safe because of global arrays

Field Summary

Fields

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

Fields inherited from class fr.cnes.sirius.patrius.forces.gravity.AbstractGravityModel

MU

Constructor Summary

Constructors

Constructor and Description
VariablePotentialGravityModel(Frame centralBodyFrame, VariablePotentialCoefficientsProvider provider, int degree, int order) Variable gravity field force model constructor (static part only).
VariablePotentialGravityModel(Frame centralBodyFrame, VariablePotentialCoefficientsProvider provider, int degree, int order, int degreePD, int orderPD) Variable gravity field force model constructor (static part only).
VariablePotentialGravityModel(Frame centralBodyFrame, VariablePotentialCoefficientsProvider provider, int degree, int order, int variableDegree, int variableOrder, boolean computeOptionalOnce) Variable gravity field force model constructor.
VariablePotentialGravityModel(Frame centralBodyFrame, VariablePotentialCoefficientsProvider provider, int degree, int order, int variableDegree, int variableOrder, int degreePD, int orderPD, boolean computeOptionalOnce) Variable gravity field force model constructor.
VariablePotentialGravityModel(Frame centralBodyFrame, VariablePotentialCoefficientsProvider provider, int degree, int order, int variableDegree, int variableOrder, int degreePD, int orderPD, boolean computeVariableCoefficientsOnce, boolean centralTermContributionIn) Variable gravity field force model constructor.

Method Summary

Modifier and Type	Method and Description
Vector3D	computeNonCentralTermsAcceleration(Vector3D positionInBodyFrame, AbsoluteDate date) Compute the acceleration due to the non-central terms of the gravitational attraction.
double[][]	computeNonCentralTermsDAccDPos(Vector3D positionInBodyFrame, AbsoluteDate date) Compute acceleration derivatives with respect to the state parameters for the non-central terms.
double	getAe() Get the equatorial radius.
void	setAe(double aeIn) Set the equatorial radius.
void	updateCoefficientsCandS(AbsoluteDate date) Update the C and the S coefficients for acceleration computation.
void	updateCoefficientsCandSPD(AbsoluteDate date) Update the C and the S coefficients for partial derivatives computation.

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

computeAcceleration, computeCentralTermAcceleration, computeCentralTermDAccDPos, computeDAccDPos, isCentralTermContributionApplied, setCentralTermContribution

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

getBodyFrame, getMu, getMuParameter, setMu

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RADIUS

public static final String RADIUS

Parameter name for equatorial radius.

See Also:

Constant Field Values

Constructor Detail

VariablePotentialGravityModel

public VariablePotentialGravityModel(Frame centralBodyFrame,
                                     VariablePotentialCoefficientsProvider provider,
                                     int degree,
                                     int order,
                                     int degreePD,
                                     int orderPD)
                              throws PatriusException

Variable gravity field force model constructor (static part only).

Parameters:

centralBodyFrame - central rotating body frame

provider - normalized variable coefficients provider

degree - degree for acceleration computation

order - order for acceleration computation

degreePD - degree for partial derivatives computation

orderPD - order for partial derivatives computation

Throws:

PatriusException - if degree too large

VariablePotentialGravityModel

public VariablePotentialGravityModel(Frame centralBodyFrame,
                                     VariablePotentialCoefficientsProvider provider,
                                     int degree,
                                     int order)
                              throws PatriusException

Variable gravity field force model constructor (static part only).

Parameters:

centralBodyFrame - central rotating body frame

provider - normalized variable coefficients provider

degree - degree

order - order

Throws:

PatriusException - if degree too large

VariablePotentialGravityModel

public VariablePotentialGravityModel(Frame centralBodyFrame,
                                     VariablePotentialCoefficientsProvider provider,
                                     int degree,
                                     int order,
                                     int variableDegree,
                                     int variableOrder,
                                     boolean computeOptionalOnce)
                              throws PatriusException

Variable gravity field force model constructor. Takes into account optional terms.

Parameters:

centralBodyFrame - central rotating body frame

provider - normalized variable coefficients provider

degree - degree

order - order

variableDegree - max degree of variable terms to take into account

variableOrder - max order of variable terms to take into account

computeOptionalOnce - true to indicate that coefficients should be computed just once at instanciation. false if coefficients are to be computed every time.

Throws:

PatriusException - if degree too large

VariablePotentialGravityModel

public VariablePotentialGravityModel(Frame centralBodyFrame,
                                     VariablePotentialCoefficientsProvider provider,
                                     int degree,
                                     int order,
                                     int variableDegree,
                                     int variableOrder,
                                     int degreePD,
                                     int orderPD,
                                     boolean computeOptionalOnce)
                              throws PatriusException

Variable gravity field force model constructor. Takes into account optional terms.

Parameters:

centralBodyFrame - central rotating body frame

provider - normalized variable coefficients provider

degree - degree for acceleration computation

order - order for acceleration computation

variableDegree - max degree of optional terms to take into account for acceleration computation

variableOrder - max order of optional terms to take into account for acceleration computation

degreePD - degree for partial derivatives computation

orderPD - order for partial derivatives computation

computeOptionalOnce - true to indicate that coefficients should be computed just once at instantiation. false if coefficients are to be computed every time

Throws:

PatriusException - if degree too large

VariablePotentialGravityModel

public VariablePotentialGravityModel(Frame centralBodyFrame,
                                     VariablePotentialCoefficientsProvider provider,
                                     int degree,
                                     int order,
                                     int variableDegree,
                                     int variableOrder,
                                     int degreePD,
                                     int orderPD,
                                     boolean computeVariableCoefficientsOnce,
                                     boolean centralTermContributionIn)
                              throws PatriusException

Variable gravity field force model constructor. Takes into account optional terms.

Parameters:

centralBodyFrame - central rotating body frame

provider - normalized variable coefficients provider

degree - degree for acceleration computation

order - order for acceleration computation

variableDegree - max degree of variable terms to take into account for acceleration computation

variableOrder - max order of variable terms to take into account for acceleration computation

degreePD - degree for partial derivatives computation

orderPD - order for partial derivatives computation

computeVariableCoefficientsOnce - true to indicate that coefficients should be computed just once at instantiation. false if coefficients are to be computed every time

centralTermContributionIn - true if central term contribution should be considered (by default), false if not

Throws:

PatriusException - if degree too large

Method Detail

updateCoefficientsCandS

public void updateCoefficientsCandS(AbsoluteDate date)

Update the C and the S coefficients for acceleration computation.

Specified by:

updateCoefficientsCandS in interface PotentialTimeVariations

Parameters:

date - : date

updateCoefficientsCandSPD

public void updateCoefficientsCandSPD(AbsoluteDate date)

Update the C and the S coefficients for partial derivatives computation.

Specified by:

updateCoefficientsCandSPD in interface PotentialTimeVariations

Parameters:

date - : date

computeNonCentralTermsAcceleration

public Vector3D computeNonCentralTermsAcceleration(Vector3D positionInBodyFrame,
                                                   AbsoluteDate date)
                                            throws PatriusException

Compute the acceleration due to the non-central terms of the gravitational attraction..

Specified by:

computeNonCentralTermsAcceleration in class AbstractHarmonicGravityModel

Parameters:

positionInBodyFrame - the position expressed in the body frame

date - the date

Returns:

the non-central terms acceleration in the given frame

Throws:

PatriusException - if some specific error occurs

computeNonCentralTermsDAccDPos

public final double[][] computeNonCentralTermsDAccDPos(Vector3D positionInBodyFrame,
                                                       AbsoluteDate date)
                                                throws PatriusException

Compute acceleration derivatives with respect to the state parameters for the non-central terms..

Specified by:

computeNonCentralTermsDAccDPos in class AbstractHarmonicGravityModel

Parameters:

positionInBodyFrame - position of the spacecraft in the body frame

date - date

Returns:

acceleration derivatives with respect to position in the body frame

Throws:

PatriusException - if derivatives cannot be computed

getAe

public double getAe()

Get the equatorial radius.

Returns:

equatorial radius (m)

setAe

public void setAe(double aeIn)

Set the equatorial radius.

Parameters:

aeIn - the equatorial radius.