org.orekit.propagation.integration

Class AbstractJacobiansMapper

java.lang.Object

org.orekit.propagation.integration.AbstractJacobiansMapper

Direct Known Subclasses:

DSSTJacobiansMapper, JacobiansMapper, TLEJacobiansMapper

public abstract class AbstractJacobiansMapper
extends Object

Base class for jacobian mapper.

Since:

10.0

Author:

Bryan Cazabonne

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATE_DIMENSION State dimension, fixed to 6.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJacobiansMapper(String name, ParameterDriversList parameters) Simple constructor.

Method Summary

Modifier and Type	Method and Description
void	analyticalDerivatives(SpacecraftState s) Compute the derivatives needed by analytical orbit determination methods.
int	getAdditionalStateDimension() Compute the length of the one-dimensional additional state array needed.
String	getName() Get the name of the partial Jacobians.
int	getParameters() Get the number of parameters.
abstract void	getParametersJacobian(SpacecraftState state, double[][] dYdP) Get the Jacobian with respect to parameters from a one-dimensional additional state array.
abstract void	getStateJacobian(SpacecraftState state, double[][] dYdY0) Get the Jacobian with respect to state from a one-dimensional additional state array.
abstract void	setInitialJacobians(SpacecraftState state, double[][] dY1dY0, double[][] dY1dP, double[] p) Set the Jacobian with respect to state into a one-dimensional additional state array.

Methods inherited from class java.lang.Object

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

Field Detail

STATE_DIMENSION

public static final int STATE_DIMENSION

State dimension, fixed to 6.

Since:

9.0

See Also:

Constant Field Values

Constructor Detail

AbstractJacobiansMapper

protected AbstractJacobiansMapper(String name,
                                  ParameterDriversList parameters)

Simple constructor.

Parameters:

name - name of the Jacobians

parameters - selected parameters for Jacobian computation

Method Detail

getName

public String getName()

Get the name of the partial Jacobians.

Returns:

name of the Jacobians

getParameters

public int getParameters()

Get the number of parameters.

Returns:

number of parameters

getAdditionalStateDimension

public int getAdditionalStateDimension()

Compute the length of the one-dimensional additional state array needed.

Returns:

length of the one-dimensional additional state array

analyticalDerivatives

public void analyticalDerivatives(SpacecraftState s)

Compute the derivatives needed by analytical orbit determination methods.

Analytical derivatives are used to calculate state transition matrix of analytical orbit propagators and short period derivatives of DSST orbit propagator. In other word, this method does nothing for the numerical propagator.

Parameters:

s - spacecraft state with respect to which calculate derivatives

setInitialJacobians

public abstract void setInitialJacobians(SpacecraftState state,
                                         double[][] dY1dY0,
                                         double[][] dY1dP,
                                         double[] p)

Set the Jacobian with respect to state into a one-dimensional additional state array.

Parameters:

state - spacecraft state

dY1dY0 - Jacobian of current state at time t₁ with respect to state at some previous time t₀

dY1dP - Jacobian of current state at time t₁ with respect to parameters (may be null if there are no parameters)

p - placeholder where to put the one-dimensional additional state

See Also:

getStateJacobian(SpacecraftState, double[][])

getStateJacobian

public abstract void getStateJacobian(SpacecraftState state,
                                      double[][] dYdY0)

Get the Jacobian with respect to state from a one-dimensional additional state array.

This method extract the data from the state and put it in the dYdY0 array.

For JacobiansMapper and TLEJacobiansMapper, the method provides the Jacobian with respect to Cartesian elements. For DSSTJacobiansMapper the method provides the Jacobian with respect to Equinoctial elements.

Parameters:

state - spacecraft state

dYdY0 - placeholder where to put the Jacobian with respect to state

See Also:

getParametersJacobian(SpacecraftState, double[][])

getParametersJacobian

public abstract void getParametersJacobian(SpacecraftState state,
                                           double[][] dYdP)

Get the Jacobian with respect to parameters from a one-dimensional additional state array.

This method extract the data from the state and put it in the dYdP array.

If no parameters have been set in the constructor, the method returns immediately and does not reference dYdP which can safely be null in this case.

Parameters:

state - spacecraft state

dYdP - placeholder where to put the Jacobian with respect to parameters

See Also:

getStateJacobian(SpacecraftState, double[][])