org.orekit.propagation.events.handlers

Class FieldStopOnIncreasing<T extends org.hipparchus.CalculusFieldElement<T>>

java.lang.Object

org.orekit.propagation.events.handlers.FieldStopOnIncreasing<T>

Type Parameters:

T - type of the field element

All Implemented Interfaces:

FieldEventHandler<T>

public class FieldStopOnIncreasing<T extends org.hipparchus.CalculusFieldElement<T>>
extends Object
implements FieldEventHandler<T>

Handle a detection event and choose what to do next.

The implementation behavior is to continue propagation when descending and to stop propagation when ascending.

Author:

Hank Grabowski

Constructor Summary

Constructors

Constructor and Description
FieldStopOnIncreasing() Empty constructor.

Method Summary

Modifier and Type	Method and Description
org.hipparchus.ode.events.Action	eventOccurred(FieldSpacecraftState<T> s, FieldEventDetector<T> detector, boolean increasing) Handle a detection event and choose what to do next.

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.handlers.FieldEventHandler

init, resetState

Constructor Detail

FieldStopOnIncreasing

public FieldStopOnIncreasing()

Empty constructor.

This constructor is not strictly necessary, but it prevents spurious javadoc warnings with JDK 18 and later.

Since:

12.0

Method Detail

eventOccurred

public org.hipparchus.ode.events.Action eventOccurred(FieldSpacecraftState<T> s,
                                                      FieldEventDetector<T> detector,
                                                      boolean increasing)

Handle a detection event and choose what to do next.

The implementation behavior is to continue propagation when descending and to stop propagation when ascending.

Specified by:

eventOccurred in interface FieldEventHandler<T extends org.hipparchus.CalculusFieldElement<T>>

Parameters:

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

detector - the detector object calling this method (not used in the evaluation)

increasing - if true, the value of the switching function increases when times increases around event

Returns:

Action.STOP or Action.CONTINUE