Package 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 Details

    • AbstractGradientConverter

      protected AbstractGradientConverter(int freeStateParameters)
      Simple constructor.
      Parameters:
      freeStateParameters - number of free parameters

  • Method Details

    • getFreeStateParameters

      public int getFreeStateParameters()
      Get the number of free state parameters.
      Returns:
      number of free state parameters

    • initStates

      protected void initStates(FieldSpacecraftState<Gradient> zeroParametersState)
      Initialize first state with 0 parameters.
      Parameters:
      zeroParametersState - state with zero parameters
      Since:
      11.2

    • extend

      protected Gradient extend(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 FieldAbsoluteDate<Gradient> extend(FieldAbsoluteDate<Gradient> original, int freeParameters)
      Add zero derivatives.
      Parameters:
      original - original date
      freeParameters - total number of free parameters in the gradient
      Returns:
      extended date

    • extend

      protected FieldVector3D<Gradient> extend(FieldVector3D<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 FieldRotation<Gradient> extend(FieldRotation<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<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<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 Gradient[] getParameters(FieldSpacecraftState<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 Gradient[] getParametersAtStateDate(FieldSpacecraftState<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)