fr.cnes.sirius.patrius.forces.gravity

Interface GravityModel

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractGravityModel, AbstractHarmonicGravityModel, BalminoGravityModel, CunninghamGravityModel, DrozinerGravityModel, GridGravityModel, NewtonianGravityModel, VariablePotentialGravityModel

public interface GravityModel
extends Serializable

This interface represents a gravitational attraction model.

Since:

4.11

Author:

Alex Nardi 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

Method Summary

Modifier and Type	Method and Description
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(Vector3D pos, Frame frame, AbsoluteDate date) Compute the acceleration due to the gravitational attraction, accounting for both central and non-central terms.
double[][]	computeDAccDPos(Vector3D pos, Frame frame, AbsoluteDate date) Compute acceleration derivatives with respect to the position of the spacecraft.
Frame	getBodyFrame() Get the central body frame.
double	getMu() Get the central attraction coefficient.
void	setMu(double muIn) Set the central attraction coefficient.

Method Detail

getMu

double getMu()

Get the central attraction coefficient.

Returns:

central attraction coefficient (m³/s²)

setMu

void setMu(double muIn)

Set the central attraction coefficient.

Parameters:

muIn - the central attraction coefficient.

getBodyFrame

Frame getBodyFrame()

Get the central body frame.

Returns:

the bodyFrame

computeAcceleration

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

Compute the acceleration due to the gravitational attraction, accounting for both central and non-central terms.

Parameters:

pos - position of the spacecraft

frame - frame in which the acceleration is computed

date - date

Returns:

the acceleration in the given frame

Throws:

PatriusException - if some specific error occurs

computeDAccDPos

double[][] computeDAccDPos(Vector3D pos,
                           Frame frame,
                           AbsoluteDate date)
                    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

Returns:

acceleration derivatives with respect to the position of the spacecraft

Throws:

PatriusException - if derivatives cannot be computed

checkData

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.

Parameters:

start - range start date

end - range end date

Throws:

PatriusException - thrown if some data is missing