ODEIntegrator
AdaptiveStepsizeIntegrator
, RungeKuttaIntegrator
public abstract class AbstractIntegrator extends Object implements ODEIntegrator
Modifier | Constructor | Description |
---|---|---|
protected |
AbstractIntegrator(String name) |
Build an instance.
|
Modifier and Type | Method | Description |
---|---|---|
protected ODEStateAndDerivative |
acceptStep(AbstractODEStateInterpolator interpolator,
double tEnd) |
Accept a step, triggering events and step handlers.
|
void |
addEventHandler(ODEEventHandler handler,
double maxCheckInterval,
double convergence,
int maxIterationCount) |
Add an event handler to the integrator.
|
void |
addEventHandler(ODEEventHandler handler,
double maxCheckInterval,
double convergence,
int maxIterationCount,
BracketedUnivariateSolver<UnivariateFunction> solver) |
Add an event handler to the integrator.
|
void |
addStepHandler(ODEStepHandler 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.
|
double[] |
computeDerivatives(double t,
double[] y) |
Compute the derivatives and check the number of evaluations.
|
double |
getCurrentSignedStepsize() |
Get the current signed value of the integration stepsize.
|
double |
getCurrentStepStart() |
Deprecated.
|
protected ExpandableODE |
getEquations() |
Get the differential equations to integrate.
|
int |
getEvaluations() |
Get the number of evaluations of the differential equations function.
|
protected Incrementor |
getEvaluationsCounter() |
Get the evaluations counter.
|
Collection<ODEEventHandler> |
getEventHandlers() |
Get all the event handlers that have been added to the integrator.
|
int |
getMaxEvaluations() |
Get the maximal number of functions evaluations.
|
String |
getName() |
Get the name of the method.
|
Collection<ODEStepHandler> |
getStepHandlers() |
Get all the step handlers that have been added to the integrator.
|
protected double |
getStepSize() |
Get the current step size.
|
ODEStateAndDerivative |
getStepStart() |
Get the state at step start time ti.
|
protected ODEStateAndDerivative |
initIntegration(ExpandableODE eqn,
ODEState s0,
double t) |
Prepare the start of an integration.
|
protected boolean |
isLastStep() |
Check if this step is the last one.
|
protected boolean |
resetOccurred() |
Check if a reset occurred while last step was accepted.
|
protected void |
sanityChecks(ODEState initialState,
double t) |
Check the integration span.
|
protected void |
setIsLastStep(boolean isLastStep) |
Set the last state flag.
|
void |
setMaxEvaluations(int maxEvaluations) |
Set the maximal number of differential equations function evaluations.
|
protected void |
setStateInitialized(boolean stateInitialized) |
Set the stateInitialized flag.
|
protected void |
setStepSize(double stepSize) |
Set the current step size.
|
protected void |
setStepStart(ODEStateAndDerivative stepStart) |
Set current step start.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
integrate, integrate, integrate
protected AbstractIntegrator(String name)
name
- name of the methodpublic String getName()
getName
in interface ODEIntegrator
public void addStepHandler(ODEStepHandler 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 Collection<ODEStepHandler> getStepHandlers()
getStepHandlers
in interface ODEIntegrator
ODEIntegrator.addStepHandler(ODEStepHandler)
,
ODEIntegrator.clearStepHandlers()
public void clearStepHandlers()
clearStepHandlers
in interface ODEIntegrator
ODEIntegrator.addStepHandler(ODEStepHandler)
,
ODEIntegrator.getStepHandlers()
public void addEventHandler(ODEEventHandler handler, double maxCheckInterval, double convergence, int maxIterationCount)
Uses a default UnivariateSolver
with an absolute accuracy equal to the
given convergence threshold, as root-finding algorithm to detect the state events.
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 search. Must be
smaller than maxCheckInterval
and should be small
compared to time scale of the ODE dynamics.maxIterationCount
- upper limit of the iteration count in the event time
searchODEIntegrator.getEventHandlers()
,
ODEIntegrator.clearEventHandlers()
public void addEventHandler(ODEEventHandler handler, double maxCheckInterval, double convergence, int maxIterationCount, BracketedUnivariateSolver<UnivariateFunction> solver)
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 search. Must be
smaller than maxCheckInterval
and should be small
compared to time scale of the ODE dynamics.maxIterationCount
- upper limit of the iteration count in the event time
searchsolver
- The root-finding algorithm to use to detect the state
events.ODEIntegrator.getEventHandlers()
,
ODEIntegrator.clearEventHandlers()
public Collection<ODEEventHandler> getEventHandlers()
getEventHandlers
in interface ODEIntegrator
ODEIntegrator.addEventHandler(ODEEventHandler, double, double, int)
,
ODEIntegrator.clearEventHandlers()
public void clearEventHandlers()
clearEventHandlers
in interface ODEIntegrator
ODEIntegrator.addEventHandler(ODEEventHandler, double, double, int)
,
ODEIntegrator.getEventHandlers()
@Deprecated 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 ODEStateAndDerivative initIntegration(ExpandableODE eqn, ODEState s0, double t)
eqn
- equations to integrates0
- initial state vectort
- target time for the integrationprotected ExpandableODE getEquations()
protected Incrementor getEvaluationsCounter()
public double[] computeDerivatives(double t, double[] y) throws MathIllegalArgumentException, MathIllegalStateException, NullPointerException
t
- current value of the independent time variabley
- array containing the current value of the state vectorMathIllegalArgumentException
- if arrays dimensions do not match equations settingsMathIllegalStateException
- if the number of functions evaluations is exceededNullPointerException
- if the ODE equations have not been set (i.e. if this method
is called outside of a call to integrate
protected 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 ODEStateAndDerivative acceptStep(AbstractODEStateInterpolator interpolator, double tEnd) throws MathIllegalArgumentException, MathIllegalStateException
interpolator
- step interpolatortEnd
- final integration timeMathIllegalStateException
- if the interpolator throws one because
the number of functions evaluations is exceededMathIllegalArgumentException
- if the location of an event cannot be bracketedMathIllegalArgumentException
- if arrays dimensions do not match equations settingsprotected void sanityChecks(ODEState initialState, double t) throws MathIllegalArgumentException
initialState
- initial statet
- target time for the integrationMathIllegalArgumentException
- if integration span is too smallMathIllegalArgumentException
- if adaptive step size integrators
tolerance arrays dimensions are not compatible with equations settingsprotected boolean resetOccurred()
protected void setStepSize(double stepSize)
stepSize
- step size to setprotected double getStepSize()
protected void setStepStart(ODEStateAndDerivative stepStart)
stepStart
- step startpublic ODEStateAndDerivative getStepStart()
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
.
getStepStart
in interface ODEIntegrator
protected void setIsLastStep(boolean isLastStep)
isLastStep
- if true, this step is the last oneprotected boolean isLastStep()
Copyright © 2016–2018 Hipparchus.org. All rights reserved.