Class DormandPrince54FieldStepInterpolator<T extends RealFieldElement<T>>

java.lang.Object

org.apache.commons.math3.ode.sampling.AbstractFieldStepInterpolator<T>

org.apache.commons.math3.ode.nonstiff.RungeKuttaFieldStepInterpolator<T>

org.apache.commons.math3.ode.nonstiff.DormandPrince54FieldStepInterpolator<T>

Type Parameters:

T - the type of the field elements

All Implemented Interfaces:

FieldStepInterpolator<T>

class DormandPrince54FieldStepInterpolator<T extends RealFieldElement<T>>
extends RungeKuttaFieldStepInterpolator<T>

This class represents an interpolator over the last step during an ODE integration for the 5(4) Dormand-Prince integrator.

Since:

3.6

See Also:

• DormandPrince54Integrator

Field Summary

Fields

Modifier and Type	Field	Description
private final T	a70	Last row of the Butcher-array internal weights, element 0.
private final T	a72	Last row of the Butcher-array internal weights, element 2.
private final T	a73	Last row of the Butcher-array internal weights, element 3.
private final T	a74	Last row of the Butcher-array internal weights, element 4.
private final T	a75	Last row of the Butcher-array internal weights, element 5.
private final T	d0	Shampine (1986) Dense output, element 0.
private final T	d2	Shampine (1986) Dense output, element 2.
private final T	d3	Shampine (1986) Dense output, element 3.
private final T	d4	Shampine (1986) Dense output, element 4.
private final T	d5	Shampine (1986) Dense output, element 5.
private final T	d6	Shampine (1986) Dense output, element 6.

Constructor Summary

Constructors

Constructor	Description
DormandPrince54FieldStepInterpolator(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 FieldODEStateAndDerivative<T>	computeInterpolatedStateAndDerivatives(FieldEquationsMapper<T> mapper, T time, T theta, T thetaH, T oneMinusThetaH)	Compute the state and derivatives at the interpolated time.
protected DormandPrince54FieldStepInterpolator<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.

Methods inherited from class RungeKuttaFieldStepInterpolator

create, currentStateLinearCombination, derivativeLinearCombination, previousStateLinearCombination

Methods inherited from class AbstractFieldStepInterpolator

getCurrentState, getGlobalCurrentState, getGlobalPreviousState, getInterpolatedState, getPreviousState, isForward, restrictStep

Methods inherited from class Object

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

Field Details

a70

private final T extends RealFieldElement<T> a70

Last row of the Butcher-array internal weights, element 0.

a72

private final T extends RealFieldElement<T> a72

Last row of the Butcher-array internal weights, element 2.

a73

private final T extends RealFieldElement<T> a73

Last row of the Butcher-array internal weights, element 3.

a74

private final T extends RealFieldElement<T> a74

Last row of the Butcher-array internal weights, element 4.

a75

private final T extends RealFieldElement<T> a75

Last row of the Butcher-array internal weights, element 5.

d0

private final T extends RealFieldElement<T> d0

Shampine (1986) Dense output, element 0.

d2

private final T extends RealFieldElement<T> d2

Shampine (1986) Dense output, element 2.

d3

private final T extends RealFieldElement<T> d3

Shampine (1986) Dense output, element 3.

d4

private final T extends RealFieldElement<T> d4

Shampine (1986) Dense output, element 4.

d5

private final T extends RealFieldElement<T> d5

Shampine (1986) Dense output, element 5.

d6

private final T extends RealFieldElement<T> d6

Shampine (1986) Dense output, element 6.

Constructor Details

DormandPrince54FieldStepInterpolator

DormandPrince54FieldStepInterpolator(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 Details

create

protected DormandPrince54FieldStepInterpolator<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.

Specified by:

create in class RungeKuttaFieldStepInterpolator<T extends RealFieldElement<T>>

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

computeInterpolatedStateAndDerivatives

protected FieldODEStateAndDerivative<T> computeInterpolatedStateAndDerivatives(FieldEquationsMapper<T> mapper,
 T time,
 T theta,
 T thetaH,
 T oneMinusThetaH)

Compute the state and derivatives at the interpolated time. This is the main processing method that should be implemented by the derived classes to perform the interpolation.

Specified by:

computeInterpolatedStateAndDerivatives in class AbstractFieldStepInterpolator<T extends RealFieldElement<T>>

Parameters:

mapper - mapper for ODE equations primary and secondary components

time - interpolation time

theta - normalized interpolation abscissa within the step (theta is zero at the previous time step and one at the current time step)

thetaH - time gap between the previous time and the interpolated time

oneMinusThetaH - time gap between the interpolated time and the current time

Returns:

interpolated state and derivatives