fr.cnes.sirius.patrius.stela.propagation.data

Class TimeDerivativeData

java.lang.Object

fr.cnes.sirius.patrius.stela.propagation.data.TimeDerivativeData

public class TimeDerivativeData
extends Object

Class for data resulting from STELA differential equation system.

Since:

3.0

Version:

$Id$

Author:

Emmanuel Bignon

Concurrency :

not thread-safe

Constructor Summary

Constructors

Constructor and Description
TimeDerivativeData(Orbit aOrbit, double[] aMeanMotion, double[][] aMeanMotionSTM, Map<StelaForceModel,double[]> aDerivatives, Map<StelaForceModel,double[][]> aDerivativesSTM) Constructor.

Method Summary

Modifier and Type	Method and Description
Set<StelaForceModel>	getAvailableForceModels() Returns available force models.
Set<StelaForceModel>	getAvailableForceModelsSTM() Returns available force models for state transition matrix.
double[]	getDerivatives(StelaForceModel force) Returns derivative dE'/dt (E' = mean orbital parameters) for provided force model.
double[][]	getDerivativesSTM(StelaForceModel force) Returns derivative dSTM/dt (STM = state transition matrix) for provided force model.
double[]	getMeanMotion() Returns mean motion.
double[][]	getMeanMotionSTM() Returns mean motion from STM (STM = state transition matrix).
Orbit	getOrbit() Returns the orbit.
double[]	getTotalContribution() Getter for the sum of all contributions to dE'/dt (E' = mean orbital parameters).
double[][]	getTotalContributionSTM() Getter for the sum of all contributions to dSTM/dt (STM = state transition matrix).

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeDerivativeData

public TimeDerivativeData(Orbit aOrbit,
                          double[] aMeanMotion,
                          double[][] aMeanMotionSTM,
                          Map<StelaForceModel,double[]> aDerivatives,
                          Map<StelaForceModel,double[][]> aDerivativesSTM)

Constructor.

Parameters:

aOrbit - state

aMeanMotion - mean motion

aMeanMotionSTM - mean motion from state transition matrix

aDerivatives - derivatives map

aDerivativesSTM - derivatives map

Method Detail

getOrbit

public Orbit getOrbit()

Returns the orbit.

Returns:

the orbit

getMeanMotion

public double[] getMeanMotion()

Returns mean motion.

Returns:

mean motion

getMeanMotionSTM

public double[][] getMeanMotionSTM()

Returns mean motion from STM (STM = state transition matrix).

Returns:

mean motion from STM (STM = state transition matrix)

getDerivatives

public double[] getDerivatives(StelaForceModel force)

Returns derivative dE'/dt (E' = mean orbital parameters) for provided force model.

Parameters:

force - a force model

Returns:

time derivative for provided force model

getDerivativesSTM

public double[][] getDerivativesSTM(StelaForceModel force)

Returns derivative dSTM/dt (STM = state transition matrix) for provided force model.

Parameters:

force - a force model

Returns:

transition matrix time derivative for provided force model

getTotalContribution

public double[] getTotalContribution()
                              throws PatriusException

Getter for the sum of all contributions to dE'/dt (E' = mean orbital parameters).

Returns:

the sum of all contribution to dE'/dt (E' = mean orbital parameters)

Throws:

PatriusException - thrown if derivatives dimension mismatch

getTotalContributionSTM

public double[][] getTotalContributionSTM()
                                   throws PatriusException

Getter for the sum of all contributions to dSTM/dt (STM = state transition matrix).

Returns:

the sum of all contribution to dSTM/dt (STM = state transition matrix)

Throws:

PatriusException - thrown if derivatives dimension mismatch

getAvailableForceModels

public Set<StelaForceModel> getAvailableForceModels()

Returns available force models.

Returns:

available force models

getAvailableForceModelsSTM

public Set<StelaForceModel> getAvailableForceModelsSTM()

Returns available force models for state transition matrix.

Returns:

available force models for state transition matrix