Class FieldApsideDetector<T extends CalculusFieldElement<T>>
- java.lang.Object
-
- org.orekit.propagation.events.FieldAbstractDetector<FieldApsideDetector<T>,T>
-
- org.orekit.propagation.events.FieldApsideDetector<T>
-
- Type Parameters:
T
- type of the field elements
- All Implemented Interfaces:
FieldEventDetector<T>
public class FieldApsideDetector<T extends CalculusFieldElement<T>> extends FieldAbstractDetector<FieldApsideDetector<T>,T>
Finder for apside crossing events.This class finds apside crossing events (i.e. apogee or perigee crossing).
The default implementation behavior is to
continue
propagation at apogee crossing and tostop
propagation at perigee crossing. This can be changed by callingFieldAbstractDetector.withHandler(FieldEventHandler)
after construction.Beware that apside detection will fail for almost circular orbits. If for example an apside detector is used to trigger an
ImpulseManeuver
and the maneuver change the orbit shape to circular, then the detector may completely fail just after the maneuver has been performed!- Author:
- Luc Maisonobe
- See Also:
FieldPropagator.addEventDetector(FieldEventDetector)
-
-
Field Summary
-
Fields inherited from class org.orekit.propagation.events.FieldAbstractDetector
DEFAULT_MAX_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD
-
-
Constructor Summary
Constructors Constructor Description FieldApsideDetector(FieldOrbit<T> orbit)
Build a new instance.FieldApsideDetector(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> handler)
Constructor with full parameters.FieldApsideDetector(T keplerianPeriod)
Build a new instance.FieldApsideDetector(T threshold, FieldOrbit<T> orbit)
Build a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected FieldApsideDetector<T>
create(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> newHandler)
Build a new instance.T
g(FieldSpacecraftState<T> s)
Compute the value of the switching function.-
Methods inherited from class org.orekit.propagation.events.FieldAbstractDetector
getDetectionSettings, getHandler, init, isForward, withDetectionSettings, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThreshold
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.orekit.propagation.events.FieldEventDetector
finish, getMaxCheckInterval, getMaxIterationCount, getThreshold
-
-
-
-
Constructor Detail
-
FieldApsideDetector
public FieldApsideDetector(T keplerianPeriod)
Build a new instance.The Keplerian period is used only to set an upper bound for the max check interval to period/3 and to set the convergence threshold.
- Parameters:
keplerianPeriod
- estimate of the Keplerian period- Since:
- 12.1
-
FieldApsideDetector
public FieldApsideDetector(FieldOrbit<T> orbit)
Build a new instance.The orbit is used only to set an upper bound for the max check interval to period/3 and to set the convergence threshold according to orbit size
- Parameters:
orbit
- initial orbit
-
FieldApsideDetector
public FieldApsideDetector(T threshold, FieldOrbit<T> orbit)
Build a new instance.The orbit is used only to set an upper bound for the max check interval to period/3
- Parameters:
threshold
- convergence threshold (s)orbit
- initial orbit
-
FieldApsideDetector
public FieldApsideDetector(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> handler)
Constructor with full parameters.This constructor is public because otherwise all accessible ones would require an orbit.
- Parameters:
detectionSettings
- event detection settingshandler
- event handler to call at event occurrences- Since:
- 13.0
-
-
Method Detail
-
create
protected FieldApsideDetector<T> create(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> newHandler)
Build a new instance.- Specified by:
create
in classFieldAbstractDetector<FieldApsideDetector<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
public T g(FieldSpacecraftState<T> s)
Compute the value of the switching function. This function computes the dot product of the 2 vectors : position.velocity.- Parameters:
s
- the current state information: date, kinematics, attitude- Returns:
- value of the switching function
-
-