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

public Class FieldODEStateAndDerivative<T extends RealFieldElement<T>>

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

Container for time, main and secondary state vectors as well as their derivatives.
Since
3.6
See Also
FirstOrderFieldDifferentialEquations, FieldSecondaryEquations, FirstOrderFieldIntegrator

Field Summary

Modifier and TypeField and Description
private final T[]
derivative

Derivative of the main state at time.

private final T[][]
secondaryDerivative

Derivative of the secondary state at time.

Constructor Summary

AccessConstructor and Description
public
FieldODEStateAndDerivative(T
time
time
,
T[]
state at time
state
,
T[]
derivative of the state at time
derivative
)

Simple constructor.

public
FieldODEStateAndDerivative(T
time
time
,
T[]
state at time
state
,
T[]
derivative of the state at time
derivative
,
T[][]
state at time (may be null)
secondaryState
,
T[][]
derivative of the state at time (may be null)
secondaryDerivative
)

Simple constructor.

Method Summary

Modifier and TypeMethod and Description
public T[]

Returns:

derivative of the main state at time
getDerivative
()

Get derivative of the main state at time.

public T[]

Returns:

derivative of the secondary state at time
getSecondaryDerivative
(final int
index of the secondary set as returned by FieldExpandableODE#addSecondaryEquations(FieldSecondaryEquations) (beware index 0 corresponds to main state, additional states start at 1)
index
)

Get derivative of the secondary state at time.

Inherited from org.apache.commons.math3.ode.FieldODEState:
copygetNumberOfSecondaryStatesgetSecondaryStategetSecondaryStateDimensiongetStategetStateDimensiongetTime

Field Detail

derivativeback to summary
private final T[] derivative

Derivative of the main state at time.

secondaryDerivativeback to summary
private final T[][] secondaryDerivative

Derivative of the secondary state at time.

Constructor Detail

FieldODEStateAndDerivativeback to summary
public FieldODEStateAndDerivative(T time, T[] state, T[] derivative)

Simple constructor.

Calling this constructor is equivalent to call FieldODEStateAndDerivative(time, state, derivative, null, null).

Parameters
time:T

time

state:T[]

state at time

derivative:T[]

derivative of the state at time

FieldODEStateAndDerivativeback to summary
public FieldODEStateAndDerivative(T time, T[] state, T[] derivative, T[][] secondaryState, T[][] secondaryDerivative)

Simple constructor.

Parameters
time:T

time

state:T[]

state at time

derivative:T[]

derivative of the state at time

secondaryState:T[][]

state at time (may be null)

secondaryDerivative:T[][]

derivative of the state at time (may be null)

Method Detail

getDerivativeback to summary
public T[] getDerivative()

Get derivative of the main state at time.

Returns:T[]

derivative of the main state at time

getSecondaryDerivativeback to summary
public T[] getSecondaryDerivative(final int index)

Get derivative of the secondary state at time.

Parameters
index:int

index of the secondary set as returned by FieldExpandableODE#addSecondaryEquations(FieldSecondaryEquations) (beware index 0 corresponds to main state, additional states start at 1)

Returns:T[]

derivative of the secondary state at time