Package org.orekit.propagation.events
Class FieldCylindricalShadowEclipseDetector<T extends CalculusFieldElement<T>>
- java.lang.Object
-
- org.orekit.propagation.events.FieldAbstractDetector<FieldCylindricalShadowEclipseDetector<T>,T>
-
- org.orekit.propagation.events.FieldCylindricalShadowEclipseDetector<T>
-
- All Implemented Interfaces:
FieldEventDetector<T>
public class FieldCylindricalShadowEclipseDetector<T extends CalculusFieldElement<T>> extends FieldAbstractDetector<FieldCylindricalShadowEclipseDetector<T>,T>
Event detector for eclipses from a single, infinitely-distant light source, occulted by a spherical central body. The shadow region is cylindrical, a model less accurate than a conical one but more computationally-performant.The so-called g function is negative in eclipse, positive otherwise.
- Since:
- 12.
- Author:
- Romain Serra
- See Also:
FieldEclipseDetector
,CylindricalShadowEclipseDetector
-
-
Field Summary
-
Fields inherited from class org.orekit.propagation.events.FieldAbstractDetector
DEFAULT_MAX_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD
-
-
Constructor Summary
Constructors Constructor Description FieldCylindricalShadowEclipseDetector(ExtendedPositionProvider sun, T occultingBodyRadius, FieldAdaptableInterval<T> maxCheck, T threshold, int maxIter, FieldEventHandler<T> handler)
Deprecated.since 12.2FieldCylindricalShadowEclipseDetector(ExtendedPositionProvider sun, T occultingBodyRadius, FieldEventDetectionSettings<T> eventDetectionSettings, FieldEventHandler<T> handler)
Constructor.FieldCylindricalShadowEclipseDetector(ExtendedPositionProvider sun, T occultingBodyRadius, FieldEventHandler<T> handler)
Constructor with default detection settings.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected FieldCylindricalShadowEclipseDetector<T>
create(FieldAdaptableInterval<T> newMaxCheck, T newThreshold, int newMaxIter, FieldEventHandler<T> newHandler)
Build a new instance.T
g(FieldSpacecraftState<T> s)
Compute the value of the switching function.T
getOccultingBodyRadius()
Getter for occulting body radius.-
Methods inherited from class org.orekit.propagation.events.FieldAbstractDetector
getDetectionSettings, getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, init, isForward, withDetectionSettings, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThreshold
-
-
-
-
Constructor Detail
-
FieldCylindricalShadowEclipseDetector
public FieldCylindricalShadowEclipseDetector(ExtendedPositionProvider sun, T occultingBodyRadius, FieldEventDetectionSettings<T> eventDetectionSettings, FieldEventHandler<T> handler)
Constructor.- Parameters:
sun
- light source provider (infinitely distant)occultingBodyRadius
- occulting body radiuseventDetectionSettings
- detection settingshandler
- event handler- Since:
- 12.2
-
FieldCylindricalShadowEclipseDetector
@Deprecated public FieldCylindricalShadowEclipseDetector(ExtendedPositionProvider sun, T occultingBodyRadius, FieldAdaptableInterval<T> maxCheck, T threshold, int maxIter, FieldEventHandler<T> handler)
Deprecated.since 12.2Constructor.- Parameters:
sun
- light source provider (infinitely distant)occultingBodyRadius
- occulting body radiusmaxCheck
- maximum check for event detectionthreshold
- threshold for event detectionmaxIter
- maximum iteration for event detectionhandler
- event handler
-
FieldCylindricalShadowEclipseDetector
public FieldCylindricalShadowEclipseDetector(ExtendedPositionProvider sun, T occultingBodyRadius, FieldEventHandler<T> handler)
Constructor with default detection settings.- Parameters:
sun
- light source provideroccultingBodyRadius
- occulting body radiushandler
- event handler
-
-
Method Detail
-
getOccultingBodyRadius
public T getOccultingBodyRadius()
Getter for occulting body radius.- Returns:
- radius
-
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.- Parameters:
s
- the current state information: date, kinematics, attitude- Returns:
- value of the switching function
-
create
protected FieldCylindricalShadowEclipseDetector<T> create(FieldAdaptableInterval<T> newMaxCheck, T newThreshold, int newMaxIter, FieldEventHandler<T> newHandler)
Build a new instance.- Specified by:
create
in classFieldAbstractDetector<FieldCylindricalShadowEclipseDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>
- Parameters:
newMaxCheck
- maximum checking intervalnewThreshold
- convergence threshold (s)newMaxIter
- maximum number of iterations in the event time searchnewHandler
- event handler to call at event occurrences- Returns:
- a new instance of the appropriate sub-type
-
-