Package org.orekit.propagation

Interface Propagator

    • Method Detail

      • getDefaultLaw

        static AttitudeProvider getDefaultLaw​(Frames frames)
        Get a default law using the given frames.
        Parameters:
        frames - the set of frames to use.
        Returns:
        attitude law.

      • getMultiplexer

        StepHandlerMultiplexer getMultiplexer()
        Get the multiplexer holding all step handlers.
        Returns:
        multiplexer holding all step handlers
        Since:
        11.0

      • setStepHandler

        default void setStepHandler​(OrekitStepHandler handler)
        Set a single handler for variable stepsizes.

        This convenience method is equivalent to call getMultiplexer().clear() followed by getMultiplexer().add(handler)

        Parameters:
        handler - handler called at the end of each finalized step
        Since:
        11.0
        See Also:
        getMultiplexer(), StepHandlerMultiplexer.add(OrekitStepHandler)

      • getEphemerisGenerator

        EphemerisGenerator getEphemerisGenerator()
        Set up an ephemeris generator that will monitor the propagation for building an ephemeris from it once completed.

        This generator can be used when the user needs fast random access to the orbit state at any time between the initial and target times. A typical example is the implementation of search and iterative algorithms that may navigate forward and backward inside the propagation range before finding their result even if the propagator used is integration-based and only goes from one initial time to one target time.

        Beware that when used with integration-based propagators, the generator will store all intermediate results. It is therefore memory intensive for long integration-based ranges and high precision/short time steps. When used with analytical propagators, the generator only stores start/stop time and a reference to the analytical propagator itself to call it back as needed, so it is less memory intensive.

        The returned ephemeris generator will be initially empty, it will be filled with propagation data when a subsequent call to either propagate(target) or propagate(start, target) is called. The proper way to use this method is therefore to do: 

           EphemerisGenerator generator = propagator.getEphemerisGenerator();
   propagator.propagate(target);
   BoundedPropagator ephemeris = generator.getGeneratedEphemeris();
        Returns:
        ephemeris generator

      • getInitialState

        SpacecraftState getInitialState()
        Get the propagator initial state.
        Returns:
        initial state

      • resetInitialState

        void resetInitialState​(SpacecraftState state)
        Reset the propagator initial state.
        Parameters:
        state - new initial state to consider

      • addAdditionalDataProvider

        void addAdditionalDataProvider​(AdditionalDataProvider<?> additionalDataProvider)
        Add a set of user-specified data to be computed along with the orbit propagation.
        Parameters:
        additionalDataProvider - provider for additional data

      • getAdditionalDataProviders

        List<AdditionalDataProvider<?>> getAdditionalDataProviders()
        Get an unmodifiable list of providers for additional data.
        Returns:
        providers for the additional data

      • isAdditionalDataManaged

        boolean isAdditionalDataManaged​(String name)
        Check if an additional data is managed.

        Managed data are the ones for which the propagators know how to compute its evolution. They correspond to additional data for which a provider has been registered by calling the addAdditionalDataProvider method.

        Additional data that are present in the initial state but have no evolution method registered are not considered as managed data. These unmanaged additional data are not lost during propagation, though. Their value are piecewise constant between state resets that may change them if some event handler resetState method is called at an event occurrence and happens to change the unmanaged additional data.

        Parameters:
        name - name of the additional data
        Returns:
        true if the additional data is managed

      • getManagedAdditionalData

        String[] getManagedAdditionalData()
        Get all the names of all managed additional data.
        Returns:
        names of all managed additional data

      • getAttitudeProvider

        AttitudeProvider getAttitudeProvider()
        Get attitude provider.
        Returns:
        attitude provider

      • setAttitudeProvider

        void setAttitudeProvider​(AttitudeProvider attitudeProvider)
        Set attitude provider.
        Parameters:
        attitudeProvider - attitude provider

      • getFrame

        Frame getFrame()
        Get the frame in which the orbit is propagated.

        The propagation frame is the definition frame of the initial state, so this method should be called after this state has been set, otherwise it may return null.

        Returns:
        frame in which the orbit is propagated
        See Also:
        resetInitialState(SpacecraftState)

      • setupMatricesComputation

        default MatricesHarvester setupMatricesComputation​(String stmName,
                                                   RealMatrix initialStm,
                                                   DoubleArrayDictionary initialJacobianColumns)
        Set up computation of State Transition Matrix and Jacobians matrix with respect to parameters.

        If this method is called, both State Transition Matrix and Jacobians with respect to the force models parameters that will be selected when propagation starts will be automatically computed, and the harvester will allow to retrieve them.

        The arguments for initial matrices must be compatible with the orbit type and position angle that will be used by the propagator.

        The default implementation throws an exception as the method is not supported by all propagators.

        Parameters:
        stmName - State Transition Matrix state name
        initialStm - initial State Transition Matrix ∂Y/∂Y₀, if null (which is the most frequent case), assumed to be 6x6 identity
        initialJacobianColumns - initial columns of the Jacobians matrix with respect to parameters, if null or if some selected parameters are missing from the dictionary, the corresponding initial column is assumed to be 0
        Returns:
        harvester to retrieve computed matrices during and after propagation
        Since:
        11.1

      • propagate

        SpacecraftState propagate​(AbsoluteDate 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.

        Parameters:
        target - target date towards which orbit state should be propagated
        Returns:
        propagated state

      • propagate

        SpacecraftState propagate​(AbsoluteDate start,
                          AbsoluteDate target)
        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:
        start - start date from which orbit state should be propagated
        target - target date to which orbit state should be propagated
        Returns:
        propagated state

      • getVelocity

        default Vector3D getVelocity​(AbsoluteDate date,
                             Frame frame)
        Get the velocity of the body in the selected frame.
        Specified by:
        getVelocity in interface PVCoordinatesProvider
        Parameters:
        date - current date
        frame - the frame where to define the velocity
        Returns:
        velocity of the body (m/s)

      • getPosition

        default Vector3D getPosition​(AbsoluteDate date,
                             Frame frame)
        Get the position of the body in the selected frame.
        Specified by:
        getPosition in interface PVCoordinatesProvider
        Parameters:
        date - current date
        frame - the frame where to define the position
        Returns:
        position of the body (m and)