Package org.hipparchus.ode.nonstiff.interpolators

Class RungeKuttaFieldStateInterpolator<T extends CalculusFieldElement<T>>

java.lang.Object

org.hipparchus.ode.sampling.AbstractFieldODEStateInterpolator<T>

org.hipparchus.ode.nonstiff.interpolators.RungeKuttaFieldStateInterpolator<T>

Type Parameters:

T - the type of the field elements

All Implemented Interfaces:

FieldODEStateInterpolator<T>

Direct Known Subclasses:

ClassicalRungeKuttaFieldStateInterpolator, DormandPrince54FieldStateInterpolator, DormandPrince853FieldStateInterpolator, EulerFieldStateInterpolator, GillFieldStateInterpolator, HighamHall54FieldStateInterpolator, LutherFieldStateInterpolator, MidpointFieldStateInterpolator, ThreeEighthesFieldStateInterpolator

public abstract class RungeKuttaFieldStateInterpolator<T extends CalculusFieldElement<T>>
extends AbstractFieldODEStateInterpolator<T>

This class represents an interpolator over the last step during an ODE integration for Runge-Kutta and embedded Runge-Kutta integrators.

See Also:

FixedStepRungeKuttaFieldIntegrator, EmbeddedRungeKuttaFieldIntegrator

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RungeKuttaFieldStateInterpolator(Field<T> field, boolean forward, T[][] yDotK, FieldODEStateAndDerivative<T> globalPreviousState, FieldODEStateAndDerivative<T> globalCurrentState, FieldODEStateAndDerivative<T> softPreviousState, FieldODEStateAndDerivative<T> softCurrentState, FieldEquationsMapper<T> mapper)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
protected RungeKuttaFieldStateInterpolator<T>	create(boolean newForward, FieldODEStateAndDerivative<T> newGlobalPreviousState, FieldODEStateAndDerivative<T> newGlobalCurrentState, FieldODEStateAndDerivative<T> newSoftPreviousState, FieldODEStateAndDerivative<T> newSoftCurrentState, FieldEquationsMapper<T> newMapper)	Create a new instance.
protected abstract RungeKuttaFieldStateInterpolator<T>	create(Field<T> newField, boolean newForward, T[][] newYDotK, FieldODEStateAndDerivative<T> newGlobalPreviousState, FieldODEStateAndDerivative<T> newGlobalCurrentState, FieldODEStateAndDerivative<T> newSoftPreviousState, FieldODEStateAndDerivative<T> newSoftCurrentState, FieldEquationsMapper<T> newMapper)	Create a new instance.
protected T[]	currentStateLinearCombination(T... coefficients)	Compute a state by linear combination added to current state.
protected T[]	derivativeLinearCombination(T... coefficients)	Compute a state derivative by linear combination.
protected T[]	previousStateLinearCombination(T... coefficients)	Compute a state by linear combination added to previous state.

Methods inherited from class org.hipparchus.ode.sampling.AbstractFieldODEStateInterpolator

computeInterpolatedStateAndDerivatives, getCurrentState, getGlobalCurrentState, getGlobalPreviousState, getInterpolatedState, getMapper, getPreviousState, isCurrentStateInterpolated, isForward, isPreviousStateInterpolated, restrictStep

Methods inherited from class java.lang.Object

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

Constructor Detail

RungeKuttaFieldStateInterpolator

protected RungeKuttaFieldStateInterpolator(Field<T> field,
                                           boolean forward,
                                           T[][] yDotK,
                                           FieldODEStateAndDerivative<T> globalPreviousState,
                                           FieldODEStateAndDerivative<T> globalCurrentState,
                                           FieldODEStateAndDerivative<T> softPreviousState,
                                           FieldODEStateAndDerivative<T> softCurrentState,
                                           FieldEquationsMapper<T> mapper)

Simple constructor.

Parameters:

field - field to which the time and state vector elements belong

forward - integration direction indicator

yDotK - slopes at the intermediate points

globalPreviousState - start of the global step

globalCurrentState - end of the global step

softPreviousState - start of the restricted step

softCurrentState - end of the restricted step

mapper - equations mapper for the all equations

Method Detail

create

protected RungeKuttaFieldStateInterpolator<T> create(boolean newForward,
                                                     FieldODEStateAndDerivative<T> newGlobalPreviousState,
                                                     FieldODEStateAndDerivative<T> newGlobalCurrentState,
                                                     FieldODEStateAndDerivative<T> newSoftPreviousState,
                                                     FieldODEStateAndDerivative<T> newSoftCurrentState,
                                                     FieldEquationsMapper<T> newMapper)

Create a new instance.

Specified by:

create in class AbstractFieldODEStateInterpolator<T extends CalculusFieldElement<T>>

Parameters:

newForward - integration direction indicator

newGlobalPreviousState - start of the global step

newGlobalCurrentState - end of the global step

newSoftPreviousState - start of the restricted step

newSoftCurrentState - end of the restricted step

newMapper - equations mapper for the all equations

Returns:

a new instance

create

protected abstract RungeKuttaFieldStateInterpolator<T> create(Field<T> newField,
                                                              boolean newForward,
                                                              T[][] newYDotK,
                                                              FieldODEStateAndDerivative<T> newGlobalPreviousState,
                                                              FieldODEStateAndDerivative<T> newGlobalCurrentState,
                                                              FieldODEStateAndDerivative<T> newSoftPreviousState,
                                                              FieldODEStateAndDerivative<T> newSoftCurrentState,
                                                              FieldEquationsMapper<T> newMapper)

Create a new instance.

Parameters:

newField - field to which the time and state vector elements belong

newForward - integration direction indicator

newYDotK - slopes at the intermediate points

newGlobalPreviousState - start of the global step

newGlobalCurrentState - end of the global step

newSoftPreviousState - start of the restricted step

newSoftCurrentState - end of the restricted step

newMapper - equations mapper for the all equations

Returns:

a new instance

previousStateLinearCombination

@SafeVarargs
protected final T[] previousStateLinearCombination(T... coefficients)

Compute a state by linear combination added to previous state.

Parameters:

coefficients - coefficients to apply to the method staged derivatives

Returns:

combined state

currentStateLinearCombination

protected T[] currentStateLinearCombination(T... coefficients)

Compute a state by linear combination added to current state.

Parameters:

coefficients - coefficients to apply to the method staged derivatives

Returns:

combined state

derivativeLinearCombination

protected T[] derivativeLinearCombination(T... coefficients)

Compute a state derivative by linear combination.

Parameters:

coefficients - coefficients to apply to the method staged derivatives

Returns:

combined state