org.hipparchus.ode

Class ComplexODEStateAndDerivative

java.lang.Object

org.hipparchus.ode.ComplexODEState

org.hipparchus.ode.ComplexODEStateAndDerivative

All Implemented Interfaces:

Serializable

public class ComplexODEStateAndDerivative
extends ComplexODEState

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

See Also:

ComplexOrdinaryDifferentialEquation, ComplexSecondaryODE, ODEIntegrator, Serialized Form

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class org.hipparchus.ode.ComplexODEState

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

ComplexODEStateAndDerivative

public ComplexODEStateAndDerivative(double time,
                                    Complex[] primaryState,
                                    Complex[] primaryDerivative)

Simple constructor.

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

Parameters:

time - time

primaryState - primary state at time

primaryDerivative - derivative of the primary state at time

ComplexODEStateAndDerivative

public ComplexODEStateAndDerivative(double time,
                                    Complex[] primaryState,
                                    Complex[] primaryDerivative,
                                    Complex[][] secondaryState,
                                    Complex[][] 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 Complex[] getPrimaryDerivative()

Get derivative of the primary state at time.

Returns:

derivative of the primary state at time

See Also:

getSecondaryDerivative(int), getCompleteDerivative()

getSecondaryDerivative

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