|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.math.ode.events.CombinedEventsManager
public class CombinedEventsManager
This class manages several event handlers
during integration.
EventHandler
,
EventState
Constructor Summary | |
---|---|
CombinedEventsManager()
Simple constructor. |
Method Summary | |
---|---|
void |
addEventHandler(EventHandler handler,
double maxCheckInterval,
double convergence,
int maxIterationCount)
Add an events handler. |
void |
clearEventsHandlers()
Remove all the events handlers that have been added to the manager. |
boolean |
evaluateStep(StepInterpolator interpolator)
Evaluate the impact of the proposed step on all managed event handlers. |
Collection<EventHandler> |
getEventsHandlers()
Get all the events handlers that have been added to the manager. |
Collection<EventState> |
getEventsStates()
Get all the events state wrapping the handlers that have been added to the manager. |
double |
getEventTime()
Get the occurrence time of the first event triggered in the last evaluated step. |
boolean |
isEmpty()
Check if the manager does not manage any event handlers. |
boolean |
reset(double t,
double[] y)
Let the event handlers reset the state if they want. |
void |
stepAccepted(double t,
double[] y)
Inform the event handlers that the step has been accepted by the integrator. |
boolean |
stop()
Check if the integration should be stopped at the end of the current step. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CombinedEventsManager()
Method Detail |
---|
public void addEventHandler(EventHandler handler, double maxCheckInterval, double convergence, int maxIterationCount)
handler
- event handlermaxCheckInterval
- maximal time interval between events
checks (this interval prevents missing sign changes in
case the integration steps becomes very large)convergence
- convergence threshold in the event time searchmaxIterationCount
- upper limit of the iteration count in
the event time searchgetEventsHandlers()
,
clearEventsHandlers()
public Collection<EventHandler> getEventsHandlers()
addEventHandler(EventHandler, double, double, int)
,
clearEventsHandlers()
,
getEventsStates()
public void clearEventsHandlers()
addEventHandler(EventHandler, double, double, int)
,
getEventsHandlers()
public Collection<EventState> getEventsStates()
getEventsHandlers()
public boolean isEmpty()
public boolean evaluateStep(StepInterpolator interpolator) throws DerivativeException, IntegratorException
interpolator
- step interpolator for the proposed step
DerivativeException
- if the interpolator fails to
compute the function somewhere within the step
IntegratorException
- if an event cannot be locatedpublic double getEventTime()
public void stepAccepted(double t, double[] y) throws IntegratorException
t
- value of the independent time variable at the
end of the stepy
- array containing the current value of the state vector
at the end of the step
IntegratorException
- if the value of one of the
events states cannot be evaluatedpublic boolean stop()
public boolean reset(double t, double[] y) throws IntegratorException
t
- value of the independent time variable at the
beginning of the next stepy
- array were to put the desired state vector at the beginning
of the next step
IntegratorException
- if one of the events states
that should reset the state fails to do it
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |