FieldPropagator (ORbit Extrapolation KIT 11.3.2 API)

Type Parameters:

T - the type of the field elements

All Superinterfaces:

FieldPVCoordinatesProvider<T>

All Known Subinterfaces:

FieldBoundedPropagator<T>

All Known Implementing Classes:

FieldAbstractAnalyticalPropagator, FieldAbstractIntegratedPropagator, FieldAbstractPropagator, FieldBrouwerLyddanePropagator, FieldDeepSDP4, FieldDSSTPropagator, FieldEcksteinHechlerPropagator, FieldIntegratedEphemeris, FieldKeplerianPropagator, FieldNumericalPropagator, FieldSGP4, FieldTLEPropagator
```
public interface FieldPropagator<T extends CalculusFieldElement<T>>
extends FieldPVCoordinatesProvider<T>
```
This interface provides a way to propagate an orbit at any time.
This interface is the top-level abstraction for orbit propagation. It only allows propagation to a predefined date. It is implemented by analytical models which have no time limit, by orbit readers based on external data files, by numerical integrators using rich force models and by continuous models built after numerical integration has been completed and dense output data as been gathered.

Author:

Luc Maisonobe, Véronique Pommier-Maurussane

Field Summary

Fields
Modifier and Type Field and Description

static double DEFAULT_MASS
Default mass.

Fields
Modifier and Type	Field and Description
`static double`	`DEFAULT_MASS` Default mass.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addAdditionalStateProvider(FieldAdditionalStateProvider<T> additionalStateProvider)` Add a set of user-specified state parameters to be computed along with the orbit propagation.
`<D extends FieldEventDetector<T>> void`	`addEventDetector(D detector)` Add an event detector.
`void`	`clearEventsDetectors()` Remove all events detectors.
`default void`	`clearStepHandlers()` Remove all step handlers.
`List<FieldAdditionalStateProvider<T>>`	`getAdditionalStateProviders()` Get an unmodifiable list of providers for additional state.
`AttitudeProvider`	`getAttitudeProvider()` Get attitude provider.
`FieldEphemerisGenerator<T>`	`getEphemerisGenerator()` Set up an ephemeris generator that will monitor the propagation for building an ephemeris from it once completed.
`Collection<FieldEventDetector<T>>`	`getEventsDetectors()` Get all the events detectors that have been added.
`Frame`	`getFrame()` Get the frame in which the orbit is propagated.
`FieldSpacecraftState<T>`	`getInitialState()` Get the propagator initial state.
`String[]`	`getManagedAdditionalStates()` Get all the names of all managed states.
`FieldStepHandlerMultiplexer<T>`	`getMultiplexer()` Get the multiplexer holding all step handlers.
`boolean`	`isAdditionalStateManaged(String name)` Check if an additional state is managed.
`FieldSpacecraftState<T>`	`propagate(FieldAbsoluteDate<T> target)` Propagate towards a target date.
`FieldSpacecraftState<T>`	`propagate(FieldAbsoluteDate<T> start, FieldAbsoluteDate<T> target)` Propagate from a start date towards a target date.
`void`	`resetInitialState(FieldSpacecraftState<T> state)` Reset the propagator initial state.
`void`	`setAttitudeProvider(AttitudeProvider attitudeProvider)` Set attitude provider.
`default void`	`setStepHandler(FieldOrekitStepHandler<T> handler)` Set a single handler for variable stepsizes.
`default void`	`setStepHandler(T h, FieldOrekitFixedStepHandler<T> handler)` Set a single handler for fixed stepsizes.

Methods inherited from interface org.orekit.utils.FieldPVCoordinatesProvider
getPVCoordinates

- Field Detail
  - DEFAULT_MASS
```
static final double DEFAULT_MASS
```
    Default mass.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getMultiplexer
```
FieldStepHandlerMultiplexer<T> getMultiplexer()
```
    Get the multiplexer holding all step handlers.
    
    Returns:
    
    multiplexer holding all step handlers
    
    Since:
    
    11.0
  - clearStepHandlers
```
default void clearStepHandlers()
```
    Remove all step handlers.
    This convenience method is equivalent to call getMultiplexer().clear()
    
    Since:
    
    11.0
    
    See Also:
    
    getMultiplexer(), FieldStepHandlerMultiplexer.clear()
  - setStepHandler
```
default void setStepHandler(T h,
                            FieldOrekitFixedStepHandler<T> handler)
```
    Set a single handler for fixed stepsizes.
    This convenience method is equivalent to call getMultiplexer().clear() followed by getMultiplexer().add(h, handler)
    
    Parameters:
    
    h - fixed stepsize (s)
    
    handler - handler called at the end of each finalized step
    
    Since:
    
    11.0
    
    See Also:
    
    getMultiplexer(), FieldStepHandlerMultiplexer.add(CalculusFieldElement, FieldOrekitFixedStepHandler)
  - setStepHandler
```
default void setStepHandler(FieldOrekitStepHandler<T> 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(), FieldStepHandlerMultiplexer.add(FieldOrekitStepHandler)
  - getEphemerisGenerator
```
FieldEphemerisGenerator<T> 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:
```
   FieldEphemerisGenerator<T> generator = propagator.getEphemerisGenerator();
   propagator.propagate(target);
   FieldBoundedPropagator<T> ephemeris = generator.getGeneratedEphemeris();
 
```
    Returns:
    
    ephemeris generator
  - getInitialState
```
FieldSpacecraftState<T> getInitialState()
```
    Get the propagator initial state.
    
    Returns:
    
    initial state
  - resetInitialState
```
void resetInitialState(FieldSpacecraftState<T> state)
```
    Reset the propagator initial state.
    
    Parameters:
    
    state - new initial state to consider
  - addAdditionalStateProvider
```
void addAdditionalStateProvider(FieldAdditionalStateProvider<T> additionalStateProvider)
```
    Add a set of user-specified state parameters to be computed along with the orbit propagation.
    
    Parameters:
    
    additionalStateProvider - provider for additional state
  - getAdditionalStateProviders
```
List<FieldAdditionalStateProvider<T>> getAdditionalStateProviders()
```
    Get an unmodifiable list of providers for additional state.
    
    Returns:
    
    providers for the additional states
  - isAdditionalStateManaged
```
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 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 state.
    
    Parameters:
    
    name - name of the additional state
    
    Returns:
    
    true if the additional state is managed
  - getManagedAdditionalStates
```
String[] getManagedAdditionalStates()
```
    Get all the names of all managed states.
    
    Returns:
    
    names of all managed states
  - addEventDetector
```
<D extends FieldEventDetector<T>> void addEventDetector(D detector)
```
    Add an event detector.
    
    Type Parameters:
    
    D - class type for the generic version
    
    Parameters:
    
    detector - event detector to add
    
    See Also:
    
    clearEventsDetectors(), getEventsDetectors()
  - getEventsDetectors
```
Collection<FieldEventDetector<T>> getEventsDetectors()
```
    Get all the events detectors that have been added.
    
    Returns:
    
    an unmodifiable collection of the added detectors
    
    See Also:
    
    addEventDetector(FieldEventDetector), clearEventsDetectors()
  - clearEventsDetectors
```
void clearEventsDetectors()
```
    Remove all events detectors.
    
    See Also:
    
    addEventDetector(FieldEventDetector), getEventsDetectors()
  - 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(FieldSpacecraftState)
  - propagate
```
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.
    
    Parameters:
    
    target - target date towards which orbit state should be propagated
    
    Returns:
    
    propagated state
  - propagate
```
FieldSpacecraftState<T> propagate(FieldAbsoluteDate<T> start,
                                  FieldAbsoluteDate<T> 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

Interface FieldPropagator<T extends CalculusFieldElement<T>>

Field Summary

Method Summary

Methods inherited from interface org.orekit.utils.FieldPVCoordinatesProvider

Field Detail

DEFAULT_MASS

Method Detail

getMultiplexer

clearStepHandlers

setStepHandler

setStepHandler

getEphemerisGenerator

getInitialState

resetInitialState

addAdditionalStateProvider

getAdditionalStateProviders

isAdditionalStateManaged

getManagedAdditionalStates

addEventDetector

getEventsDetectors

clearEventsDetectors

getAttitudeProvider

setAttitudeProvider

getFrame

propagate

propagate