|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.math.ode.SwitchingFunctionsHandler
public class SwitchingFunctionsHandler
This class handles several switching
functions
during integration.
SwitchingFunction
Field Summary | |
---|---|
private SwitchState |
first
First active switching function. |
private java.util.ArrayList |
functions
Switching functions. |
private boolean |
initialized
Initialization indicator. |
Constructor Summary | |
---|---|
SwitchingFunctionsHandler()
Simple constructor. |
Method Summary | |
---|---|
void |
add(SwitchingFunction function,
double maxCheckInterval,
double convergence,
int maxIterationCount)
Add a switching function. |
boolean |
evaluateStep(StepInterpolator interpolator)
Evaluate the impact of the proposed step on all handled switching functions. |
double |
getEventTime()
Get the occurrence time of the first event triggered in the last evaluated step. |
boolean |
isEmpty()
Check if the handler does not have any condition. |
boolean |
reset(double t,
double[] y)
Let the switching functions reset the state if they want. |
void |
stepAccepted(double t,
double[] y)
Inform the switching functions 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 |
Field Detail |
---|
private java.util.ArrayList functions
private SwitchState first
private boolean initialized
Constructor Detail |
---|
public SwitchingFunctionsHandler()
Method Detail |
---|
public void add(SwitchingFunction function, double maxCheckInterval, double convergence, int maxIterationCount)
function
- switching functionmaxCheckInterval
- maximal time interval between switching
function 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 searchpublic 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
switching functions cannot be evaluatedpublic boolean stop()
public boolean reset(double t, double[] y)
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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |