Class PythonAdditionalDerivativesProvider

    • Constructor Detail

      • PythonAdditionalDerivativesProvider

        public PythonAdditionalDerivativesProvider()
    • Method Detail

      • pythonExtension

        public void pythonExtension​(long pythonObject)
        Part of JCC Python interface to object
      • pythonExtension

        public long pythonExtension()
        Part of JCC Python interface to object
      • pythonDecRef

        public void pythonDecRef()
        Part of JCC Python interface to object
      • getName

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

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

        public boolean yields​(SpacecraftState state)
        Description copied from interface: AdditionalDerivativesProvider
        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 SpacecraftState state) {
             return !state.getAdditionalStates().containsKey("STM");
         }
         

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

        Specified by:
        yields in interface AdditionalDerivativesProvider
        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
      • combinedDerivatives

        public CombinedDerivatives combinedDerivatives​(SpacecraftState s)
        Description copied from interface: AdditionalDerivativesProvider
        Compute the derivatives related to the additional state (and optionally main state increments).
        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