public abstract class AbstractIntegrator extends java.lang.Object implements FirstOrderIntegrator
Modifier and Type | Class and Description |
---|---|
private static class |
AbstractIntegrator.EndTimeChecker
Deprecated.
as of 2.2, this class is not used anymore
|
Modifier and Type | Field and Description |
---|---|
private FirstOrderDifferentialEquations |
equations
Differential equations to integrate.
|
private int |
evaluations
Number of evaluations already performed.
|
private java.util.Collection<EventState> |
eventsStates
Events states.
|
protected boolean |
isLastStep
Indicator for last step.
|
private int |
maxEvaluations
Maximal number of evaluations allowed.
|
private java.lang.String |
name
Name of the method.
|
protected boolean |
resetOccurred
Indicator that a state or derivative reset was triggered by some event.
|
private boolean |
statesInitialized
Initialization indicator of events states.
|
protected java.util.Collection<StepHandler> |
stepHandlers
Step handler.
|
protected double |
stepSize
Current stepsize.
|
protected double |
stepStart
Current step start time.
|
Modifier | Constructor and Description |
---|---|
protected |
AbstractIntegrator()
Build an instance with a null name.
|
|
AbstractIntegrator(java.lang.String name)
Build an instance.
|
Modifier and Type | Method and Description |
---|---|
protected 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 more
|
void |
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 |
clearEventHandlers()
Remove all the event handlers that have been added to the integrator.
|
void |
clearStepHandlers()
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 |
getCurrentSignedStepsize()
Get the current signed value of the integration stepsize.
|
double |
getCurrentStepStart()
Get the current value of the step start time ti.
|
int |
getEvaluations()
Get the number of evaluations of the differential equations function.
|
java.util.Collection<EventHandler> |
getEventHandlers()
Get all the event handlers that have been added to the integrator.
|
int |
getMaxEvaluations()
Get the maximal number of functions evaluations.
|
java.lang.String |
getName()
Get the name of the method.
|
java.util.Collection<StepHandler> |
getStepHandlers()
Get all the step handlers that have been added to the integrator.
|
protected boolean |
requiresDenseOutput()
Check if dense output is needed.
|
protected void |
resetEvaluations()
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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
integrate
protected java.util.Collection<StepHandler> stepHandlers
protected double stepStart
protected double stepSize
protected boolean isLastStep
protected boolean resetOccurred
private java.util.Collection<EventState> eventsStates
private boolean statesInitialized
private final java.lang.String name
private int maxEvaluations
private int evaluations
private transient FirstOrderDifferentialEquations equations
public AbstractIntegrator(java.lang.String name)
name
- name of the methodprotected AbstractIntegrator()
public java.lang.String getName()
getName
in interface ODEIntegrator
public void addStepHandler(StepHandler handler)
The handler will be called by the integrator for each accepted step.
addStepHandler
in interface ODEIntegrator
handler
- handler for the accepted stepsODEIntegrator.getStepHandlers()
,
ODEIntegrator.clearStepHandlers()
public java.util.Collection<StepHandler> getStepHandlers()
getStepHandlers
in interface ODEIntegrator
ODEIntegrator.addStepHandler(StepHandler)
,
ODEIntegrator.clearStepHandlers()
public void clearStepHandlers()
clearStepHandlers
in interface ODEIntegrator
ODEIntegrator.addStepHandler(StepHandler)
,
ODEIntegrator.getStepHandlers()
public void addEventHandler(EventHandler handler, double maxCheckInterval, double convergence, int maxIterationCount)
addEventHandler
in interface ODEIntegrator
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 searchODEIntegrator.getEventHandlers()
,
ODEIntegrator.clearEventHandlers()
public java.util.Collection<EventHandler> getEventHandlers()
getEventHandlers
in interface ODEIntegrator
ODEIntegrator.addEventHandler(EventHandler, double, double, int)
,
ODEIntegrator.clearEventHandlers()
public void clearEventHandlers()
clearEventHandlers
in interface ODEIntegrator
ODEIntegrator.addEventHandler(EventHandler, double, double, int)
,
ODEIntegrator.getEventHandlers()
protected boolean requiresDenseOutput()
public double getCurrentStepStart()
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
.
getCurrentStepStart
in interface ODEIntegrator
public double getCurrentSignedStepsize()
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
.
getCurrentSignedStepsize
in interface ODEIntegrator
public void setMaxEvaluations(int maxEvaluations)
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.
setMaxEvaluations
in interface ODEIntegrator
maxEvaluations
- maximal number of function evaluations (negative
values are silently converted to maximal integer value, thus representing
almost unlimited evaluations)public int getMaxEvaluations()
getMaxEvaluations
in interface ODEIntegrator
public int getEvaluations()
The number of evaluations corresponds to the last call to the
integrate
method. It is 0 if the method has not been called yet.
getEvaluations
in interface ODEIntegrator
protected void resetEvaluations()
protected void setEquations(FirstOrderDifferentialEquations equations)
equations
- differential equations to integratecomputeDerivatives(double, double[], double[])
public void computeDerivatives(double t, double[] y, double[] yDot) throws DerivativeException
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 vectorDerivativeException
- this user-defined exception should be used if an error is
is triggered by user codeprotected void setStateInitialized(boolean stateInitialized)
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.
stateInitialized
- new value for the flagprotected double acceptStep(AbstractStepInterpolator interpolator, double[] y, double[] yDot, double tEnd) throws DerivativeException, IntegratorException
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 timeDerivativeException
- this exception is propagated to the caller if
the underlying user function triggers oneIntegratorException
- if the value of one event state cannot be evaluatedprotected void sanityChecks(FirstOrderDifferentialEquations ode, double t0, double[] y0, double t, double[] y) throws IntegratorException
ode
- differential equations sett0
- start timey0
- state vector at t0t
- target time for the integrationy
- placeholder where to put the state vectorIntegratorException
- if some inconsistency is detected@Deprecated protected CombinedEventsManager addEndTimeChecker(double startTime, double endTime, CombinedEventsManager manager)
This method can be used to simplify handling of integration end time. It leverages the nominal stop condition with the exceptional stop conditions.
startTime
- integration start timeendTime
- desired end timemanager
- manager containing the user-defined handlersCopyright (c) 2003-2016 Apache Software Foundation