Class PythonFieldPropagator<T extends CalculusFieldElement<T>>
- java.lang.Object
-
- org.orekit.propagation.PythonFieldPropagator<T>
-
- All Implemented Interfaces:
FieldPropagator<T>
,FieldPVCoordinatesProvider<T>
public class PythonFieldPropagator<T extends CalculusFieldElement<T>> extends Object implements FieldPropagator<T>
-
-
Field Summary
-
Fields inherited from interface org.orekit.propagation.FieldPropagator
DEFAULT_MASS
-
-
Constructor Summary
Constructors Constructor Description PythonFieldPropagator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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>>
voidaddEventDetector(D detector)
Add an event detector.void
clearEventsDetectors()
Remove all events detectors.void
finalize()
Part of JCC Python interface to objectList<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.TimeStampedFieldPVCoordinates<T>
getPVCoordinates(FieldAbsoluteDate<T> date, Frame frame)
Get theFieldPVCoordinates
of the body in the selected frame.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
pythonDecRef()
Part of JCC Python interface to objectlong
pythonExtension()
Part of JCC Python interface to objectvoid
pythonExtension(long pythonObject)
Part of JCC Python interface to objectvoid
resetInitialState(FieldSpacecraftState<T> state)
Reset the propagator initial state.void
setAttitudeProvider(AttitudeProvider attitudeProvider)
Set attitude provider.-
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.orekit.propagation.FieldPropagator
clearStepHandlers, setStepHandler, setStepHandler
-
Methods inherited from interface org.orekit.utils.FieldPVCoordinatesProvider
getPosition
-
-
-
-
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
-
finalize
public void finalize() throws Throwable
Part of JCC Python interface to object
-
pythonDecRef
public void pythonDecRef()
Part of JCC Python interface to object
-
getMultiplexer
public FieldStepHandlerMultiplexer<T> getMultiplexer()
Get the multiplexer holding all step handlers.- Specified by:
getMultiplexer
in interfaceFieldPropagator<T extends CalculusFieldElement<T>>
- Returns:
- multiplexer holding all step handlers
-
getEphemerisGenerator
public 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)
orpropagate(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();
- Specified by:
getEphemerisGenerator
in interfaceFieldPropagator<T extends CalculusFieldElement<T>>
- Returns:
- ephemeris generator
-
getInitialState
public FieldSpacecraftState<T> getInitialState()
Get the propagator initial state.- Specified by:
getInitialState
in interfaceFieldPropagator<T extends CalculusFieldElement<T>>
- Returns:
- initial state
-
resetInitialState
public void resetInitialState(FieldSpacecraftState<T> state)
Reset the propagator initial state.- Specified by:
resetInitialState
in interfaceFieldPropagator<T extends CalculusFieldElement<T>>
- Parameters:
state
- new initial state to consider
-
addAdditionalStateProvider
public void addAdditionalStateProvider(FieldAdditionalStateProvider<T> additionalStateProvider)
Add a set of user-specified state parameters to be computed along with the orbit propagation.- Specified by:
addAdditionalStateProvider
in interfaceFieldPropagator<T extends CalculusFieldElement<T>>
- Parameters:
additionalStateProvider
- provider for additional state
-
getAdditionalStateProviders
public List<FieldAdditionalStateProvider<T>> getAdditionalStateProviders()
Get an unmodifiable list of providers for additional state.- Specified by:
getAdditionalStateProviders
in interfaceFieldPropagator<T extends CalculusFieldElement<T>>
- Returns:
- providers for the additional states
-
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 theaddAdditionalStateProvider
method. If the propagator is anintegrator-based propagator
, the states for which a set ofadditional derivatives provider
has been registered by calling theaddAdditionalDerivativesProvider
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 handlerresetState
method is called at an event occurrence and happens to change the unmanaged additional state.- Specified by:
isAdditionalStateManaged
in interfaceFieldPropagator<T extends CalculusFieldElement<T>>
- Parameters:
name
- name of the additional state- Returns:
- true if the additional state is managed
-
getManagedAdditionalStates
public String[] getManagedAdditionalStates()
Get all the names of all managed states.- Specified by:
getManagedAdditionalStates
in interfaceFieldPropagator<T extends CalculusFieldElement<T>>
- Returns:
- names of all managed states
-
addEventDetector
public <D extends FieldEventDetector<T>> void addEventDetector(D detector)
Add an event detector.- Specified by:
addEventDetector
in interfaceFieldPropagator<T extends CalculusFieldElement<T>>
- Type Parameters:
D
- class type for the generic version- Parameters:
detector
- event detector to add- See Also:
FieldPropagator.clearEventsDetectors()
,FieldPropagator.getEventsDetectors()
-
getEventsDetectors
public Collection<FieldEventDetector<T>> getEventsDetectors()
Get all the events detectors that have been added.- Specified by:
getEventsDetectors
in interfaceFieldPropagator<T extends CalculusFieldElement<T>>
- Returns:
- an unmodifiable collection of the added detectors
- See Also:
FieldPropagator.addEventDetector(FieldEventDetector)
,FieldPropagator.clearEventsDetectors()
-
clearEventsDetectors
public void clearEventsDetectors()
Remove all events detectors.- Specified by:
clearEventsDetectors
in interfaceFieldPropagator<T extends CalculusFieldElement<T>>
- See Also:
FieldPropagator.addEventDetector(FieldEventDetector)
,FieldPropagator.getEventsDetectors()
-
getAttitudeProvider
public AttitudeProvider getAttitudeProvider()
Get attitude provider.- Specified by:
getAttitudeProvider
in interfaceFieldPropagator<T extends CalculusFieldElement<T>>
- Returns:
- attitude provider
-
setAttitudeProvider
public void setAttitudeProvider(AttitudeProvider attitudeProvider)
Set attitude provider.- Specified by:
setAttitudeProvider
in interfaceFieldPropagator<T extends CalculusFieldElement<T>>
- Parameters:
attitudeProvider
- attitude provider
-
getFrame
public 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.
- Specified by:
getFrame
in interfaceFieldPropagator<T extends CalculusFieldElement<T>>
- Returns:
- frame in which the orbit is propagated
- See Also:
FieldPropagator.resetInitialState(FieldSpacecraftState)
-
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 interfaceFieldPropagator<T extends CalculusFieldElement<T>>
- Parameters:
target
- target date towards which orbit state should be propagated- Returns:
- propagated state
-
propagate
public 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.
- Specified by:
propagate
in interfaceFieldPropagator<T extends CalculusFieldElement<T>>
- Parameters:
start
- start date from which orbit state should be propagatedtarget
- target date to which orbit state should be propagated- Returns:
- propagated state
-
getPVCoordinates
public TimeStampedFieldPVCoordinates<T> getPVCoordinates(FieldAbsoluteDate<T> date, Frame frame)
Get theFieldPVCoordinates
of the body in the selected frame.- Specified by:
getPVCoordinates
in interfaceFieldPVCoordinatesProvider<T extends CalculusFieldElement<T>>
- Parameters:
date
- current dateframe
- the frame where to define the position- Returns:
- time-stamped position/velocity of the body (m and m/s)
-
-