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>

Type Parameters:

T - type of the field elements

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_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Constructor	Description
FieldCylindricalShadowEclipseDetector(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

Modifier and Type	Method	Description
protected FieldCylindricalShadowEclipseDetector<T>	create(FieldEventDetectionSettings<T> detectionSettings, 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.
CylindricalShadowEclipseDetector	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, 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, reset

Constructor Details

FieldCylindricalShadowEclipseDetector

public FieldCylindricalShadowEclipseDetector(ExtendedPositionProvider sun,
 T occultingBodyRadius,
 FieldEventDetectionSettings<T> eventDetectionSettings,
 FieldEventHandler<T> handler)

Constructor.

Parameters:

sun - light source provider (infinitely distant)

occultingBodyRadius - occulting body radius

eventDetectionSettings - detection settings

handler - event handler

Since:

12.2

FieldCylindricalShadowEclipseDetector

public FieldCylindricalShadowEclipseDetector(ExtendedPositionProvider sun,
 T occultingBodyRadius,
 FieldEventHandler<T> handler)

Constructor with default detection settings.

Parameters:

sun - light source provider

occultingBodyRadius - occulting body radius

handler - event handler

Method Details

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(FieldEventDetectionSettings<T> detectionSettings,
 FieldEventHandler<T> newHandler)

Build a new instance.

Specified by:

create in class FieldAbstractDetector<FieldCylindricalShadowEclipseDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

Parameters:

detectionSettings - detection settings

newHandler - event handler to call at event occurrences

Returns:

a new instance of the appropriate sub-type

toEventDetector

public CylindricalShadowEclipseDetector toEventDetector(EventHandler eventHandler)

Build non-Field instance.

Overrides:

toEventDetector in class FieldAbstractDetector<FieldCylindricalShadowEclipseDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

Parameters:

eventHandler - event handler

Returns:

event detector