Interface FieldAdditionalDerivativesProvider<T extends CalculusFieldElement<T>>

    • Method Detail

      • getName

        String getName()
        Get the name of the additional derivatives (which will become state once integrated).
        Returns:
        name of the additional state (names containing "orekit" with any case are reserved for the library internal use)
      • getDimension

        int getDimension()
        Get the dimension of the generated derivative.
        Returns:
        dimension of the generated
      • init

        default void init​(FieldSpacecraftState<T> initialState,
                          FieldAbsoluteDate<T> target)
        Initialize the generator at the start of propagation.
        Parameters:
        initialState - initial state information at the start of propagation
        target - date of propagation
      • yield

        default boolean yield​(FieldSpacecraftState<T> state)
        Check if this provider should yield so another provider has an opportunity to add missing parts.

        Decision to yield is often based on an additional state being already available in the provided state (but it could theoretically also depend on an additional state derivative being already available, or any other criterion). If for example a provider needs the state transition matrix, it could implement this method as:

        
         public boolean yield(final FieldSpacecraftState<T> state) {
             return !state.getAdditionalStates().containsKey("STM");
         }
         

        The default implementation returns false, meaning that derivative data can be computed immediately.

        Parameters:
        state - state to handle
        Returns:
        true if this provider should yield so another provider has an opportunity to add missing parts as the state is incrementally built up
      • derivatives

        @Deprecated
        T[] derivatives​(FieldSpacecraftState<T> s)
        Deprecated.
        Compute the derivatives related to the additional state parameters.
        Parameters:
        s - current state information: date, kinematics, attitude, and additional states this equations depend on (according to the yield method)
        Returns:
        computed derivatives
      • combinedDerivatives

        default FieldCombinedDerivatives<T> combinedDerivatives​(FieldSpacecraftState<T> s)
        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 derivatives(FieldSpacecraftState) method. This has been done for backward compatibility only and will be removed in 12.0.

        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
        Since:
        11.2