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

public Interface FirstOrderFieldDifferentialEquations<T extends RealFieldElement<T>>

Type Parameters
<T>
the type of the field elements
Imports
org.apache.commons.math3.RealFieldElement

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
3.6
See Also
FirstOrderFieldIntegrator

Method Summary

Modifier and TypeMethod and Description
public T[]

Returns:

time derivative of the state vector
computeDerivatives
(T
current value of the independent time variable
t
,
T[]
array containing the current value of the state vector
y
)

Get the current time derivative of the state vector.

public int

Returns:

dimension of the problem
getDimension
()

Get the dimension of the problem.

public void
init(T
value of the independent time variable at integration start
t0
,
T[]
array containing the value of the state vector at integration start
y0
,
T
target time for the integration
finalTime
)

Initialize equations at the start of an ODE integration.

Method Detail

computeDerivativesback to summary
public T[] computeDerivatives(T t, T[] y)

Get the current time derivative of the state vector.

Parameters
t:T

current value of the independent time variable

y:T[]

array containing the current value of the state vector

Returns:T[]

time derivative of the state vector

getDimensionback to summary
public int getDimension()

Get the dimension of the problem.

Returns:int

dimension of the problem

initback to summary
public void init(T t0, T[] y0, T finalTime)

Initialize equations at the start of an ODE integration.

This method is called once at the start of the integration. It may be used by the equations to initialize some internal data if needed.

Parameters
t0:T

value of the independent time variable at integration start

y0:T[]

array containing the value of the state vector at integration start

finalTime:T

target time for the integration