Package org.orekit.propagation.events

Class FieldLatitudeCrossingDetector<T extends CalculusFieldElement<T>>

java.lang.Object

org.orekit.propagation.events.FieldAbstractDetector<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 FieldAbstractDetector<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_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected FieldLatitudeCrossingDetector<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 detection function.
OneAxisEllipsoid	getBody()	Get the body on which the geographic zone is defined.
double	getLatitude()	Get the fixed latitude to be crossed (radians).

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

create, getDetectionSettings, getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, 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

Constructor Detail

FieldLatitudeCrossingDetector

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

Build a new detector.

The new instance uses default values for maximal checking interval (FieldAbstractDetector.DEFAULT_MAXCHECK) 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,
                                     OneAxisEllipsoid 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(FieldAdaptableInterval<T> maxCheck,
                                        T threshold,
                                        int maxIter,
                                        FieldEventHandler<T> handler,
                                        OneAxisEllipsoid 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:

maxCheck - maximum checking interval

threshold - convergence threshold (s)

maxIter - maximum number of iterations in the event time search

handler - event handler to call at event occurrences

body - body on which the latitude is defined

latitude - latitude to be crossed

Method Detail

create

protected FieldLatitudeCrossingDetector<T> create(FieldAdaptableInterval<T> newMaxCheck,
                                                  T newThreshold,
                                                  int newMaxIter,
                                                  FieldEventHandler<T> newHandler)

Build a new instance.

Specified by:

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

Parameters:

newMaxCheck - maximum checking interval

newThreshold - convergence threshold (s)

newMaxIter - maximum number of iterations in the event time search

newHandler - event handler to call at event occurrences

Returns:

a new instance of the appropriate sub-type

getBody

public OneAxisEllipsoid getBody()

Get the body on which the geographic zone is defined.

Returns:

body on which the geographic zone is defined

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