Package org.orekit.propagation.events

Class FieldLatitudeExtremumDetector<T extends CalculusFieldElement<T>>

java.lang.Object

org.orekit.propagation.events.FieldAbstractDetector<D,T>

org.orekit.propagation.events.FieldAbstractGeographicalDetector<FieldLatitudeExtremumDetector<T>,T>

org.orekit.propagation.events.FieldLatitudeExtremumDetector<T>

Type Parameters:

T - type of the field elements

All Implemented Interfaces:

FieldEventDetector<T>

public class FieldLatitudeExtremumDetector<T extends CalculusFieldElement<T>>
extends FieldAbstractGeographicalDetector<FieldLatitudeExtremumDetector<T>,T>

Detector for latitude extrema.

Since:

14.0

Author:

Romain Serra

See Also:

LatitudeExtremumDetector

Field Summary

Fields inherited from class org.orekit.propagation.events.FieldAbstractDetector

DEFAULT_MAX_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Constructor	Description
FieldLatitudeExtremumDetector(Field<T> field, BodyShape body)	Build a new detector.
FieldLatitudeExtremumDetector(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> handler, BodyShape body)	Constructor with full parameters.

Method Summary

Modifier and Type	Method	Description
protected FieldLatitudeExtremumDetector<T>	create(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> newHandler)	Build a new instance.
T	g(FieldSpacecraftState<T> s)	Compute the value of the switching function.
LatitudeExtremumEventFunction	getEventFunction()	Get the event function.
LatitudeExtremumDetector	toEventDetector(EventHandler eventHandler)	Build non-Field instance.

Methods inherited from class org.orekit.propagation.events.FieldAbstractGeographicalDetector

getBodyShape

Methods inherited from class org.orekit.propagation.events.FieldAbstractDetector

checkIfForward, 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, reset

Constructor Detail

FieldLatitudeExtremumDetector

public FieldLatitudeExtremumDetector(Field<T> field,
                                     BodyShape body)

Build a new detector.

The new instance uses default values for maximal checking interval (FieldAbstractDetector.DEFAULT_MAX_CHECK) and convergence threshold (FieldAbstractDetector.DEFAULT_THRESHOLD).

Parameters:

field - the type of numbers to use.

body - body on which the latitude is defined

FieldLatitudeExtremumDetector

public FieldLatitudeExtremumDetector(FieldEventDetectionSettings<T> detectionSettings,
                                     FieldEventHandler<T> handler,
                                     BodyShape body)

Constructor with full parameters.

This constructor is not public as users are expected to use the builder API with the various withXxx() methods to set up the instance in a readable manner without using a huge amount of parameters.

Parameters:

detectionSettings - event detection settings

handler - event handler to call at event occurrences

body - body on which the latitude is defined

Since:

13.0

Method Detail

getEventFunction

public LatitudeExtremumEventFunction getEventFunction()

Get the event function. It defines g both for double and Field.

Specified by:

getEventFunction in interface FieldEventDetector<T extends CalculusFieldElement<T>>

Overrides:

getEventFunction in class FieldAbstractDetector<FieldLatitudeExtremumDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

Returns:

event function

create

protected FieldLatitudeExtremumDetector<T> create(FieldEventDetectionSettings<T> detectionSettings,
                                                  FieldEventHandler<T> newHandler)

Build a new instance.

Specified by:

create in class FieldAbstractDetector<FieldLatitudeExtremumDetector<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

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

toEventDetector

public LatitudeExtremumDetector toEventDetector(EventHandler eventHandler)

Description copied from class: FieldAbstractDetector

Build non-Field instance.

Overrides:

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

Parameters:

eventHandler - event handler

Returns:

event detector