Package org.hipparchus.ode.events
Class FieldStepEndEventState<T extends CalculusFieldElement<T>>
java.lang.Object
org.hipparchus.ode.events.FieldStepEndEventState<T>
- Type Parameters:
T
- the type of the field elements
- All Implemented Interfaces:
FieldEventState<T>
public class FieldStepEndEventState<T extends CalculusFieldElement<T>>
extends Object
implements FieldEventState<T>
This class handles the state for one
event handler
that triggers at step end.- Since:
- 3.0
-
Constructor Summary
ConstructorDescriptionFieldStepEndEventState
(FieldODEStepEndHandler<T> handler) Simple constructor. -
Method Summary
Modifier and TypeMethodDescriptiondoEvent
(FieldODEStateAndDerivative<T> state) Notify the user's listener of the event.boolean
evaluateStep
(FieldODEStateInterpolator<T> interpolator) Evaluate the impact of the proposed step on the event handler.Get the occurrence time of the event triggered in the current step.Get the underlying step end handler.void
init
(FieldODEStateAndDerivative<T> s0, T t) Initialize handler at the start of an integration.void
setStepEnd
(T stepEnd) Set the step end.
-
Constructor Details
-
FieldStepEndEventState
Simple constructor.- Parameters:
handler
- step end handler
-
-
Method Details
-
getHandler
Get the underlying step end handler.- Returns:
- underlying step end handler
-
init
Initialize handler at the start of an integration.This method is called once at the start of the integration. It may be used by the event handler to initialize some internal data if needed.
- Specified by:
init
in interfaceFieldEventState<T extends CalculusFieldElement<T>>
- Parameters:
s0
- initial statet
- target time for the integration
-
setStepEnd
Set the step end.- Parameters:
stepEnd
- step end
-
evaluateStep
Evaluate the impact of the proposed step on the event handler.- Specified by:
evaluateStep
in interfaceFieldEventState<T extends CalculusFieldElement<T>>
- Parameters:
interpolator
- step interpolator for the proposed step- Returns:
- true if the event handler triggers an event before the end of the proposed step
-
getEventTime
Get the occurrence time of the event triggered in the current step.- Specified by:
getEventTime
in interfaceFieldEventState<T extends CalculusFieldElement<T>>
- Returns:
- occurrence time of the event triggered in the current step or infinity if no events are triggered
-
doEvent
Notify the user's listener of the event. The event occurs wholly within this method call including a call toFieldODEEventHandler.resetState(FieldODEEventDetector, FieldODEStateAndDerivative)
if necessary.- Specified by:
doEvent
in interfaceFieldEventState<T extends CalculusFieldElement<T>>
- Parameters:
state
- the state at the time of the event. This must be at the same time as the current value ofFieldEventState.getEventTime()
.- Returns:
- the user's requested action and the new state if the action is
Action.RESET_STATE
. Otherwise the new state isstate
. The stop time indicates what time propagation should stop if the action isAction.STOP
. This guarantees the integration will stop on or after the root, so that integration may be restarted safely.
-