Class CombinedEventsManager
java.lang.Object
org.apache.commons.math.ode.events.CombinedEventsManager
Deprecated.
as of 2.2, this class is not used anymore
This class manages several
event handlers
during integration.- Since:
- 1.2
- Version:
- $Revision: 1073158 $ $Date: 2011-02-21 22:46:52 +0100 (lun. 21 févr. 2011) $
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addEventHandler
(EventHandler handler, double maxCheckInterval, double convergence, int maxIterationCount) Deprecated.Add an events handler.void
Deprecated.Remove all the events handlers that have been added to the manager.boolean
evaluateStep
(StepInterpolator interpolator) Deprecated.Evaluate the impact of the proposed step on all managed event handlers.Deprecated.Get all the events handlers that have been added to the manager.Deprecated.Get all the events state wrapping the handlers that have been added to the manager.double
Deprecated.Get the occurrence time of the first event triggered in the last evaluated step.boolean
isEmpty()
Deprecated.Check if the manager does not manage any event handlers.boolean
reset
(double t, double[] y) Deprecated.Let the event handlers reset the state if they want.void
stepAccepted
(double t, double[] y) Deprecated.Inform the event handlers that the step has been accepted by the integrator.boolean
stop()
Deprecated.Check if the integration should be stopped at the end of the current step.
-
Constructor Details
-
CombinedEventsManager
public CombinedEventsManager()Deprecated.Simple constructor. Create an empty manager
-
-
Method Details
-
addEventHandler
public void addEventHandler(EventHandler handler, double maxCheckInterval, double convergence, int maxIterationCount) Deprecated.Add an events handler.- Parameters:
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 search- See Also:
-
getEventsHandlers
Deprecated.Get all the events handlers that have been added to the manager.- Returns:
- an unmodifiable collection of the added event handlers
- See Also:
-
clearEventsHandlers
public void clearEventsHandlers()Deprecated.Remove all the events handlers that have been added to the manager.- See Also:
-
getEventsStates
Deprecated.Get all the events state wrapping the handlers that have been added to the manager.- Returns:
- a collection of the events states
- See Also:
-
isEmpty
public boolean isEmpty()Deprecated.Check if the manager does not manage any event handlers.- Returns:
- true if manager is empty
-
evaluateStep
public boolean evaluateStep(StepInterpolator interpolator) throws DerivativeException, IntegratorException Deprecated.Evaluate the impact of the proposed step on all managed event handlers.- Parameters:
interpolator
- step interpolator for the proposed step- Returns:
- true if at least one event handler triggers an event before the end of the proposed step (this implies the step should be rejected)
- Throws:
DerivativeException
- if the interpolator fails to compute the function somewhere within the stepIntegratorException
- if an event cannot be located
-
getEventTime
public double getEventTime()Deprecated.Get the occurrence time of the first event triggered in the last evaluated step.- Returns:
- occurrence time of the first event triggered in the last evaluated step, or Double.NaN if no event is triggered
-
stepAccepted
Deprecated.Inform the event handlers that the step has been accepted by the integrator.- Parameters:
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- Throws:
IntegratorException
- if the value of one of the events states cannot be evaluated
-
stop
public boolean stop()Deprecated.Check if the integration should be stopped at the end of the current step.- Returns:
- true if the integration should be stopped
-
reset
Deprecated.Let the event handlers reset the state if they want.- Parameters:
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- Returns:
- true if the integrator should reset the derivatives too
- Throws:
IntegratorException
- if one of the events states that should reset the state fails to do it
-