Package org.orekit.propagation.integration

Class FieldAbstractIntegratedPropagator<T extends org.hipparchus.RealFieldElement<T>>

    • Constructor Detail

      • FieldAbstractIntegratedPropagator

        protected FieldAbstractIntegratedPropagator​(org.hipparchus.Field<T> field,
                                            org.hipparchus.ode.FieldODEIntegrator<T> integrator,
                                            boolean meanOrbit)
        Build a new instance.
        Parameters:
        integrator - numerical integrator to use for propagation.
        meanOrbit - output only the mean orbit.
        field - Field used by default

    • Method Detail

      • setResetAtEnd

        public void setResetAtEnd​(boolean resetAtEnd)
        Allow/disallow resetting the initial state at end of propagation.

        By default, at the end of the propagation, the propagator resets the initial state to the final state, thus allowing a new propagation to be started from there without recomputing the part already performed. Calling this method with resetAtEnd set to false changes prevents such reset.

        Parameters:
        resetAtEnd - if true, at end of each propagation, the initial state will be reset to the final state of the propagation, otherwise the initial state will be preserved
        Since:
        9.0

      • initMapper

        protected void initMapper()
        Initialize the mapper.

      • setOrbitType

        protected void setOrbitType​(OrbitType orbitType)
        Set propagation orbit type.
        Parameters:
        orbitType - orbit type to use for propagation

      • getOrbitType

        protected OrbitType getOrbitType()
        Get propagation parameter type.
        Returns:
        orbit type used for propagation

      • isMeanOrbit

        protected boolean isMeanOrbit()
        Check if only the mean elements should be used in a semianalitical propagation.
        Returns:
        true if only mean elements have to be used

      • setPositionAngleType

        protected void setPositionAngleType​(PositionAngle positionAngleType)
        Set position angle type.

        The position parameter type is meaningful only if propagation orbit type support it. As an example, it is not meaningful for propagation in Cartesian parameters.

        Parameters:
        positionAngleType - angle type to use for propagation

      • getPositionAngleType

        protected PositionAngle getPositionAngleType()
        Get propagation parameter type.
        Returns:
        angle type to use for propagation

      • setMu

        public void setMu​(double mu)
        Set the central attraction coefficient μ.
        Parameters:
        mu - central attraction coefficient (m³/s²)

      • getMu

        public double getMu()
        Get the central attraction coefficient μ.
        Returns:
        mu central attraction coefficient (m³/s²)
        See Also:
        setMu(double)

      • getCalls

        public int getCalls()
        Get the number of calls to the differential equations computation method.

        The number of calls is reset each time the propagate(FieldAbsoluteDate) method is called.

        Returns:
        number of calls to the differential equations computation method

      • isAdditionalStateManaged

        public boolean isAdditionalStateManaged​(String name)
        Check if an additional state is managed.

        Managed states are states for which the propagators know how to compute its evolution. They correspond to additional states for which an additional state provider has been registered by calling the addAdditionalStateProvider method. If the propagator is an integrator-based propagator, the states for which a set of additional equations has been registered by calling the addAdditionalEquations method are also counted as managed additional states.

        Additional states that are present in the initial state but have no evolution method registered are not considered as managed states. These unmanaged additional states are not lost during propagation, though. Their value will simply be copied unchanged throughout propagation.

        Specified by:
        isAdditionalStateManaged in interface FieldPropagator<T extends org.hipparchus.RealFieldElement<T>>
        Overrides:
        isAdditionalStateManaged in class FieldAbstractPropagator<T extends org.hipparchus.RealFieldElement<T>>
        Parameters:
        name - name of the additional state
        Returns:
        true if the additional state is managed

      • addAdditionalEquations

        public void addAdditionalEquations​(FieldAdditionalEquations<T> additional)
        Add a set of user-specified equations to be integrated along with the orbit propagation.
        Parameters:
        additional - additional equations

      • setUpUserEventDetectors

        protected void setUpUserEventDetectors()
        Set up all user defined event detectors.

      • setUpEventDetector

        protected void setUpEventDetector​(org.hipparchus.ode.FieldODEIntegrator<T> integ,
                                  FieldEventDetector<T> detector)
        Wrap an Orekit event detector and register it to the integrator.
        Parameters:
        integ - integrator into which event detector should be registered
        detector - event detector to wrap

      • createMapper

        protected abstract FieldStateMapper<T> createMapper​(FieldAbsoluteDate<T> referenceDate,
                                                    double mu,
                                                    OrbitType orbitType,
                                                    PositionAngle positionAngleType,
                                                    AttitudeProvider attitudeProvider,
                                                    Frame frame)
        Create a mapper between raw double components and spacecraft state. /** Simple constructor.

        The position parameter type is meaningful only if propagation orbit type support it. As an example, it is not meaningful for propagation in Cartesian parameters.

        Parameters:
        referenceDate - reference date
        mu - central attraction coefficient (m³/s²)
        orbitType - orbit type to use for mapping
        positionAngleType - angle type to use for propagation
        attitudeProvider - attitude provider
        frame - inertial frame
        Returns:
        new mapper

      • getMainStateEquations

        protected abstract FieldAbstractIntegratedPropagator.MainStateEquations<T> getMainStateEquations​(org.hipparchus.ode.FieldODEIntegrator<T> integ)
        Get the differential equations to integrate (for main state only).
        Parameters:
        integ - numerical integrator to use for propagation.
        Returns:
        differential equations for main state

      • propagate

        public FieldSpacecraftState<T> propagate​(FieldAbsoluteDate<T> target)
        Propagate towards a target date.

        Simple propagators use only the target date as the specification for computing the propagated state. More feature rich propagators can consider other information and provide different operating modes or G-stop facilities to stop at pinpointed events occurrences. In these cases, the target date is only a hint, not a mandatory objective.

        Specified by:
        propagate in interface FieldPropagator<T extends org.hipparchus.RealFieldElement<T>>
        Overrides:
        propagate in class FieldAbstractPropagator<T extends org.hipparchus.RealFieldElement<T>>
        Parameters:
        target - target date towards which orbit state should be propagated
        Returns:
        propagated state

      • propagate

        public FieldSpacecraftState<T> propagate​(FieldAbsoluteDate<T> tStart,
                                         FieldAbsoluteDate<T> tEnd)
        Propagate from a start date towards a target date.

        Those propagators use a start date and a target date to compute the propagated state. For propagators using event detection mechanism, if the provided start date is different from the initial state date, a first, simple propagation is performed, without processing any event computation. Then complete propagation is performed from start date to target date.

        Parameters:
        tStart - start date from which orbit state should be propagated
        tEnd - target date to which orbit state should be propagated
        Returns:
        propagated state

      • propagate

        protected FieldSpacecraftState<T> propagate​(FieldAbsoluteDate<T> tEnd,
                                            boolean activateHandlers)
        Propagation with or without event detection.
        Parameters:
        tEnd - target date to which orbit should be propagated
        activateHandlers - if true, step and event handlers should be activated
        Returns:
        state at end of propagation

      • getInitialIntegrationState

        protected FieldSpacecraftState<T> getInitialIntegrationState()
        Get the initial state for integration.
        Returns:
        initial state for integration

      • beforeIntegration

        protected void beforeIntegration​(FieldSpacecraftState<T> initialState,
                                 FieldAbsoluteDate<T> tEnd)
        Method called just before integration.

        The default implementation does nothing, it may be specialized in subclasses.

        Parameters:
        initialState - initial state
        tEnd - target date at which state should be propagated

      • afterIntegration

        protected void afterIntegration()
        Method called just after integration.

        The default implementation does nothing, it may be specialized in subclasses.

      • getBasicDimension

        public int getBasicDimension()
        Get state vector dimension without additional parameters.
        Returns:
        state vector dimension without additional parameters.

      • getIntegrator

        protected org.hipparchus.ode.FieldODEIntegrator<T> getIntegrator()
        Get the integrator used by the propagator.
        Returns:
        the integrator.