Class STMEquations

    • Constructor Detail

      • STMEquations

        public STMEquations​(CR3BPSystem syst)
        Simple constructor.
        Parameters:
        syst - CR3BP System considered
    • Method Detail

      • setInitialPhi

        public SpacecraftState setInitialPhi​(SpacecraftState s)
        Method adding the standard initial values of the additional state to the initial spacecraft state.
        Parameters:
        s - Initial state of the system
        Returns:
        s Initial augmented (with the additional equations) state
      • computeDerivatives

        public double[] computeDerivatives​(SpacecraftState s,
                                           double[] pDot)
        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)
        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
      • getName

        public String getName()
        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)
      • getStateTransitionMatrix

        public RealMatrix getStateTransitionMatrix​(SpacecraftState s)
        Method returning the State Transition Matrix.
        Parameters:
        s - SpacecraftState of the system
        Returns:
        phiM State Transition Matrix