org.hipparchus.ode

Class FieldODEState<T extends RealFieldElement<T>>

java.lang.Object

org.hipparchus.ode.FieldODEState<T>

Type Parameters:

T - the type of the field elements

Direct Known Subclasses:

FieldODEStateAndDerivative

public class FieldODEState<T extends RealFieldElement<T>>
extends Object

Container for time, main and secondary state vectors.

See Also:

FieldOrdinaryDifferentialEquation, FieldSecondaryODE, FieldODEIntegrator, FieldODEStateAndDerivative

Constructor Summary

Constructors

Constructor and Description
FieldODEState(T time, T[] primaryState) Simple constructor.
FieldODEState(T time, T[] primaryState, T[][] secondaryState) Simple constructor.

Method Summary

Modifier and Type	Method and Description
protected T[][]	copy(T[][] original) Copy a two-dimensions array.
T[]	getCompleteState() Get complete state at time.
int	getCompleteStateDimension() Return the dimension of the complete set of equations.
int	getNumberOfSecondaryStates() Get the number of secondary states.
T[]	getPrimaryState() Get primary state at time.
int	getPrimaryStateDimension() Get primary state dimension.
T[]	getSecondaryState(int index) Get secondary state at time.
int	getSecondaryStateDimension(int index) Get secondary state dimension.
T[]	getState() Deprecated. as of 1.0, replaced with getPrimaryState()
int	getStateDimension() Deprecated. as of 1.0, replaced with getPrimaryStateDimension()
T	getTime() Get time.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FieldODEState

public FieldODEState(T time,
                     T[] primaryState)

Simple constructor.

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

Parameters:

time - time

primaryState - primary state at time

FieldODEState

public FieldODEState(T time,
                     T[] primaryState,
                     T[][] secondaryState)

Simple constructor.

Parameters:

time - time

primaryState - primary state at time

secondaryState - secondary state at time (may be null)

Method Detail

copy

protected T[][] copy(T[][] original)

Copy a two-dimensions array.

Parameters:

original - original array (may be null)

Returns:

copied array or null if original array was null

getTime

public T getTime()

Get time.

Returns:

time

getStateDimension

@Deprecated
public int getStateDimension()

Deprecated. as of 1.0, replaced with getPrimaryStateDimension()

Get primary state dimension.

Returns:

primary state dimension

getPrimaryStateDimension

public int getPrimaryStateDimension()

Get primary state dimension.

Returns:

primary state dimension

See Also:

getSecondaryStateDimension(int), getCompleteStateDimension()

getState

@Deprecated
public T[] getState()

Deprecated. as of 1.0, replaced with getPrimaryState()

Get primary state at time.

Returns:

primary state at time

getPrimaryState

public T[] getPrimaryState()

Get primary state at time.

Returns:

primary state at time

See Also:

getSecondaryState(int), getCompleteState()

getNumberOfSecondaryStates

public int getNumberOfSecondaryStates()

Get the number of secondary states.

Returns:

number of secondary states.

getSecondaryStateDimension

public int getSecondaryStateDimension(int index)

Get secondary state dimension.

Parameters:

index - index of the secondary set as returned by FieldExpandableODE.addSecondaryEquations(FieldSecondaryODE) (beware index 0 corresponds to primary state, secondary states start at 1)

Returns:

secondary state dimension

getSecondaryState

public T[] getSecondaryState(int index)

Get secondary state at time.

Parameters:

index - index of the secondary set as returned by FieldExpandableODE.addSecondaryEquations(FieldSecondaryODE) (beware index 0 corresponds to primary state, secondary states start at 1)

Returns:

secondary state at time

getCompleteStateDimension

public int getCompleteStateDimension()

Return the dimension of the complete set of equations.

The complete set of equations correspond to the primary set plus all secondary sets.

Returns:

dimension of the complete set of equations

getCompleteState

public T[] getCompleteState()

Get complete state at time.

Returns:

complete state at time, starting with primary state, followed by all secondary states in increasing index order

See Also:

getPrimaryState(), getSecondaryState(int)