Top Description Methods
org.apache.commons.math3.ode

public Interface FirstOrderIntegrator

extends ODEIntegrator
Known Direct Implementers
org.apache.commons.math3.ode.AbstractIntegrator
Imports
org.apache.commons.math3.exception.DimensionMismatchException, .MaxCountExceededException, .NoBracketingException, .NumberIsTooSmallException
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.

Since
1.2
See Also
FirstOrderDifferentialEquations, org.apache.commons.math3.ode.sampling.StepHandler, org.apache.commons.math3.ode.events.EventHandler

Method Summary

Modifier and TypeMethod and Description
public double

Returns:

stop time, will be the same as target time if integration reached its target, but may be different if some org.apache.commons.math3.ode.events.EventHandler stops it at some point.
integrate(FirstOrderDifferentialEquations
differential equations to integrate
equations, double
initial time
t0, double[]
initial value of the state vector at t0
y0, double
target time for the integration (can be set to a value smaller than t0 for backward integration)
t, double[]
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
y)

Integrate the differential equations up to the given time.

Inherited from org.apache.commons.math3.ode.ODEIntegrator:
addEventHandleraddEventHandleraddStepHandlerclearEventHandlersclearStepHandlersgetCurrentSignedStepsizegetCurrentStepStartgetEvaluationsgetEventHandlersgetMaxEvaluationsgetNamegetStepHandlerssetMaxEvaluations

Method Detail

integrateback to summary
public double integrate(FirstOrderDifferentialEquations equations, double t0, double[] y0, double t, double[] y) throws DimensionMismatchException, NumberIsTooSmallException, MaxCountExceededException, NoBracketingException

Integrate the differential equations up to the given time.

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.

Parameters
equations:FirstOrderDifferentialEquations

differential equations to integrate

t0:double

initial time

y0:double[]

initial value of the state vector at t0

t:double

target time for the integration (can be set to a value smaller than t0 for backward integration)

y:double[]

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

Returns:double

stop time, will be the same as target time if integration reached its target, but may be different if some org.apache.commons.math3.ode.events.EventHandler stops it at some point.

Exceptions
DimensionMismatchException:
if arrays dimension do not match equations settings
NumberIsTooSmallException:
if integration step is too small
MaxCountExceededException:
if the number of functions evaluations is exceeded
NoBracketingException:
if the location of an event cannot be bracketed