Class AbstractIntegrator
- All Implemented Interfaces:
FirstOrderIntegrator
,ODEIntegrator
- Direct Known Subclasses:
AdaptiveStepsizeIntegrator
,RungeKuttaIntegrator
- Since:
- 2.0
- Version:
- $Revision: 1073267 $ $Date: 2011-02-22 10:06:20 +0100 (mar. 22 févr. 2011) $
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
Indicator for last step.protected boolean
Indicator that a state or derivative reset was triggered by some event.protected Collection
<StepHandler> Step handler.protected double
Current stepsize.protected double
Current step start time. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Build an instance with a null name.AbstractIntegrator
(String name) Build an instance. -
Method Summary
Modifier and TypeMethodDescriptionprotected double
acceptStep
(AbstractStepInterpolator interpolator, double[] y, double[] yDot, double tEnd) Accept a step, triggering events and step handlers.protected CombinedEventsManager
addEndTimeChecker
(double startTime, double endTime, CombinedEventsManager manager) Deprecated.as of 2.2, this method is not used any morevoid
addEventHandler
(EventHandler handler, double maxCheckInterval, double convergence, int maxIterationCount) Add an event handler to the integrator.void
addStepHandler
(StepHandler handler) Add a step handler to this integrator.void
Remove all the event handlers that have been added to the integrator.void
Remove all the step handlers that have been added to the integrator.void
computeDerivatives
(double t, double[] y, double[] yDot) Compute the derivatives and check the number of evaluations.double
Get the current signed value of the integration stepsize.double
Get the current value of the step start time ti.int
Get the number of evaluations of the differential equations function.Get all the event handlers that have been added to the integrator.int
Get the maximal number of functions evaluations.getName()
Get the name of the method.Get all the step handlers that have been added to the integrator.protected boolean
Check if dense output is needed.protected void
Reset the number of evaluations to zero.protected void
sanityChecks
(FirstOrderDifferentialEquations ode, double t0, double[] y0, double t, double[] y) Perform some sanity checks on the integration parameters.protected void
setEquations
(FirstOrderDifferentialEquations equations) Set the differential equations.void
setMaxEvaluations
(int maxEvaluations) Set the maximal number of differential equations function evaluations.protected void
setStateInitialized
(boolean stateInitialized) Set the stateInitialized flag.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.commons.math.ode.FirstOrderIntegrator
integrate
-
Field Details
-
stepHandlers
Step handler. -
stepStart
protected double stepStartCurrent step start time. -
stepSize
protected double stepSizeCurrent stepsize. -
isLastStep
protected boolean isLastStepIndicator for last step. -
resetOccurred
protected boolean resetOccurredIndicator that a state or derivative reset was triggered by some event.
-
-
Constructor Details
-
AbstractIntegrator
Build an instance.- Parameters:
name
- name of the method
-
AbstractIntegrator
protected AbstractIntegrator()Build an instance with a null name.
-
-
Method Details
-
getName
Get the name of the method.- Specified by:
getName
in interfaceODEIntegrator
- Returns:
- name of the method
-
addStepHandler
Add a step handler to this integrator.The handler will be called by the integrator for each accepted step.
- Specified by:
addStepHandler
in interfaceODEIntegrator
- Parameters:
handler
- handler for the accepted steps- See Also:
-
getStepHandlers
Get all the step handlers that have been added to the integrator.- Specified by:
getStepHandlers
in interfaceODEIntegrator
- Returns:
- an unmodifiable collection of the added events handlers
- See Also:
-
clearStepHandlers
public void clearStepHandlers()Remove all the step handlers that have been added to the integrator.- Specified by:
clearStepHandlers
in interfaceODEIntegrator
- See Also:
-
addEventHandler
public void addEventHandler(EventHandler handler, double maxCheckInterval, double convergence, int maxIterationCount) Add an event handler to the integrator.- Specified by:
addEventHandler
in interfaceODEIntegrator
- Parameters:
handler
- event handlermaxCheckInterval
- 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 search- See Also:
-
getEventHandlers
Get all the event handlers that have been added to the integrator.- Specified by:
getEventHandlers
in interfaceODEIntegrator
- Returns:
- an unmodifiable collection of the added events handlers
- See Also:
-
clearEventHandlers
public void clearEventHandlers()Remove all the event handlers that have been added to the integrator.- Specified by:
clearEventHandlers
in interfaceODEIntegrator
- See Also:
-
requiresDenseOutput
protected boolean requiresDenseOutput()Check if dense output is needed.- Returns:
- true if there is at least one event handler or if one of the step handlers requires dense output
-
getCurrentStepStart
public double getCurrentStepStart()Get the current value of the step start time ti.This method can be called during integration (typically by the object implementing the
differential equations
problem) if the value of the current step that is attempted is needed.The result is undefined if the method is called outside of calls to
integrate
.- Specified by:
getCurrentStepStart
in interfaceODEIntegrator
- Returns:
- current value of the step start time ti
-
getCurrentSignedStepsize
public double getCurrentSignedStepsize()Get the current signed value of the integration stepsize.This method can be called during integration (typically by the object implementing the
differential equations
problem) if the signed value of the current stepsize that is tried is needed.The result is undefined if the method is called outside of calls to
integrate
.- Specified by:
getCurrentSignedStepsize
in interfaceODEIntegrator
- Returns:
- current signed value of the stepsize
-
setMaxEvaluations
public void setMaxEvaluations(int maxEvaluations) Set the maximal number of differential equations function evaluations.The purpose of this method is to avoid infinite loops which can occur for example when stringent error constraints are set or when lots of discrete events are triggered, thus leading to many rejected steps.
- Specified by:
setMaxEvaluations
in interfaceODEIntegrator
- Parameters:
maxEvaluations
- maximal number of function evaluations (negative values are silently converted to maximal integer value, thus representing almost unlimited evaluations)
-
getMaxEvaluations
public int getMaxEvaluations()Get the maximal number of functions evaluations.- Specified by:
getMaxEvaluations
in interfaceODEIntegrator
- Returns:
- maximal number of functions evaluations
-
getEvaluations
public int getEvaluations()Get the number of evaluations of the differential equations function.The number of evaluations corresponds to the last call to the
integrate
method. It is 0 if the method has not been called yet.- Specified by:
getEvaluations
in interfaceODEIntegrator
- Returns:
- number of evaluations of the differential equations function
-
resetEvaluations
protected void resetEvaluations()Reset the number of evaluations to zero. -
setEquations
Set the differential equations.- Parameters:
equations
- differential equations to integrate- See Also:
-
computeDerivatives
Compute the derivatives and check the number of evaluations.- Parameters:
t
- current value of the independent time variabley
- array containing the current value of the state vectoryDot
- placeholder array where to put the time derivative of the state vector- Throws:
DerivativeException
- this user-defined exception should be used if an error is is triggered by user code
-
setStateInitialized
protected void setStateInitialized(boolean stateInitialized) Set the stateInitialized flag.This method must be called by integrators with the value
false
before they start integration, so a proper lazy initialization is done automatically on the first step.- Parameters:
stateInitialized
- new value for the flag- Since:
- 2.2
-
acceptStep
protected double acceptStep(AbstractStepInterpolator interpolator, double[] y, double[] yDot, double tEnd) throws DerivativeException, IntegratorException Accept a step, triggering events and step handlers.- Parameters:
interpolator
- step interpolatory
- state vector at step end time, must be reset if an event asks for resetting or if an events stops integration during the stepyDot
- placeholder array where to put the time derivative of the state vectortEnd
- final integration time- Returns:
- time at end of step
- Throws:
DerivativeException
- this exception is propagated to the caller if the underlying user function triggers oneIntegratorException
- if the value of one event state cannot be evaluated- Since:
- 2.2
-
sanityChecks
protected void sanityChecks(FirstOrderDifferentialEquations ode, double t0, double[] y0, double t, double[] y) throws IntegratorException Perform some sanity checks on the integration parameters.- Parameters:
ode
- differential equations sett0
- start timey0
- state vector at t0t
- target time for the integrationy
- placeholder where to put the state vector- Throws:
IntegratorException
- if some inconsistency is detected
-
addEndTimeChecker
@Deprecated protected CombinedEventsManager addEndTimeChecker(double startTime, double endTime, CombinedEventsManager manager) Deprecated.as of 2.2, this method is not used any moreAdd an event handler for end time checking.This method can be used to simplify handling of integration end time. It leverages the nominal stop condition with the exceptional stop conditions.
- Parameters:
startTime
- integration start timeendTime
- desired end timemanager
- manager containing the user-defined handlers- Returns:
- a new manager containing all the user-defined handlers plus a dedicated manager triggering a stop event at entTime
-