org.apache.commons.math3.ode.sampling

Class AbstractFieldStepInterpolator<T extends RealFieldElement<T>>

java.lang.Object

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

Type Parameters:

T - the type of the field elements

All Implemented Interfaces:

FieldStepInterpolator<T>

public abstract class AbstractFieldStepInterpolator<T extends RealFieldElement<T>>
extends java.lang.Object
implements FieldStepInterpolator<T>

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

The various ODE integrators provide objects extending this class to the step handlers. The handlers can use these objects to retrieve the state vector at intermediate times between the previous and the current grid points (dense output).

Since:

3.6

See Also:

FirstOrderFieldIntegrator, StepHandler

Method Summary

Modifier and Type	Method and Description
FieldODEStateAndDerivative<T>	getCurrentState() Get the state at current grid point time.
FieldODEStateAndDerivative<T>	getGlobalCurrentState() Get the current global grid point state.
FieldODEStateAndDerivative<T>	getGlobalPreviousState() Get the previous global grid point state.
FieldODEStateAndDerivative<T>	getInterpolatedState(T time) Get the state at interpolated time.
FieldODEStateAndDerivative<T>	getPreviousState() Get the state at previous grid point time.
boolean	isForward() Check if the natural integration direction is forward.
AbstractFieldStepInterpolator<T>	restrictStep(FieldODEStateAndDerivative<T> previousState, FieldODEStateAndDerivative<T> currentState) Create a new restricted version of the instance.

Methods inherited from class java.lang.Object

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

Method Detail

restrictStep

public AbstractFieldStepInterpolator<T> restrictStep(FieldODEStateAndDerivative<T> previousState,
                                                     FieldODEStateAndDerivative<T> currentState)

Create a new restricted version of the instance.

The instance is not changed at all.

Parameters:

previousState - start of the restricted step

currentState - end of the restricted step

Returns:

restricted version of the instance

See Also:

getPreviousState(), getCurrentState()

getGlobalPreviousState

public FieldODEStateAndDerivative<T> getGlobalPreviousState()

Get the previous global grid point state.

Returns:

previous global grid point state

getGlobalCurrentState

public FieldODEStateAndDerivative<T> getGlobalCurrentState()

Get the current global grid point state.

Returns:

current global grid point state

getPreviousState

public FieldODEStateAndDerivative<T> getPreviousState()

Get the state at previous grid point time.

Specified by:

getPreviousState in interface FieldStepInterpolator<T extends RealFieldElement<T>>

Returns:

state at previous grid point time

getCurrentState

public FieldODEStateAndDerivative<T> getCurrentState()

Get the state at current grid point time.

Specified by:

getCurrentState in interface FieldStepInterpolator<T extends RealFieldElement<T>>

Returns:

state at current grid point time

getInterpolatedState

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.

Specified by:

getInterpolatedState in interface FieldStepInterpolator<T extends RealFieldElement<T>>

Parameters:

time - time of the interpolated point

Returns:

state at interpolated time

isForward

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.

Specified by:

isForward in interface FieldStepInterpolator<T extends RealFieldElement<T>>

Returns:

true if the integration variable (time) increases during integration