Class AbstractIntegrator
- All Implemented Interfaces:
ODEIntegrator
- Direct Known Subclasses:
AdaptiveStepsizeIntegrator
,RungeKuttaIntegrator
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected ODEStateAndDerivative
acceptStep
(AbstractODEStateInterpolator interpolator, double tEnd) Accept a step, triggering events and step handlers.void
addEventDetector
(ODEEventDetector detector) Add an event detector to the integrator.void
addStepEndHandler
(ODEStepEndHandler handler) Add a handler for step ends to the integrator.void
addStepHandler
(ODEStepHandler 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 handlers for step ends that have been added to the integrator.void
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
Get the current signed value of the integration stepsize.protected ExpandableODE
Get the differential equations to integrate.int
Get the number of evaluations of the differential equations function.protected Incrementor
Get the evaluations counter.Get all the event detectors 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 handlers for step ends that have been added to the integrator.Get all the step handlers that have been added to the integrator.protected double
Get the current step size.Get the state at step start time ti.protected void
incrementEvaluations
(int nTimes) Increment evaluations of derivatives.protected ODEStateAndDerivative
initIntegration
(ExpandableODE eqn, ODEState s0, double t) Prepare the start of an integration.protected boolean
Check if this step is the last one.protected boolean
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.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hipparchus.ode.ODEIntegrator
integrate, integrate
-
Constructor Details
-
AbstractIntegrator
Build an instance.- Parameters:
name
- name of the method
-
-
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:
-
addEventDetector
Add an event detector to the integrator.- Specified by:
addEventDetector
in interfaceODEIntegrator
- Parameters:
detector
- event detector- See Also:
-
getEventDetectors
Get all the event detectors that have been added to the integrator.- Specified by:
getEventDetectors
in interfaceODEIntegrator
- Returns:
- an unmodifiable list of the added events detectors
- See Also:
-
clearEventDetectors
public void clearEventDetectors()Remove all the event handlers that have been added to the integrator.- Specified by:
clearEventDetectors
in interfaceODEIntegrator
- See Also:
-
addStepEndHandler
Add a handler for step ends to the integrator.The
stepEndOccurred(state, forward)
method of thehandler
will be called at each step end.- Specified by:
addStepEndHandler
in interfaceODEIntegrator
- Parameters:
handler
- handler for step ends- See Also:
-
getStepEndHandlers
Get all the handlers for step ends that have been added to the integrator.- Specified by:
getStepEndHandlers
in interfaceODEIntegrator
- Returns:
- an unmodifiable list of the added step end handlers
- See Also:
-
clearStepEndHandlers
public void clearStepEndHandlers()Remove all the handlers for step ends that have been added to the integrator.- Specified by:
clearStepEndHandlers
in interfaceODEIntegrator
- See Also:
-
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
-
initIntegration
Prepare the start of an integration.- Parameters:
eqn
- equations to integrates0
- initial state vectort
- target time for the integration- Returns:
- Initial state with computed derivatives.
-
getEquations
Get the differential equations to integrate.- Returns:
- differential equations to integrate
-
getEvaluationsCounter
Get the evaluations counter.- Returns:
- evaluations counter
-
computeDerivatives
public double[] computeDerivatives(double t, double[] y) throws MathIllegalArgumentException, MathIllegalStateException, NullPointerException 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 vector- Returns:
- state completed with derivatives
- Throws:
MathIllegalArgumentException
- 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 tointegrate
-
incrementEvaluations
protected void incrementEvaluations(int nTimes) Increment evaluations of derivatives.- Parameters:
nTimes
- number of evaluations to increment
-
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
-
acceptStep
protected ODEStateAndDerivative acceptStep(AbstractODEStateInterpolator interpolator, double tEnd) throws MathIllegalArgumentException, MathIllegalStateException Accept a step, triggering events and step handlers.- Parameters:
interpolator
- step interpolatortEnd
- final integration time- Returns:
- state at end of step
- Throws:
MathIllegalStateException
- 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 settings
-
sanityChecks
Check the integration span.- Parameters:
initialState
- initial statet
- target time for the integration- Throws:
MathIllegalArgumentException
- if integration span is too smallMathIllegalArgumentException
- if adaptive step size integrators tolerance arrays dimensions are not compatible with equations settings
-
resetOccurred
protected boolean resetOccurred()Check if a reset occurred while last step was accepted.- Returns:
- true if a reset occurred while last step was accepted
-
setStepSize
protected void setStepSize(double stepSize) Set the current step size.- Parameters:
stepSize
- step size to set
-
getStepSize
protected double getStepSize()Get the current step size.- Returns:
- current step size
-
setStepStart
Set current step start.- Parameters:
stepStart
- step start
-
getStepStart
Get the state at 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:
getStepStart
in interfaceODEIntegrator
- Returns:
- state at step start time ti
-
setIsLastStep
protected void setIsLastStep(boolean isLastStep) Set the last state flag.- Parameters:
isLastStep
- if true, this step is the last one
-
isLastStep
protected boolean isLastStep()Check if this step is the last one.- Returns:
- true if this step is the last one
-