Package org.orekit.propagation.events
Class FieldPlaneCrossingDetector<T extends CalculusFieldElement<T>>
java.lang.Object
org.orekit.propagation.events.FieldAbstractDetector<FieldPlaneCrossingDetector<T>,T>
org.orekit.propagation.events.FieldPlaneCrossingDetector<T>
- All Implemented Interfaces:
FieldEventDetector<T>
public class FieldPlaneCrossingDetector<T extends CalculusFieldElement<T>>
extends FieldAbstractDetector<FieldPlaneCrossingDetector<T>,T>
Finder for plane crossing events.
- Since:
- 14.0
- Author:
- Romain Serra
- See Also:
-
Field Summary
Fields inherited from class org.orekit.propagation.events.FieldAbstractDetector
DEFAULT_MAX_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD -
Constructor Summary
ConstructorsConstructorDescriptionFieldPlaneCrossingDetector(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> handler, PlaneCrossingFunction planeCrossingFunction) Constructor with detection settings and handler. -
Method Summary
Modifier and TypeMethodDescriptionprotected FieldPlaneCrossingDetector<T> create(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> newHandler) Build a new instance.g(FieldSpacecraftState<T> s) Compute the value of the switching function.toEventDetector(EventHandler eventHandler) Build non-Field instance.Methods inherited from class org.orekit.propagation.events.FieldAbstractDetector
checkIfForward, getDetectionSettings, getEventFunction, getHandler, init, isForward, withDetectionSettings, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThresholdMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.orekit.propagation.events.FieldEventDetector
finish, getMaxCheckInterval, getMaxIterationCount, getThreshold, reset
-
Constructor Details
-
FieldPlaneCrossingDetector
public FieldPlaneCrossingDetector(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> handler, PlaneCrossingFunction planeCrossingFunction) Constructor with detection settings and handler.- Parameters:
detectionSettings- event detection settingshandler- event handler to call at event occurrencesplaneCrossingFunction- event function
-
-
Method Details
-
create
protected FieldPlaneCrossingDetector<T> create(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> newHandler) Build a new instance.- Specified by:
createin classFieldAbstractDetector<FieldPlaneCrossingDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>> - Parameters:
detectionSettings- detection settingsnewHandler- event handler to call at event occurrences- Returns:
- a new instance of the appropriate sub-type
-
g
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.- Parameters:
s- the current state information: date, kinematics, attitude- Returns:
- value of the switching function
-
toEventDetector
Build non-Field instance.- Overrides:
toEventDetectorin classFieldAbstractDetector<FieldPlaneCrossingDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>> - Parameters:
eventHandler- event handler- Returns:
- event detector
-