Class PythonFieldEventDetector<T extends CalculusFieldElement<T>>
- java.lang.Object
-
- org.orekit.propagation.events.PythonFieldEventDetector<T>
-
- All Implemented Interfaces:
FieldEventDetector<T>
public class PythonFieldEventDetector<T extends CalculusFieldElement<T>> extends Object implements FieldEventDetector<T>
-
-
Constructor Summary
Constructors Constructor Description PythonFieldEventDetector()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Action
eventOccurred(FieldSpacecraftState<T> s, boolean increasing)
Handle the event.void
finalize()
Part of JCC Python interface to objectT
g(FieldSpacecraftState<T> s)
Compute the value of the switching function.T
getMaxCheckInterval()
Get maximal time interval between switching function checks.int
getMaxIterationCount()
Get maximal number of iterations in the event time search.T
getThreshold()
Get the convergence threshold in the event time search.void
init(FieldSpacecraftState<T> s0, FieldAbsoluteDate<T> t)
Initialize event handler at the start of a propagation.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 objectFieldSpacecraftState<T>
resetState(FieldSpacecraftState<T> oldState)
Reset the state prior to continue propagation.
-
-
-
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
-
init
public void init(FieldSpacecraftState<T> s0, FieldAbsoluteDate<T> t)
Initialize event handler at the start of a propagation.This method is called once at the start of the propagation. It may be used by the event handler to initialize some internal data if needed.
The default implementation does nothing
- Specified by:
init
in interfaceFieldEventDetector<T extends CalculusFieldElement<T>>
- Parameters:
s0
- initial statet
- target time for the integration
-
g
public T g(FieldSpacecraftState<T> s)
Compute the value of the switching function. This function must be continuous (at least in its roots neighborhood), as the integrator will need to find its roots to locate the events.- Specified by:
g
in interfaceFieldEventDetector<T extends CalculusFieldElement<T>>
- Parameters:
s
- the current state information: date, kinematics, attitude- Returns:
- value of the switching function
-
getThreshold
public T getThreshold()
Get the convergence threshold in the event time search.- Specified by:
getThreshold
in interfaceFieldEventDetector<T extends CalculusFieldElement<T>>
- Returns:
- convergence threshold (s)
-
getMaxCheckInterval
public T getMaxCheckInterval()
Get maximal time interval between switching function checks.- Specified by:
getMaxCheckInterval
in interfaceFieldEventDetector<T extends CalculusFieldElement<T>>
- Returns:
- maximal time interval (s) between switching function checks
-
getMaxIterationCount
public int getMaxIterationCount()
Get maximal number of iterations in the event time search.- Specified by:
getMaxIterationCount
in interfaceFieldEventDetector<T extends CalculusFieldElement<T>>
- Returns:
- maximal number of iterations in the event time search
-
eventOccurred
public Action eventOccurred(FieldSpacecraftState<T> s, boolean increasing)
Handle the event.- Specified by:
eventOccurred
in interfaceFieldEventDetector<T extends CalculusFieldElement<T>>
- Parameters:
s
- SpaceCraft state to be used in the evaluationincreasing
- with the event occurred in an "increasing" or "decreasing" slope direction- Returns:
- the Action that the calling detector should pass back to the evaluation system
- Since:
- 7.0
-
resetState
public FieldSpacecraftState<T> resetState(FieldSpacecraftState<T> oldState)
Reset the state prior to continue propagation.This method is called after the step handler has returned and before the next step is started, but only when
eventOccurred(org.orekit.propagation.FieldSpacecraftState<T>, boolean)
has itself returned theAction.RESET_STATE
indicator. It allows the user to reset the state for the next step, without perturbing the step handler of the finishing step. If theeventOccurred(org.orekit.propagation.FieldSpacecraftState<T>, boolean)
never returns theAction.RESET_STATE
indicator, this function will never be called, and it is safe to simply return null.The default implementation simply returns its argument.
- Specified by:
resetState
in interfaceFieldEventDetector<T extends CalculusFieldElement<T>>
- Parameters:
oldState
- old state- Returns:
- new state
- Since:
- 7.0
-
-