Package org.hipparchus.ode

Class ODEState

java.lang.Object

org.hipparchus.ode.ODEState

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ODEStateAndDerivative

public class ODEState
extends Object
implements Serializable

Container for time, main and secondary state vectors.

See Also:

OrdinaryDifferentialEquation, SecondaryODE, ODEIntegrator, ODEStateAndDerivative, Serialized Form

Constructor Summary

Constructors

Constructor	Description
ODEState(double time, double[] primaryState)	Simple constructor.
ODEState(double time, double[] primaryState, double[][] secondaryState)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
protected double[][]	copy(double[][] original)	Copy a two-dimensions array.
double[]	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.
double[]	getPrimaryState()	Get primary state at time.
int	getPrimaryStateDimension()	Get primary state dimension.
double[]	getSecondaryState(int index)	Get secondary state at time.
int	getSecondaryStateDimension(int index)	Get secondary state dimension.
double	getTime()	Get time.

Methods inherited from class java.lang.Object

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

Constructor Detail

ODEState

public ODEState(double time,
                double[] primaryState)

Simple constructor.

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

Parameters:

time - time

primaryState - primary state at time

ODEState

public ODEState(double time,
                double[] primaryState,
                double[][] secondaryState)

Simple constructor.

Parameters:

time - time

primaryState - state at time

secondaryState - primary state at time (may be null)

Method Detail

copy

protected double[][] copy(double[][] 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 double getTime()

Get time.

Returns:

time

getPrimaryStateDimension

public int getPrimaryStateDimension()

Get primary state dimension.

Returns:

primary state dimension

See Also:

getSecondaryStateDimension(int), getCompleteStateDimension()

getPrimaryState

public double[] 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 ExpandableODE.addSecondaryEquations(SecondaryODE) (beware index 0 corresponds to primary state, secondary states start at 1)

Returns:

secondary state dimension

See Also:

getPrimaryStateDimension(), getCompleteStateDimension()

getSecondaryState

public double[] getSecondaryState(int index)

Get secondary state at time.

Parameters:

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

Returns:

secondary state at time

See Also:

getPrimaryState(), getCompleteState()

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

See Also:

getPrimaryStateDimension(), getSecondaryStateDimension(int)

getCompleteState

public double[] 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)