|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FirstOrderIntegrator
This interface represents a first order integrator for differential equations.
The classes which are devoted to solve first order differential
equations should implement this interface. The problems which can
be handled should implement the FirstOrderDifferentialEquations
interface.
FirstOrderDifferentialEquations
,
StepHandler
,
SwitchingFunction
Method Summary | |
---|---|
void |
addSwitchingFunction(SwitchingFunction function,
double maxCheckInterval,
double convergence,
int maxIterationCount)
Add a switching function to the integrator. |
double |
getCurrentSignedStepsize()
Get the current signed value of the integration stepsize. |
double |
getCurrentStepStart()
Get the current value of the step start time ti. |
java.lang.String |
getName()
Get the name of the method. |
StepHandler |
getStepHandler()
Get the step handler for this integrator. |
void |
integrate(FirstOrderDifferentialEquations equations,
double t0,
double[] y0,
double t,
double[] y)
Integrate the differential equations up to the given time. |
void |
setStepHandler(StepHandler handler)
Set the step handler for this integrator. |
Method Detail |
---|
java.lang.String getName()
void setStepHandler(StepHandler handler)
handler
- handler for the accepted stepsStepHandler getStepHandler()
void addSwitchingFunction(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 searchvoid integrate(FirstOrderDifferentialEquations equations, double t0, double[] y0, double t, double[] y) throws DerivativeException, IntegratorException
This method solves an Initial Value Problem (IVP).
Since this method stores some internal state variables made
available in its public interface during integration (getCurrentSignedStepsize()
), it is not thread-safe.
equations
- differential equations to integratet0
- initial timey0
- initial value of the state vector at t0t
- target time for the integration
(can be set to a value smaller than t0
for backward integration)y
- placeholder where to put the state vector at each successful
step (and hence at the end of integration), can be the same object as y0
IntegratorException
- if the integrator cannot perform integration
DerivativeException
- this exception is propagated to the caller if
the underlying user function triggers onedouble 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(org.apache.commons.math.ode.FirstOrderDifferentialEquations, double, double[], double, double[])
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(org.apache.commons.math.ode.FirstOrderDifferentialEquations, double, double[], double, double[])
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |