Top Description Fields Constructors Methods
org.apache.commons.math3.ode.nonstiff

pack-priv Class ThreeEighthesStepInterpolator

extends RungeKuttaStepInterpolator
Class Inheritance
Imports
org.apache.commons.math3.ode.sampling.StepInterpolator

This class implements a step interpolator for the 3/8 fourth order Runge-Kutta integrator.

This interpolator allows to compute dense output inside the last step computed. The interpolation equation is consistent with the integration scheme :

where θ belongs to [0 ; 1] and where y'1 to y'4 are the four evaluations of the derivatives already computed during the step.

Since
1.2
See Also
ThreeEighthesIntegrator

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Serializable version identifier

Inherited from org.apache.commons.math3.ode.nonstiff.RungeKuttaStepInterpolator:
integratorpreviousStateyDotK

Constructor Summary

AccessConstructor and Description
public
ThreeEighthesStepInterpolator()

Simple constructor.

pack-priv
ThreeEighthesStepInterpolator(final ThreeEighthesStepInterpolator
interpolator to copy from. The copy is a deep copy: its arrays are separated from the original arrays of the instance
interpolator
)

Copy constructor.

Method Summary

Modifier and TypeMethod and Description
protected void
computeInterpolatedStateAndDerivatives(final double
normalized interpolation abscissa within the step (theta is zero at the previous time step and one at the current time step)
theta
,
final double
time gap between the interpolated time and the current time
oneMinusThetaH
)

Implements abstract org.apache.commons.math3.ode.sampling.AbstractStepInterpolator.computeInterpolatedStateAndDerivatives.

Compute the state and derivatives at the interpolated time.

protected StepInterpolator
doCopy()

Implements abstract org.apache.commons.math3.ode.sampling.AbstractStepInterpolator.doCopy.

Really copy the finalized instance.

Inherited from org.apache.commons.math3.ode.nonstiff.RungeKuttaStepInterpolator:
readExternalreinitializeshiftwriteExternal

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Serializable version identifier

Constructor Detail

ThreeEighthesStepInterpolatorback to summary
public ThreeEighthesStepInterpolator()

Simple constructor. This constructor builds an instance that is not usable yet, the org.apache.commons.math3.ode.sampling.AbstractStepInterpolator#reinitialize method should be called before using the instance in order to initialize the internal arrays. This constructor is used only in order to delay the initialization in some cases. The RungeKuttaIntegrator class uses the prototyping design pattern to create the step interpolators by cloning an uninitialized model and later initializing the copy.

ThreeEighthesStepInterpolatorback to summary
pack-priv ThreeEighthesStepInterpolator(final ThreeEighthesStepInterpolator interpolator)

Copy constructor.

Parameters
interpolator:ThreeEighthesStepInterpolator

interpolator to copy from. The copy is a deep copy: its arrays are separated from the original arrays of the instance

Method Detail

computeInterpolatedStateAndDerivativesback to summary
protected void computeInterpolatedStateAndDerivatives(final double theta, final double oneMinusThetaH)

Implements abstract org.apache.commons.math3.ode.sampling.AbstractStepInterpolator.computeInterpolatedStateAndDerivatives.

Doc from org.apache.commons.math3.ode.sampling.AbstractStepInterpolator.computeInterpolatedStateAndDerivatives.

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.

Parameters
theta:double

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

oneMinusThetaH:double

time gap between the interpolated time and the current time

Annotations
@Override
doCopyback to summary
protected StepInterpolator doCopy()

Implements abstract org.apache.commons.math3.ode.sampling.AbstractStepInterpolator.doCopy.

Doc from org.apache.commons.math3.ode.sampling.AbstractStepInterpolator.doCopy.

Really copy the finalized instance.

This method is called by copy() after the step has been finalized. It must perform a deep copy to have an new instance completely independent for the original instance.

Returns:StepInterpolator

a copy of the finalized instance

Annotations
@Override