Package org.orekit.propagation.events
Class CylindricalShadowEclipseDetector
- java.lang.Object
-
- org.orekit.propagation.events.AbstractDetector<CylindricalShadowEclipseDetector>
-
- org.orekit.propagation.events.CylindricalShadowEclipseDetector
-
- All Implemented Interfaces:
EventDetector
public class CylindricalShadowEclipseDetector extends AbstractDetector<CylindricalShadowEclipseDetector>
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.1
- Author:
- Romain Serra
- See Also:
EclipseDetector
-
-
Field Summary
-
Fields inherited from class org.orekit.propagation.events.AbstractDetector
DEFAULT_MAX_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD
-
-
Constructor Summary
Constructors Constructor Description CylindricalShadowEclipseDetector(PVCoordinatesProvider sun, double occultingBodyRadius, AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler)
Constructor.CylindricalShadowEclipseDetector(PVCoordinatesProvider sun, double occultingBodyRadius, EventHandler handler)
Constructor with default detection settings.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected CylindricalShadowEclipseDetector
create(AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, EventHandler newHandler)
Build a new instance.double
g(SpacecraftState s)
Compute the value of the switching function.double
getOccultingBodyRadius()
Getter for occulting body radius.-
Methods inherited from class org.orekit.propagation.events.AbstractDetector
getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, init, isForward, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThreshold
-
-
-
-
Constructor Detail
-
CylindricalShadowEclipseDetector
public CylindricalShadowEclipseDetector(PVCoordinatesProvider sun, double occultingBodyRadius, AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler)
Constructor.- 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
-
CylindricalShadowEclipseDetector
public CylindricalShadowEclipseDetector(PVCoordinatesProvider sun, double occultingBodyRadius, EventHandler handler)
Constructor with default detection settings.- Parameters:
sun
- light source provideroccultingBodyRadius
- occulting body radiushandler
- event handler
-
-
Method Detail
-
getOccultingBodyRadius
public double getOccultingBodyRadius()
Getter for occulting body radius.- Returns:
- radius
-
g
public double g(SpacecraftState 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 interfaceEventDetector
- Specified by:
g
in classAbstractDetector<CylindricalShadowEclipseDetector>
- Parameters:
s
- the current state information: date, kinematics, attitude- Returns:
- value of the switching function
-
create
protected CylindricalShadowEclipseDetector create(AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, EventHandler newHandler)
Build a new instance.- Specified by:
create
in classAbstractDetector<CylindricalShadowEclipseDetector>
- Parameters:
newMaxCheck
- maximum checking interval (s)newThreshold
- 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
-
-