Package org.hipparchus.ode

Class ODEStateAndDerivative

java.lang.Object

org.hipparchus.ode.ODEState

org.hipparchus.ode.ODEStateAndDerivative

All Implemented Interfaces:

Serializable

public class ODEStateAndDerivative
extends ODEState

Container for time, main and secondary state vectors as well as their derivatives.

See Also:

OrdinaryDifferentialEquation, SecondaryODE, ODEIntegrator, Serialized Form

Constructor Summary

Constructors

Constructor	Description
ODEStateAndDerivative(double time, double[] primaryState, double[] primaryDerivative)	Simple constructor.
ODEStateAndDerivative(double time, double[] primaryState, double[] primaryDerivative, double[][] secondaryState, double[][] secondaryDerivative)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
double[]	getCompleteDerivative()	Get complete derivative at time.
double[]	getPrimaryDerivative()	Get derivative of the primary state at time.
double[]	getSecondaryDerivative(int index)	Get derivative of the secondary state at time.

Methods inherited from class org.hipparchus.ode.ODEState

copy, getCompleteState, getCompleteStateDimension, getNumberOfSecondaryStates, getPrimaryState, getPrimaryStateDimension, getSecondaryState, getSecondaryStateDimension, getTime

Methods inherited from class java.lang.Object

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

Constructor Detail

ODEStateAndDerivative

public ODEStateAndDerivative(double time,
                             double[] primaryState,
                             double[] primaryDerivative)

Simple constructor.

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

Parameters:

time - time

primaryState - primary state at time

primaryDerivative - derivative of the primary state at time

ODEStateAndDerivative

public ODEStateAndDerivative(double time,
                             double[] primaryState,
                             double[] primaryDerivative,
                             double[][] secondaryState,
                             double[][] secondaryDerivative)

Simple constructor.

Parameters:

time - time

primaryState - primary state at time

primaryDerivative - derivative of the primary state at time

secondaryState - state at time (may be null)

secondaryDerivative - derivative of the state at time (may be null)

Method Detail

getPrimaryDerivative

public double[] getPrimaryDerivative()

Get derivative of the primary state at time.

Returns:

derivative of the primary state at time

See Also:

getSecondaryDerivative(int), getCompleteDerivative()

getSecondaryDerivative

public double[] getSecondaryDerivative(int index)

Get derivative of the 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:

derivative of the secondary state at time

See Also:

getPrimaryDerivative(), getCompleteDerivative()

getCompleteDerivative

public double[] getCompleteDerivative()

Get complete derivative at time.

Returns:

complete derivative at time, starting with primary derivative, followed by all secondary derivatives in increasing index order

See Also:

getPrimaryDerivative(), getSecondaryDerivative(int)