Package org.hipparchus.ode.events

Class FieldEventOccurrence<T extends CalculusFieldElement<T>>

java.lang.Object

org.hipparchus.ode.events.FieldEventOccurrence<T>

Type Parameters:

T - the type of the field elements

public class FieldEventOccurrence<T extends CalculusFieldElement<T>>
extends Object

Class to hold the data related to an event occurrence that is needed to decide how to modify integration.

Constructor Summary

Constructors

Constructor	Description
FieldEventOccurrence(Action action, FieldODEState<T> newState, T stopTime)	Create a new occurrence of an event.

Method Summary

Modifier and Type	Method	Description
Action	getAction()	Get the user requested action.
FieldODEState<T>	getNewState()	Get the new state for a reset action.
T	getStopTime()	Get the new time for a stop action.

Methods inherited from class java.lang.Object

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

Constructor Details

FieldEventOccurrence

public FieldEventOccurrence(Action action,
 FieldODEState<T> newState,
 T stopTime)

Create a new occurrence of an event.

Parameters:

action - the user requested action.

newState - for a reset event. Should be the current state unless the action is Action.RESET_STATE.

stopTime - to stop propagation if the action is Action.STOP. Used to move the stop time to just after the root.

Method Details

getAction

public Action getAction()

Get the user requested action.

Returns:

the action.

getNewState

public FieldODEState<T> getNewState()

Get the new state for a reset action.

Returns:

the new state.

getStopTime

public T getStopTime()

Get the new time for a stop action.

Returns:

when to stop propagation.