Package org.orekit.propagation.events

Interface FieldDetectorModifier<T extends CalculusFieldElement<T>>

Type Parameters:

T - type of the field element

All Superinterfaces:

FieldEventDetector<T>

All Known Implementing Classes:

FieldEventEnablingPredicateFilter, FieldEventShifter, FieldImpulseManeuver, FieldManeuverTriggerDetector, FieldNegateDetector

public interface FieldDetectorModifier<T extends CalculusFieldElement<T>>
extends FieldEventDetector<T>

Base class for modifying an existing getDetector().

This class is intended to be a base class for changing behaviour of a wrapped existing getDetector(). This base class delegates all its methods to the wrapped getDetector(). Classes extending it can therefore override only the methods they want to change.

Since:

13.0

Author:

Luc Maisonobe, Romain Serra

Method Summary

Modifier and Type	Method	Description
default boolean	dependsOnMainVariablesOnly()	Method returning true if and only if the detection function g does not depend on dependent variables, other than the Cartesian coordinates (or equivalent), mass and attitude (excepts for its rates).
default boolean	dependsOnTimeOnly()	Method returning true if and only if the detection function g does not depend on dependent variables, just the independent one i.e. time.
default void	finish(FieldSpacecraftState<T> state)	This method finalizes the event detector's job.
default T	g(FieldSpacecraftState<T> s)	Compute the value of the switching function.
default FieldEventDetectionSettings<T>	getDetectionSettings()	Getter for the settings.
FieldEventDetector<T>	getDetector()	Getter for wrapped detector.
default FieldEventHandler<T>	getHandler()	Get the handler.
default void	init(FieldSpacecraftState<T> s0, FieldAbsoluteDate<T> t)	Initialize event detector at the start of a propagation.
default void	reset(FieldSpacecraftState<T> state, FieldAbsoluteDate<T> target)	Reset the event detector during propagation when the state is modified by an event or an additional data provider.

Methods inherited from interface org.orekit.propagation.events.FieldEventDetector

getMaxCheckInterval, getMaxIterationCount, getThreshold

Method Detail

getDetector

FieldEventDetector<T> getDetector()

Getter for wrapped detector.

Returns:

detector

init

default void init(FieldSpacecraftState<T> s0,
                  FieldAbsoluteDate<T> t)

Initialize event detector at the start of a propagation.

This method is called once at the start of the propagation. It may be used by the event detector to initialize some internal data if needed.

The default implementation initializes the handler.

Specified by:

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

Parameters:

s0 - initial state

t - target time for the integration

reset

default void reset(FieldSpacecraftState<T> state,
                   FieldAbsoluteDate<T> target)

Reset the event detector during propagation when the state is modified by an event or an additional data provider.

The default implementation does nothing.

Specified by:

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

Parameters:

state - current state

target - target time for the integration

dependsOnTimeOnly

default boolean dependsOnTimeOnly()

Method returning true if and only if the detection function g does not depend on dependent variables, just the independent one i.e. time. This information is used for performance in propagation and derivatives correction with switches in the dynamics.

Specified by:

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

Returns:

flag

dependsOnMainVariablesOnly

default boolean dependsOnMainVariablesOnly()

Description copied from interface: FieldEventDetector

Method returning true if and only if the detection function g does not depend on dependent variables, other than the Cartesian coordinates (or equivalent), mass and attitude (excepts for its rates). It should thus return false if the STM is needed to evaluate the event. This information is used for performance in propagation.

Specified by:

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

Returns:

flag

g

default 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.

Specified by:

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

Parameters:

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

Returns:

value of the switching function

getHandler

default FieldEventHandler<T> getHandler()

Get the handler.

Specified by:

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

Returns:

event handler to call at event occurrences

finish

default void finish(FieldSpacecraftState<T> state)

This method finalizes the event detector's job.

Specified by:

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

Parameters:

state - state at propagation end

getDetectionSettings

default FieldEventDetectionSettings<T> getDetectionSettings()

Getter for the settings.

Specified by:

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

Returns:

detection settings