org.orekit.propagation.numerical

Class JacobiansMapper

java.lang.Object

org.orekit.propagation.numerical.JacobiansMapper

public class JacobiansMapper
extends Object

Mapper between two-dimensional Jacobian matrices and one-dimensional additional state arrays.

This class does not hold the states by itself. Instances of this class are guaranteed to be immutable.

Author:

Luc Maisonobe

See Also:

PartialDerivativesEquations, NumericalPropagator, SpacecraftState.getAdditionalState(String), AbstractPropagator

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
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.
void	getParametersJacobian(SpacecraftState state, double[][] dYdP) Get theJacobian with respect to parameters from a one-dimensional additional state array.
int	getStateDimension() Deprecated. as of 9.0, replaced with STATE_DIMENSION
void	getStateJacobian(SpacecraftState state, double[][] dYdY0) Get the Jacobian with respect to state from 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

Method Detail

getName

public String getName()

Get the name of the partial Jacobians.

Returns:

name of the Jacobians

getAdditionalStateDimension

public int getAdditionalStateDimension()

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

Returns:

length of the one-dimensional additional state array

getStateDimension

@Deprecated
public int getStateDimension()

Deprecated. as of 9.0, replaced with STATE_DIMENSION

Get the state vector dimension.

Returns:

state vector dimension

getParameters

public int getParameters()

Get the number of parameters.

Returns:

number of parameters

getStateJacobian

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

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.

Parameters:

state - spacecraft state

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

Throws:

OrekitException - if state does not contain the Jacobian additional state

See Also:

getParametersJacobian(SpacecraftState, double[][])

getParametersJacobian

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

Get theJacobian 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

Throws:

OrekitException - if state does not contain the Jacobian additional state

See Also:

getStateJacobian(SpacecraftState, double[][])