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

public Interface FirstOrderDifferentialEquations

Known Direct Subinterfaces
org.apache.commons.math3.ode.MainStateJacobianProvider
Known Direct Implementers
org.apache.commons.math3.ode.FirstOrderConverter
Imports
org.apache.commons.math3.exception.DimensionMismatchException, .MaxCountExceededException

This interface represents a first order differential equations set.

This interface should be implemented by all real first order differential equation problems before they can be handled by the integrators FirstOrderIntegrator#integrate method.

A first order differential equations problem, as seen by an integrator is the time derivative dY/dt of a state vector Y, both being one dimensional arrays. From the integrator point of view, this derivative depends only on the current time t and on the state vector Y.

For real problems, the derivative depends also on parameters that do not belong to the state vector (dynamical model constants for example). These constants are completely outside of the scope of this interface, the classes that implement it are allowed to handle them as they want.

Since
1.2
See Also
FirstOrderIntegrator, FirstOrderConverter, SecondOrderDifferentialEquations

Method Summary

Modifier and TypeMethod and Description
public void
computeDerivatives(double
current value of the independent time variable
t
,
double[]
array containing the current value of the state vector
y
,
double[]
placeholder array where to put the time derivative of the state vector
yDot
)

Get the current time derivative of the state vector.

public int

Returns:

dimension of the problem
getDimension
()

Get the dimension of the problem.

Method Detail

computeDerivativesback to summary
public void computeDerivatives(double t, double[] y, double[] yDot) throws MaxCountExceededException, DimensionMismatchException

Get the current time derivative of the state vector.

Parameters
t:double

current value of the independent time variable

y:double[]

array containing the current value of the state vector

yDot:double[]

placeholder array where to put the time derivative of the state vector

Exceptions
MaxCountExceededException:
if the number of functions evaluations is exceeded
DimensionMismatchException:
if arrays dimensions do not match equations settings
getDimensionback to summary
public int getDimension()

Get the dimension of the problem.

Returns:int

dimension of the problem