Package org.orekit.propagation.events

Class FieldPlaneCrossingDetector<T extends CalculusFieldElement<T>>

java.lang.Object

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

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

All Implemented Interfaces:

FieldEventDetector<T>

public class FieldPlaneCrossingDetector<T extends CalculusFieldElement<T>>
extends FieldAbstractDetector<FieldPlaneCrossingDetector<T>,T>

Finder for plane crossing events.

Since:

14.0

Author:

Romain Serra

See Also:

PlaneCrossingDetector

Field Summary

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

DEFAULT_MAX_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Constructor	Description
FieldPlaneCrossingDetector(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> handler, PlaneCrossingFunction planeCrossingFunction)	Constructor with detection settings and handler.

Method Summary

Modifier and Type	Method	Description
protected FieldPlaneCrossingDetector<T>	create(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> newHandler)	Build a new instance.
T	g(FieldSpacecraftState<T> s)	Compute the value of the switching function.
PlaneCrossingDetector	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 Detail

FieldPlaneCrossingDetector

public FieldPlaneCrossingDetector(FieldEventDetectionSettings<T> detectionSettings,
                                  FieldEventHandler<T> handler,
                                  PlaneCrossingFunction planeCrossingFunction)

Constructor with detection settings and handler.

Parameters:

detectionSettings - event detection settings

handler - event handler to call at event occurrences

planeCrossingFunction - event function

Method Detail

create

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

Build a new instance.

Specified by:

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

Description copied from interface: FieldEventDetector

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 PlaneCrossingDetector toEventDetector(EventHandler eventHandler)

Description copied from class: FieldAbstractDetector

Build non-Field instance.

Overrides:

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

Parameters:

eventHandler - event handler

Returns:

event detector