Package org.hipparchus.ode.events
Class StepEndEventState
java.lang.Object
org.hipparchus.ode.events.StepEndEventState
- All Implemented Interfaces:
EventState
This class handles the state for one
event handler
that triggers at step end.- Since:
- 3.0
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiondoEvent
(ODEStateAndDerivative state) Notify the user's listener of the event.boolean
evaluateStep
(ODEStateInterpolator interpolator) Evaluate the impact of the proposed step on the handler.double
Get the occurrence time of the event triggered in the current step.Get the underlying step end handler.void
init
(ODEStateAndDerivative s0, double t) Initialize handler at the start of an integration.void
setStepEnd
(double stepEnd) Set the step end.
-
Constructor Details
-
StepEndEventState
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 handler to initialize some internal data if needed.
- Specified by:
init
in interfaceEventState
- Parameters:
s0
- initial statet
- target time for the integration
-
setStepEnd
public void setStepEnd(double stepEnd) Set the step end.- Parameters:
stepEnd
- step end
-
evaluateStep
Evaluate the impact of the proposed step on the handler.- Specified by:
evaluateStep
in interfaceEventState
- 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
public double getEventTime()Get the occurrence time of the event triggered in the current step.- Specified by:
getEventTime
in interfaceEventState
- 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 toODEEventHandler.resetState(ODEEventDetector, ODEStateAndDerivative)
if necessary.- Specified by:
doEvent
in interfaceEventState
- Parameters:
state
- the state at the time of the event. This must be at the same time as the current value ofEventState.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.
-