fr.cnes.sirius.patrius.forces.gravity

Class AbstractHarmonicGravityModel

java.lang.Object

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

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

All Implemented Interfaces:

GravityModel, Serializable

Direct Known Subclasses:

BalminoGravityModel, CunninghamGravityModel, DrozinerGravityModel, NewtonianGravityModel, VariablePotentialGravityModel

public abstract class AbstractHarmonicGravityModel
extends AbstractGravityModel

This class represents a gravitational harmonic attraction model.

Since:

4.11

Author:

Alex Nardi

See Also:

Serialized Form

Field Summary

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

MU

Constructor Summary

Constructors

Constructor and Description
AbstractHarmonicGravityModel(Frame bodyFrameIn, Parameter mu) Constructor.

Method Summary

Modifier and Type	Method and Description
Vector3D	computeAcceleration(Vector3D positionInBodyFrame, AbsoluteDate date) Compute the acceleration due to the gravitational attraction.
protected Vector3D	computeCentralTermAcceleration(Vector3D positionInBodyFrame) Compute the acceleration due to the central term of the gravitational attraction.
double[][]	computeCentralTermDAccDPos(Vector3D positionInBodyFrame) Compute acceleration derivatives with respect to the state parameters for the central term.
double[][]	computeDAccDPos(Vector3D positionInBodyFrame, AbsoluteDate date) Compute acceleration derivatives with respect to the position of the spacecraft.
protected abstract Vector3D	computeNonCentralTermsAcceleration(Vector3D positionInBodyFrame, AbsoluteDate date) Compute the acceleration due to the non-central terms of the gravitational attraction.
abstract double[][]	computeNonCentralTermsDAccDPos(Vector3D positionInBodyFrame, AbsoluteDate date) Compute acceleration derivatives with respect to the state parameters for the non-central terms.
boolean	isCentralTermContributionApplied() Get the boolean for the central term contribution (true if the central term is considered, false if not).
void	setCentralTermContribution(boolean centralTermContributionIn) Set the boolean for the central term contribution (true if the central term is considered, false if not).

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

Constructor Detail

AbstractHarmonicGravityModel

public AbstractHarmonicGravityModel(Frame bodyFrameIn,
                                    Parameter mu)

Constructor.

Parameters:

bodyFrameIn - bodyFrame

mu - gravitational parameter

Method Detail

computeCentralTermAcceleration

protected Vector3D computeCentralTermAcceleration(Vector3D positionInBodyFrame)
                                           throws PatriusException

Compute the acceleration due to the central term of the gravitational attraction.

Parameters:

positionInBodyFrame - the position expressed in the body frame

Returns:

the central term acceleration in pos frame

Throws:

PatriusException - if some specific error occurs

computeNonCentralTermsAcceleration

protected abstract Vector3D computeNonCentralTermsAcceleration(Vector3D positionInBodyFrame,
                                                               AbsoluteDate date)
                                                        throws PatriusException

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

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

computeAcceleration

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

Compute the acceleration due to the gravitational attraction..

Parameters:

positionInBodyFrame - the position expressed in the body frame

date - The date for which the computation needs to be performed

Returns:

acceleration in the body frame

Throws:

PatriusException - if some specific error occurs

computeCentralTermDAccDPos

public double[][] computeCentralTermDAccDPos(Vector3D positionInBodyFrame)
                                      throws PatriusException

Compute acceleration derivatives with respect to the state parameters for the central term.

Parameters:

positionInBodyFrame - position of the spacecraft in the body frame

Returns:

acceleration derivatives with respect to position in the body frame

Throws:

PatriusException - if derivatives cannot be computed

computeNonCentralTermsDAccDPos

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

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

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

computeDAccDPos

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

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

Parameters:

positionInBodyFrame - the position expressed in the body frame

date - The date for which the computation needs to be performed

Returns:

acceleration derivatives with respect to the position of the spacecraft in the body frame

Throws:

PatriusException - if derivatives cannot be computed

isCentralTermContributionApplied

public boolean isCentralTermContributionApplied()

Get the boolean for the central term contribution (true if the central term is considered, false if not).

Returns:

the boolean for the central term contribution (true if the central term is considered, false if not)

setCentralTermContribution

public void setCentralTermContribution(boolean centralTermContributionIn)

Set the boolean for the central term contribution (true if the central term is considered, false if not).

Parameters:

centralTermContributionIn - the boolean for the central term contribution (true if the central term is considered, false if not).