Class PythonFieldAbstractPropagator<T extends CalculusFieldElement<T>>
- java.lang.Object
-
- org.orekit.propagation.FieldAbstractPropagator<T>
-
- org.orekit.propagation.PythonFieldAbstractPropagator<T>
-
- All Implemented Interfaces:
FieldPropagator<T>
,FieldPVCoordinatesProvider<T>
public class PythonFieldAbstractPropagator<T extends CalculusFieldElement<T>> extends FieldAbstractPropagator<T>
-
-
Field Summary
-
Fields inherited from interface org.orekit.propagation.FieldPropagator
DEFAULT_MASS
-
-
Constructor Summary
Constructors Constructor Description PythonFieldAbstractPropagator(Field<T> field)
Build a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <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 objectFieldEphemerisGenerator<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.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 object-
Methods inherited from class org.orekit.propagation.FieldAbstractPropagator
addAdditionalStateProvider, getAdditionalStateProviders, getAttitudeProvider, getField, getFrame, getInitialState, getManagedAdditionalStates, getMultiplexer, getPVCoordinates, getStartDate, initializeAdditionalStates, initializePropagation, isAdditionalStateManaged, propagate, resetInitialState, setAttitudeProvider, setStartDate, stateChanged, updateAdditionalStates, updateUnmanagedStates
-
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
-
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();
- Returns:
- ephemeris generator
-
addEventDetector
public <D extends FieldEventDetector<T>> void addEventDetector(D detector)
Add an event detector.- Type Parameters:
D
- class type for the generic version- Parameters:
detector
-- See Also:
FieldPropagator.clearEventsDetectors()
,FieldPropagator.getEventsDetectors()
-
getEventsDetectors
public Collection<FieldEventDetector<T>> getEventsDetectors()
Get all the events detectors that have been added.- Returns:
- an unmodifiable collection of the added detectors
- See Also:
FieldPropagator.addEventDetector(FieldEventDetector)
,FieldPropagator.clearEventsDetectors()
-
clearEventsDetectors
public void clearEventsDetectors()
Remove all events detectors.
-
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.
- Parameters:
start
- start date from which orbit state should be propagatedtarget
- target date to which orbit state should be propagated- Returns:
- propagated state
-
-