org.orekit.propagation.semianalytical.dsst.forces

Class DSSTNewtonianAttraction

java.lang.Object

org.orekit.propagation.semianalytical.dsst.forces.DSSTNewtonianAttraction

All Implemented Interfaces:

DSSTForceModel, ParametersDriversProvider

public class DSSTNewtonianAttraction
extends Object
implements DSSTForceModel

Force model for Newtonian central body attraction for the DSST propagator.

Since:

10.0

Author:

Bryan Cazabonne, Luc Maisonobe

Field Summary

Fields

Modifier and Type	Field and Description
static String	CENTRAL_ATTRACTION_COEFFICIENT Name of the single parameter of this model: the central attraction coefficient.

Constructor Summary

Constructors

Constructor and Description
DSSTNewtonianAttraction(double mu) Simple constructor.

Method Summary

Modifier and Type	Method and Description
EventDetector[]	getEventsDetectors() Get the discrete events related to the model.
<T extends CalculusFieldElement<T>> FieldEventDetector<T>[]	getFieldEventsDetectors(Field<T> field) Get the discrete events related to the model.
<T extends CalculusFieldElement<T>> T[]	getMeanElementRate(FieldSpacecraftState<T> state, FieldAuxiliaryElements<T> auxiliaryElements, T[] parameters) Computes the mean equinoctial elements rates dai / dt.
double[]	getMeanElementRate(SpacecraftState state, AuxiliaryElements auxiliaryElements, double[] parameters) Computes the mean equinoctial elements rates dai / dt.
double	getMu() Get the central attraction coefficient μ.
List<ParameterDriver>	getParametersDrivers() Get the drivers for parameters.
List<ShortPeriodTerms>	initializeShortPeriodTerms(AuxiliaryElements auxiliaryElements, PropagationType type, double[] parameters) Performs initialization prior to propagation for the current force model.
<T extends CalculusFieldElement<T>> List<FieldShortPeriodTerms<T>>	initializeShortPeriodTerms(FieldAuxiliaryElements<T> auxiliaryElements, PropagationType type, T[] parameters) Performs initialization prior to propagation for the current force model.
void	registerAttitudeProvider(AttitudeProvider provider) Register an attitude provider.
void	updateShortPeriodTerms(double[] parameters, SpacecraftState... meanStates) Update the short period terms.
<T extends CalculusFieldElement<T>> void	updateShortPeriodTerms(T[] parameters, FieldSpacecraftState<T>... meanStates) Update the short period terms.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.propagation.semianalytical.dsst.forces.DSSTForceModel

getParameters, getParameters, init, init

Field Detail

CENTRAL_ATTRACTION_COEFFICIENT

public static final String CENTRAL_ATTRACTION_COEFFICIENT

Name of the single parameter of this model: the central attraction coefficient.

See Also:

Constant Field Values

Constructor Detail

DSSTNewtonianAttraction

public DSSTNewtonianAttraction(double mu)

Simple constructor.

Parameters:

mu - central attraction coefficient (m^3/s^2)

Method Detail

getMu

public double getMu()

Get the central attraction coefficient μ.

Returns:

mu central attraction coefficient (m³/s²)

initializeShortPeriodTerms

public List<ShortPeriodTerms> initializeShortPeriodTerms(AuxiliaryElements auxiliaryElements,
                                                         PropagationType type,
                                                         double[] parameters)

Performs initialization prior to propagation for the current force model.

This method aims at being called at the very beginning of a propagation.

Specified by:

initializeShortPeriodTerms in interface DSSTForceModel

Parameters:

auxiliaryElements - auxiliary elements related to the current orbit

type - type of the elements used during the propagation

parameters - values of the force model parameters

Returns:

a list of objects that will hold short period terms (the objects are also retained by the force model, which will update them during propagation)

initializeShortPeriodTerms

public <T extends CalculusFieldElement<T>> List<FieldShortPeriodTerms<T>> initializeShortPeriodTerms(FieldAuxiliaryElements<T> auxiliaryElements,
                                                                                                     PropagationType type,
                                                                                                     T[] parameters)

Performs initialization prior to propagation for the current force model.

This method aims at being called at the very beginning of a propagation.

Specified by:

initializeShortPeriodTerms in interface DSSTForceModel

Type Parameters:

T - type of the elements

Parameters:

auxiliaryElements - auxiliary elements related to the current orbit

type - type of the elements used during the propagation

parameters - values of the force model parameters

Returns:

a list of objects that will hold short period terms (the objects are also retained by the force model, which will update them during propagation)

getMeanElementRate

public double[] getMeanElementRate(SpacecraftState state,
                                   AuxiliaryElements auxiliaryElements,
                                   double[] parameters)

Computes the mean equinoctial elements rates da_i / dt.

Specified by:

getMeanElementRate in interface DSSTForceModel

Parameters:

state - current state information: date, kinematics, attitude

auxiliaryElements - auxiliary elements related to the current orbit

parameters - values of the force model parameters

Returns:

the mean element rates dai/dt

getMeanElementRate

public <T extends CalculusFieldElement<T>> T[] getMeanElementRate(FieldSpacecraftState<T> state,
                                                                  FieldAuxiliaryElements<T> auxiliaryElements,
                                                                  T[] parameters)

Computes the mean equinoctial elements rates da_i / dt.

Specified by:

getMeanElementRate in interface DSSTForceModel

Type Parameters:

T - type of the elements

Parameters:

state - current state information: date, kinematics, attitude

auxiliaryElements - auxiliary elements related to the current orbit

parameters - values of the force model parameters

Returns:

the mean element rates dai/dt

getEventsDetectors

public EventDetector[] getEventsDetectors()

Get the discrete events related to the model.

Specified by:

getEventsDetectors in interface DSSTForceModel

Returns:

array of events detectors or null if the model is not related to any discrete events

getFieldEventsDetectors

public <T extends CalculusFieldElement<T>> FieldEventDetector<T>[] getFieldEventsDetectors(Field<T> field)

Get the discrete events related to the model.

Specified by:

getFieldEventsDetectors in interface DSSTForceModel

Type Parameters:

T - type of the elements

Parameters:

field - field used by default

Returns:

array of events detectors or null if the model is not related to any discrete events

registerAttitudeProvider

public void registerAttitudeProvider(AttitudeProvider provider)

Register an attitude provider.

Register an attitude provider that can be used by the force model.

Specified by:

registerAttitudeProvider in interface DSSTForceModel

Parameters:

provider - the AttitudeProvider

updateShortPeriodTerms

public void updateShortPeriodTerms(double[] parameters,
                                   SpacecraftState... meanStates)

Update the short period terms.

The short period terms that will be updated are the ones that were returned during the call to DSSTForceModel.initializeShortPeriodTerms(AuxiliaryElements, PropagationType, double[]).

Specified by:

updateShortPeriodTerms in interface DSSTForceModel

Parameters:

parameters - values of the force model parameters

meanStates - mean states information: date, kinematics, attitude

updateShortPeriodTerms

public <T extends CalculusFieldElement<T>> void updateShortPeriodTerms(T[] parameters,
                                                                       FieldSpacecraftState<T>... meanStates)

Update the short period terms.

The short period terms that will be updated are the ones that were returned during the call to DSSTForceModel.initializeShortPeriodTerms(AuxiliaryElements, PropagationType, double[]).

Specified by:

updateShortPeriodTerms in interface DSSTForceModel

Type Parameters:

T - type of the elements

Parameters:

parameters - values of the force model parameters

meanStates - mean states information: date, kinematics, attitude

getParametersDrivers

public List<ParameterDriver> getParametersDrivers()

Get the drivers for parameters.

Specified by:

getParametersDrivers in interface ParametersDriversProvider

Returns:

drivers for parameters