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

Constructors

Constructor	Description
FieldStepEndEventState(FieldODEStepEndHandler<T> handler)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
FieldEventOccurrence<T>	doEvent(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.
T	getEventTime()	Get the occurrence time of the event triggered in the current step.
FieldODEStepEndHandler<T>	getHandler()	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FieldStepEndEventState

public FieldStepEndEventState(FieldODEStepEndHandler<T> handler)

Simple constructor.

Parameters:

handler - step end handler

Method Detail

getHandler

public FieldODEStepEndHandler<T> getHandler()

Get the underlying step end handler.

Returns:

underlying step end handler

init

public void init(FieldODEStateAndDerivative<T> s0,
                 T t)

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 interface FieldEventState<T extends CalculusFieldElement<T>>

Parameters:

s0 - initial state

t - target time for the integration

setStepEnd

public void setStepEnd(T stepEnd)

Set the step end.

Parameters:

stepEnd - step end

evaluateStep

public boolean evaluateStep(FieldODEStateInterpolator<T> interpolator)

Evaluate the impact of the proposed step on the event handler.

Specified by:

evaluateStep in interface FieldEventState<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

public T getEventTime()

Get the occurrence time of the event triggered in the current step.

Specified by:

getEventTime in interface FieldEventState<T extends CalculusFieldElement<T>>

Returns:

occurrence time of the event triggered in the current step or infinity if no events are triggered

doEvent

public FieldEventOccurrence<T> doEvent(FieldODEStateAndDerivative<T> state)

Notify the user's listener of the event. The event occurs wholly within this method call including a call to FieldODEEventHandler.resetState(FieldODEEventDetector, FieldODEStateAndDerivative) if necessary.

Specified by:

doEvent in interface FieldEventState<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 of FieldEventState.getEventTime().

Returns:

the user's requested action and the new state if the action is Action.RESET_STATE. Otherwise the new state is state. The stop time indicates what time propagation should stop if the action is Action.STOP. This guarantees the integration will stop on or after the root, so that integration may be restarted safely.