Top Description Methods
org.apache.commons.math3.ode.sampling

public Interface FieldStepInterpolator<T extends RealFieldElement<T>>

Known Direct Implementers
org.apache.commons.math3.ode.sampling.AbstractFieldStepInterpolator
Type Parameters
<T>
the type of the field elements
Imports
org.apache.commons.math3.RealFieldElement, org.apache.commons.math3.ode.FieldODEStateAndDerivative

This interface represents an interpolator over the last step during an ODE integration.

The various ODE integrators provide objects implementing this interface to the step handlers. These objects are often custom objects tightly bound to the integrator internal algorithms. The handlers can use these objects to retrieve the state vector at intermediate times between the previous and the current grid points (this feature is often called dense output).

Since
3.6
See Also
org.apache.commons.math3.ode.FirstOrderFieldIntegrator, FieldStepHandler

Method Summary

Modifier and TypeMethod and Description
public FieldODEStateAndDerivative<T>

Returns:

state at current grid point time
getCurrentState
()

Get the state at current grid point time.

public FieldODEStateAndDerivative<T>

Returns:

state at interpolated time
getInterpolatedState
(T
time of the interpolated point
time
)

Get the state at interpolated time.

public FieldODEStateAndDerivative<T>

Returns:

state at previous grid point time
getPreviousState
()

Get the state at previous grid point time.

public boolean

Returns:

true if the integration variable (time) increases during integration
isForward
()

Check if the natural integration direction is forward.

Method Detail

getCurrentStateback to summary
public FieldODEStateAndDerivative<T> getCurrentState()

Get the state at current grid point time.

Returns:FieldODEStateAndDerivative<T>

state at current grid point time

getInterpolatedStateback to summary
public FieldODEStateAndDerivative<T> getInterpolatedState(T time)

Get the state at interpolated time.

Setting the time outside of the current step is allowed, but should be used with care since the accuracy of the interpolator will probably be very poor far from this step. This allowance has been added to simplify implementation of search algorithms near the step endpoints.

Parameters
time:T

time of the interpolated point

Returns:FieldODEStateAndDerivative<T>

state at interpolated time

getPreviousStateback to summary
public FieldODEStateAndDerivative<T> getPreviousState()

Get the state at previous grid point time.

Returns:FieldODEStateAndDerivative<T>

state at previous grid point time

isForwardback to summary
public boolean isForward()

Check if the natural integration direction is forward.

This method provides the integration direction as specified by the integrator itself, it avoid some nasty problems in degenerated cases like null steps due to cancellation at step initialization, step control or discrete events triggering.

Returns:boolean

true if the integration variable (time) increases during integration