Package org.orekit.propagation.events

Class FieldLatitudeCrossingDetector<T extends CalculusFieldElement<T>>

java.lang.Object

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

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

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

Type Parameters:

T - type of the field elements

All Implemented Interfaces:

FieldEventDetector<T>

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

Detector for geographic latitude crossing.

This detector identifies when a spacecraft crosses a fixed latitude with respect to a central body.

Since:

9.3

Author:

Luc Maisonobe, Evan Ward

Field Summary

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

DEFAULT_MAX_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Modifier	Constructor	Description
	FieldLatitudeCrossingDetector(Field<T> field, BodyShape body, double latitude)	Build a new detector.
protected	FieldLatitudeCrossingDetector(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> handler, BodyShape body, double latitude)	Protected constructor with full parameters.
	FieldLatitudeCrossingDetector(T maxCheck, T threshold, BodyShape body, double latitude)	Build a detector.

Method Summary

Modifier and Type	Method	Description
protected FieldLatitudeCrossingDetector<T>	create(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> newHandler)	Build a new instance.
T	g(FieldSpacecraftState<T> s)	Compute the value of the detection function.
LatitudeValueCrossingEventFunction	getEventFunction()	Get the event function.
double	getLatitude()	Get the fixed latitude to be crossed (radians).
LatitudeCrossingDetector	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

FieldLatitudeCrossingDetector

public FieldLatitudeCrossingDetector(Field<T> field,
                                     BodyShape body,
                                     double latitude)

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

latitude - latitude to be crossed

FieldLatitudeCrossingDetector

public FieldLatitudeCrossingDetector(T maxCheck,
                                     T threshold,
                                     BodyShape body,
                                     double latitude)

Build a detector.

Parameters:

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

body - body on which the latitude is defined

latitude - latitude to be crossed

FieldLatitudeCrossingDetector

protected FieldLatitudeCrossingDetector(FieldEventDetectionSettings<T> detectionSettings,
                                        FieldEventHandler<T> handler,
                                        BodyShape body,
                                        double latitude)

Protected 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

latitude - latitude to be crossed

Since:

13.0

Method Detail

create

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

Build a new instance.

Specified by:

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

getEventFunction

public LatitudeValueCrossingEventFunction getEventFunction()

Description copied from interface: FieldEventDetector

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<FieldLatitudeCrossingDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

Returns:

event function

getLatitude

public double getLatitude()

Get the fixed latitude to be crossed (radians).

Returns:

fixed latitude to be crossed (radians)

g

public T g(FieldSpacecraftState<T> s)

Compute the value of the detection function.

The value is the spacecraft latitude minus the fixed latitude to be crossed. It is positive if the spacecraft is northward and negative if it is southward with respect to the fixed latitude.

Parameters:

s - the current state information: date, kinematics, attitude

Returns:

spacecraft latitude minus the fixed latitude to be crossed

toEventDetector

public LatitudeCrossingDetector toEventDetector(EventHandler eventHandler)

Description copied from class: FieldAbstractDetector

Build non-Field instance.

Overrides:

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

Parameters:

eventHandler - event handler

Returns:

event detector