fr.cnes.sirius.patrius.propagation.numerical

Class JacobiansMapper

java.lang.Object

fr.cnes.sirius.patrius.propagation.numerical.JacobiansMapper

All Implemented Interfaces:

Serializable

public class JacobiansMapper
extends Object
implements Serializable

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, AbstractPropagator, Serialized Form

Constructor Summary

Constructors

Constructor and Description
JacobiansMapper(String nameIn, List<Parameter> list, OrbitType orbitTypeIn, PositionAngle angleTypeIn, Frame frame) Simple constructor.

Method Summary

Modifier and Type	Method and Description
int	getAdditionalStateDimension() Compute the length of the one-dimensional additional state array needed.
PositionAngle	getAngleType() Getter for the position angle type.
String	getName() Get the name of the partial Jacobians.
OrbitType	getOrbitType() Getter for the orbit type.
int	getParameters() Get the number of parameters.
double[]	getParametersJacobian(Parameter parameter, SpacecraftState state) Get the Jacobian with respect to provided parameter parameter.
void	getParametersJacobian(Parameter parameter, SpacecraftState state, double[] dYdP) Get the Jacobian with respect to provided parameter parameter.
void	getParametersJacobian(Parameter parameter, SpacecraftState state, double[] dYdP, OrbitType orbitTypeIn, PositionAngle angleTypeIn, Frame frameIn) Get the Jacobian with respect to provided parameter parameter.
double[]	getParametersJacobian(Parameter parameter, SpacecraftState state, OrbitType orbitTypeIn, PositionAngle angleTypeIn, Frame frameIn) Get the Jacobian with respect to provided parameter parameter.
double[][]	getParametersJacobian(SpacecraftState state) Get the Jacobian with respect to parameters.
void	getParametersJacobian(SpacecraftState state, double[][] dYdP) Get the Jacobian with respect to parameters.
void	getParametersJacobian(SpacecraftState state, double[][] dYdP, OrbitType orbitTypeIn, PositionAngle angleTypeIn, Frame frameIn) Get the Jacobian with respect to parameters.
double[][]	getParametersJacobian(SpacecraftState state, OrbitType orbitTypeOut, PositionAngle angleTypeOut, Frame frameOut) Get the Jacobian with respect to parameters.
List<Parameter>	getParametersList() Get parameters list.
Frame	getPropagationFrame() Getter for the propagation frame.
int	getStateDimension() Get the state vector dimension.
double[][]	getStateJacobian(SpacecraftState state) Get the Jacobian with respect to state.
void	getStateJacobian(SpacecraftState state, double[][] dYdY0) Get the Jacobian with respect to state.
void	getStateJacobian(SpacecraftState state, double[][] dYdY0, OrbitType orbitTypeIn, PositionAngle angleTypeIn, Frame frameIn) Get the Jacobian with respect to state.
double[][]	getStateJacobian(SpacecraftState state, OrbitType orbitTypeOut, PositionAngle angleTypeOut, Frame frameOut) Get the Jacobian with respect to state.
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

Constructor Detail

JacobiansMapper

public JacobiansMapper(String nameIn,
                       List<Parameter> list,
                       OrbitType orbitTypeIn,
                       PositionAngle angleTypeIn,
                       Frame frame)

Simple constructor.

Parameters:

nameIn - name of the Jacobians being included or not)

list - parameters list

orbitTypeIn - orbit type

angleTypeIn - position angle type

frame - propagation frame

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

public int getStateDimension()

Get the state vector dimension.

Returns:

state vector dimension

getParameters

public int getParameters()

Get the number of parameters.

Returns:

number of parameters

getParametersList

public List<Parameter> getParametersList()

Get parameters list.

Returns:

parameters list

getOrbitType

public OrbitType getOrbitType()

Getter for the orbit type.

Returns:

the orbit type

getAngleType

public PositionAngle getAngleType()

Getter for the position angle type.

Returns:

the position angle type

getPropagationFrame

public Frame getPropagationFrame()

Getter for the propagation frame.

Returns:

the propagation frame

setInitialJacobians

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

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

This method converts the Jacobians to cartesian parameters and put the converted data in the one-dimensional p 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

Throws:

PatriusException - thrown if jacobian computation failed

See Also:

getStateJacobian(SpacecraftState, double[][])

getStateJacobian

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

Get the Jacobian with respect to state.

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:

PatriusException - thrown if partial derivatives are not included in state

See Also:

getParametersJacobian(SpacecraftState, double[][]), getParametersJacobian(Parameter, SpacecraftState, double[])

getStateJacobian

public void getStateJacobian(SpacecraftState state,
                             double[][] dYdY0,
                             OrbitType orbitTypeIn,
                             PositionAngle angleTypeIn,
                             Frame frameIn)
                      throws PatriusException

Get the Jacobian with respect to state.

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

The jacobian is converted into the specified orbit type, angle type and frame. To be more specific, if M is the conversion, the new jacobian is Jn = M * J (i.e. only the output part is converted)

Parameters:

state - spacecraft state

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

orbitTypeIn - orbit type

angleTypeIn - position angle type

frameIn - propagation frame

Throws:

PatriusException - thrown if partial derivatives are not included in state

See Also:

getParametersJacobian(SpacecraftState, double[][]), getParametersJacobian(Parameter, SpacecraftState, double[])

getStateJacobian

public double[][] getStateJacobian(SpacecraftState state)
                            throws PatriusException

Get the Jacobian with respect to state.

This method extract the data from the state.

Parameters:

state - spacecraft state

Returns:

Jacobian with respect to state

Throws:

PatriusException - thrown if partial derivatives are not included in state

See Also:

getParametersJacobian(SpacecraftState), getParametersJacobian(Parameter, SpacecraftState)

getStateJacobian

public double[][] getStateJacobian(SpacecraftState state,
                                   OrbitType orbitTypeOut,
                                   PositionAngle angleTypeOut,
                                   Frame frameOut)
                            throws PatriusException

Get the Jacobian with respect to state.

This method extract the data from the state.

The jacobian is converted into the specified orbit type, angle type and frame. To be more specific, if M is the conversion, the new jacobian is Jn = M * J (i.e. only the output part is converted)

Parameters:

state - spacecraft state

orbitTypeOut - orbit type

angleTypeOut - position angle type

frameOut - frame

Returns:

Jacobian with respect to state

Throws:

PatriusException - thrown if partial derivatives are not included in state

See Also:

getParametersJacobian(SpacecraftState), getParametersJacobian(Parameter, SpacecraftState)

getParametersJacobian

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

Get the Jacobian with respect to parameters.

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:

PatriusException - thrown if partial derivatives are not included in state

See Also:

getStateJacobian(SpacecraftState, double[][]), getParametersJacobian(Parameter, SpacecraftState, double[])

getParametersJacobian

public void getParametersJacobian(SpacecraftState state,
                                  double[][] dYdP,
                                  OrbitType orbitTypeIn,
                                  PositionAngle angleTypeIn,
                                  Frame frameIn)
                           throws PatriusException

Get the Jacobian with respect to parameters.

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.

The jacobian is converted into the specified orbit type, angle type and frame. To be more specific, if M is the conversion, the new jacobian is Jn = M * J (i.e. only the output part is converted)

Parameters:

state - spacecraft state

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

orbitTypeIn - orbit type

angleTypeIn - position angle type

frameIn - propagation frame

Throws:

PatriusException - thrown if partial derivatives are not included in state

See Also:

getStateJacobian(SpacecraftState, double[][]), getParametersJacobian(Parameter, SpacecraftState, double[])

getParametersJacobian

public final double[][] getParametersJacobian(SpacecraftState state)
                                       throws PatriusException

Get the Jacobian with respect to parameters.

This method extract the data from the state.

Parameters:

state - spacecraft state

Returns:

Jacobian with respect to parameters

Throws:

PatriusException - thrown if partial derivatives are not included in state

See Also:

getStateJacobian(SpacecraftState), getParametersJacobian(Parameter, SpacecraftState)

getParametersJacobian

public final double[][] getParametersJacobian(SpacecraftState state,
                                              OrbitType orbitTypeOut,
                                              PositionAngle angleTypeOut,
                                              Frame frameOut)
                                       throws PatriusException

Get the Jacobian with respect to parameters.

This method extract the data from the state.

The jacobian is converted into the specified orbit type, angle type and frame. To be more specific, if M is the conversion, the new jacobian is Jn = M * J (i.e. only the output part is converted)

Parameters:

state - spacecraft state

orbitTypeOut - orbit type

angleTypeOut - position angle type

frameOut - frame

Returns:

Jacobian with respect to parameters

Throws:

PatriusException - thrown if partial derivatives are not included in state

See Also:

getStateJacobian(SpacecraftState), getParametersJacobian(Parameter, SpacecraftState)

getParametersJacobian

public void getParametersJacobian(Parameter parameter,
                                  SpacecraftState state,
                                  double[] dYdP)
                           throws PatriusException

Get the Jacobian with respect to provided parameter parameter.

This method extract the data from the state.

Parameters:

parameter - parameter

state - spacecraft state

dYdP - placeholder where to put the Jacobian with respect to provided parameter

Throws:

PatriusException - thrown if partial derivatives are not included in state

See Also:

getParametersJacobian(SpacecraftState, double[][])

getParametersJacobian

public void getParametersJacobian(Parameter parameter,
                                  SpacecraftState state,
                                  double[] dYdP,
                                  OrbitType orbitTypeIn,
                                  PositionAngle angleTypeIn,
                                  Frame frameIn)
                           throws PatriusException

Get the Jacobian with respect to provided parameter parameter.

This method extract the data from the state.

The jacobian is converted into the specified orbit type, angle type and frame. To be more specific, if M is the conversion, the new jacobian is Jn = M * J (i.e. only the output part is converted)

Parameters:

parameter - parameter

state - spacecraft state

dYdP - placeholder where to put the Jacobian with respect to provided parameter

orbitTypeIn - orbit type

angleTypeIn - position angle type

frameIn - propagation frame

Throws:

PatriusException - thrown if partial derivatives are not included in state

See Also:

getParametersJacobian(SpacecraftState, double[][])

getParametersJacobian

public double[] getParametersJacobian(Parameter parameter,
                                      SpacecraftState state)
                               throws PatriusException

Get the Jacobian with respect to provided parameter parameter.

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

If the parameter is not present in the partial derivatives, the method returns immediately and does not reference dYdP which can safely be null in this case.

Parameters:

parameter - parameter

state - spacecraft state

Returns:

Jacobian with respect to provided parameter, null if parameter is not included in Jacobian matrix

Throws:

PatriusException - thrown if partial derivatives are not included in state

See Also:

getParametersJacobian(SpacecraftState)

getParametersJacobian

public double[] getParametersJacobian(Parameter parameter,
                                      SpacecraftState state,
                                      OrbitType orbitTypeIn,
                                      PositionAngle angleTypeIn,
                                      Frame frameIn)
                               throws PatriusException

Get the Jacobian with respect to provided parameter parameter.

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

If the parameter is not present in the partial derivatives, the method returns immediately and does not reference dYdP which can safely be null in this case.

The jacobian is converted into the specified orbit type, angle type and frame. To be more specific, if M is the conversion, the new jacobian is Jn = M * J (i.e. only the output part is converted)

Parameters:

parameter - parameter

state - spacecraft state

orbitTypeIn - orbit type

angleTypeIn - position angle type

frameIn - propagation frame

Returns:

Jacobian with respect to provided parameter, null if parameter is not included in Jacobian matrix

Throws:

PatriusException - thrown if partial derivatives are not included in state

See Also:

getParametersJacobian(SpacecraftState)