org.orekit.propagation.numerical

## Class PartialDerivativesEquations

• ### Constructor Summary

Constructors
Constructor and Description
PartialDerivativesEquations(String name, NumericalPropagator propagator)
Deprecated.
Simple constructor.
• ### Method Summary

All Methods
Modifier and Type Method and Description
CombinedDerivatives combinedDerivatives(SpacecraftState s)
Deprecated.
Compute the derivatives related to the additional state (and optionally main state increments).
double[] computeDerivatives(SpacecraftState s, double[] pDot)
Deprecated.
Compute the derivatives related to the additional state parameters.
double[] derivatives(SpacecraftState state)
Deprecated.
int getDimension()
Deprecated.
Get the dimension of the generated derivative.
JacobiansMapper getMapper()
Deprecated.
Get a mapper between two-dimensional Jacobians and one-dimensional additional state.
String getName()
Deprecated.
Get the name of the additional derivatives (which will become state once integrated).
ParameterDriversList getSelectedParameters()
Deprecated.
Get the selected parameters, in Jacobian matrix column order.
void init(SpacecraftState initialState, AbsoluteDate target)
Deprecated.
Initialize the generator at the start of propagation.
boolean isInitialize()
Deprecated.
Get the flag for the initialization of the state jacobian.
SpacecraftState setInitialJacobians(SpacecraftState s0)
Deprecated.
Set the initial value of the Jacobian with respect to state and parameter.
SpacecraftState setInitialJacobians(SpacecraftState s1, double[][] dY1dY0, double[][] dY1dP)
Deprecated.
Set the initial value of the Jacobian with respect to state and parameter.
• ### 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.integration.AdditionalDerivativesProvider

yield
• ### Constructor Detail

• #### PartialDerivativesEquations

public PartialDerivativesEquations(String name,
NumericalPropagator propagator)
Deprecated.
Simple constructor.

Upon construction, this set of equations is automatically added to the propagator by calling its AbstractIntegratedPropagator.addAdditionalDerivativesProvider(AdditionalDerivativesProvider) method. So there is no need to call this method explicitly for these equations.

Parameters:
name - name of the partial derivatives equations
propagator - the propagator that will handle the orbit propagation
• ### Method Detail

• #### getName

public String getName()
Deprecated.
Get the name of the additional derivatives (which will become state once integrated).
Specified by:
getName in interface AdditionalDerivativesProvider
Specified by:
getName in interface AdditionalEquations
Returns:
name of the additional state (names containing "orekit" with any case are reserved for the library internal use)
• #### getDimension

public int getDimension()
Deprecated.
Get the dimension of the generated derivative.
Specified by:
getDimension in interface AdditionalDerivativesProvider
Returns:
dimension of the generated
• #### getSelectedParameters

public ParameterDriversList getSelectedParameters()
Deprecated.
Get the selected parameters, in Jacobian matrix column order.

The force models parameters for which partial derivatives are desired, must have been selected before this method is called, so the proper list is returned.

Returns:
selected parameters, in Jacobian matrix column order which is lexicographic order
• #### setInitialJacobians

public SpacecraftState setInitialJacobians(SpacecraftState s0)
Deprecated.
Set the initial value of the Jacobian with respect to state and parameter.

This method is equivalent to call setInitialJacobians(SpacecraftState, double[][], double[][]) with dYdY0 set to the identity matrix and dYdP set to a zero matrix.

The force models parameters for which partial derivatives are desired, must have been selected before this method is called, so proper matrices dimensions are used.

Parameters:
s0 - initial state
Returns:
Since:
9.0
getSelectedParameters()
• #### setInitialJacobians

public SpacecraftState setInitialJacobians(SpacecraftState s1,
double[][] dY1dY0,
double[][] dY1dP)
Deprecated.
Set the initial value of the Jacobian with respect to state and parameter.

The returned state must be added to the propagator (it is not done automatically, as the user may need to add more states to it).

The force models parameters for which partial derivatives are desired, must have been selected before this method is called, and the dY1dP matrix dimension must be consistent with the selection.

Parameters:
s1 - current state
dY1dY0 - Jacobian of current state at time t₁ with respect to state at some previous time t₀ (must be 6x6)
dY1dP - Jacobian of current state at time t₁ with respect to parameters (may be null if no parameters are selected)
Returns:
getSelectedParameters()
• #### init

public void init(SpacecraftState initialState,
AbsoluteDate target)
Deprecated.
Initialize the generator at the start of propagation.
Specified by:
init in interface AdditionalDerivativesProvider
Specified by:
init in interface AdditionalEquations
Parameters:
initialState - initial state information at the start of propagation
target - date of propagation
• #### computeDerivatives

public double[] computeDerivatives(SpacecraftState s,
double[] pDot)
Deprecated.
Compute the derivatives related to the additional state parameters.

When this method is called, the spacecraft state contains the main state (orbit, attitude and mass), all the states provided through the additional state providers registered to the propagator, and the additional state integrated using this equation. It does not contains any other states to be integrated alongside during the same propagation.

Specified by:
computeDerivatives in interface AdditionalEquations
Parameters:
s - current state information: date, kinematics, attitude, and additional state
pDot - placeholder where the derivatives of the additional parameters should be put
Returns:
cumulative effect of the equations on the main state (may be null if equations do not change main state at all)
• #### derivatives

@Deprecated
public double[] derivatives(SpacecraftState state)
Deprecated.
Compute the derivatives related to the additional state parameters.
Specified by:
derivatives in interface AdditionalDerivativesProvider
Parameters:
state - current state information: date, kinematics, attitude, and additional states this equations depend on (according to the yield method)
Returns:
computed derivatives
• #### combinedDerivatives

public CombinedDerivatives combinedDerivatives(SpacecraftState s)
Deprecated.
Compute the derivatives related to the additional state (and optionally main state increments).

As of 11.2, there is a default implementation that calls the deprecated AdditionalDerivativesProvider.derivatives(SpacecraftState) method. This has been done for backward compatibility only and will be removed in 12.0.

Specified by:
combinedDerivatives in interface AdditionalDerivativesProvider
Parameters:
s - current state information: date, kinematics, attitude, and additional states this equations depend on (according to the yield method)
Returns:
computed combined derivatives, which may include some incremental coupling effect to add to main state derivatives
• #### isInitialize

public boolean isInitialize()
Deprecated.
Get the flag for the initialization of the state jacobian.
Returns:
true if the state jacobian is initialized
Since:
10.2