org.orekit.propagation.integration

Class AbstractGradientConverter

java.lang.Object

org.orekit.propagation.integration.AbstractGradientConverter

Direct Known Subclasses:

AbstractAnalyticalGradientConverter, ModifierGradientConverter

public abstract class AbstractGradientConverter
extends Object

Converter for states and parameters arrays.

Since:

10.2

Author:

Luc Maisonobe, Bryan Cazabonne

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGradientConverter(int freeStateParameters) Simple constructor.

Method Summary

Modifier and Type	Method and Description
protected static FieldSpacecraftState<org.hipparchus.analysis.differentiation.Gradient>	buildBasicGradientSpacecraftState(SpacecraftState state, int freeStateParameters, AttitudeProvider provider) Process a state into a Gradient version without force model parameter.
protected org.hipparchus.geometry.euclidean.threed.FieldRotation<org.hipparchus.analysis.differentiation.Gradient>	extend(org.hipparchus.geometry.euclidean.threed.FieldRotation<org.hipparchus.analysis.differentiation.Gradient> original, int freeParameters) Add zero derivatives.
protected org.hipparchus.geometry.euclidean.threed.FieldVector3D<org.hipparchus.analysis.differentiation.Gradient>	extend(org.hipparchus.geometry.euclidean.threed.FieldVector3D<org.hipparchus.analysis.differentiation.Gradient> original, int freeParameters) Add zero derivatives.
protected org.hipparchus.analysis.differentiation.Gradient	extend(org.hipparchus.analysis.differentiation.Gradient original, int freeParameters) Add zero derivatives.
int	getFreeStateParameters() Get the number of free state parameters.
org.hipparchus.analysis.differentiation.Gradient[]	getParameters(FieldSpacecraftState<org.hipparchus.analysis.differentiation.Gradient> state, ParameterDriversProvider parametricModel) Get the parametric model parameters, return gradient values for each span of each driver (several gradient values for each parameter).
org.hipparchus.analysis.differentiation.Gradient[]	getParametersAtStateDate(FieldSpacecraftState<org.hipparchus.analysis.differentiation.Gradient> state, ParameterDriversProvider parametricModel) Get the parametric model parameters, return gradient values at state date for each driver (only 1 gradient value for each parameter).
FieldSpacecraftState<org.hipparchus.analysis.differentiation.Gradient>	getState(ParameterDriversProvider parametricModel) Get the state with the number of parameters consistent with parametric model.
protected void	initStates(FieldSpacecraftState<org.hipparchus.analysis.differentiation.Gradient> zeroParametersState) Initialize first state with 0 parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGradientConverter

protected AbstractGradientConverter(int freeStateParameters)

Simple constructor.

Parameters:

freeStateParameters - number of free parameters

Method Detail

getFreeStateParameters

public int getFreeStateParameters()

Get the number of free state parameters.

Returns:

number of free state parameters

initStates

protected void initStates(FieldSpacecraftState<org.hipparchus.analysis.differentiation.Gradient> zeroParametersState)

Initialize first state with 0 parameters.

Parameters:

zeroParametersState - state with zero parameters

Since:

11.2

extend

protected org.hipparchus.analysis.differentiation.Gradient extend(org.hipparchus.analysis.differentiation.Gradient original,
                                                                  int freeParameters)

Add zero derivatives.

Parameters:

original - original scalar

freeParameters - total number of free parameters in the gradient

Returns:

extended scalar

extend

protected org.hipparchus.geometry.euclidean.threed.FieldVector3D<org.hipparchus.analysis.differentiation.Gradient> extend(org.hipparchus.geometry.euclidean.threed.FieldVector3D<org.hipparchus.analysis.differentiation.Gradient> original,
                                                                                                                          int freeParameters)

Add zero derivatives.

Parameters:

original - original vector

freeParameters - total number of free parameters in the gradient

Returns:

extended vector

extend

protected org.hipparchus.geometry.euclidean.threed.FieldRotation<org.hipparchus.analysis.differentiation.Gradient> extend(org.hipparchus.geometry.euclidean.threed.FieldRotation<org.hipparchus.analysis.differentiation.Gradient> original,
                                                                                                                          int freeParameters)

Add zero derivatives.

Parameters:

original - original rotation

freeParameters - total number of free parameters in the gradient

Returns:

extended rotation

buildBasicGradientSpacecraftState

protected static FieldSpacecraftState<org.hipparchus.analysis.differentiation.Gradient> buildBasicGradientSpacecraftState(SpacecraftState state,
                                                                                                                          int freeStateParameters,
                                                                                                                          AttitudeProvider provider)

Process a state into a Gradient version without force model parameter.

Parameters:

state - state

freeStateParameters - number of free parameters

provider - attitude provider

Returns:

Gradient version of the state

Since:

12.0

getState

public FieldSpacecraftState<org.hipparchus.analysis.differentiation.Gradient> getState(ParameterDriversProvider parametricModel)

Get the state with the number of parameters consistent with parametric model.

Parameters:

parametricModel - parametric model

Returns:

state with the number of parameters consistent with parametric model

getParameters

public org.hipparchus.analysis.differentiation.Gradient[] getParameters(FieldSpacecraftState<org.hipparchus.analysis.differentiation.Gradient> state,
                                                                        ParameterDriversProvider parametricModel)

Get the parametric model parameters, return gradient values for each span of each driver (several gradient values for each parameter). Different from getParametersAtStateDate(FieldSpacecraftState, ParameterDriversProvider) which return a Gradient list containing for each driver the gradient value at state date (only 1 gradient value for each parameter).

Parameters:

state - state as returned by getState(parametricModel)

parametricModel - parametric model associated with the parameters

Returns:

parametric model parameters (for all span of each driver)

getParametersAtStateDate

public org.hipparchus.analysis.differentiation.Gradient[] getParametersAtStateDate(FieldSpacecraftState<org.hipparchus.analysis.differentiation.Gradient> state,
                                                                                   ParameterDriversProvider parametricModel)

Get the parametric model parameters, return gradient values at state date for each driver (only 1 gradient value for each parameter). Different from getParameters(FieldSpacecraftState, ParameterDriversProvider) which return a Gradient list containing for each driver the gradient values for each span value (several gradient values for each parameter).

Parameters:

state - state as returned by getState(parametricModel)

parametricModel - parametric model associated with the parameters

Returns:

parametric model parameters (for all span of each driver)