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

public Interface FieldStepHandler<T extends RealFieldElement<T>>

Known Direct Implementers
org.apache.commons.math3.ode.sampling.FieldStepNormalizer, org.apache.commons.math3.ode.ContinuousOutputFieldModel, org.apache.commons.math3.ode.MultistepFieldIntegrator.FieldNordsieckInitializer
Type Parameters
<T>
the type of the field elements
Imports
org.apache.commons.math3.RealFieldElement, org.apache.commons.math3.exception.MaxCountExceededException, org.apache.commons.math3.ode.FieldODEStateAndDerivative

This interface represents a handler that should be called after each successful step.

The ODE integrators compute the evolution of the state vector at some grid points that depend on their own internal algorithm. Once they have found a new grid point (possibly after having computed several evaluation of the derivative at intermediate points), they provide it to objects implementing this interface. These objects typically either ignore the intermediate steps and wait for the last one, store the points in an ephemeris, or forward them to specialized processing or output methods.

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

Method Summary

Modifier and TypeMethod and Description
public void
handleStep(FieldStepInterpolator<T>
interpolator for the last accepted step. For efficiency purposes, the various integrators reuse the same object on each call, so if the instance wants to keep it across all calls (for example to provide at the end of the integration a continuous model valid throughout the integration range, as the ContinuousOutputModel class does), it should build a local copy using the clone method of the interpolator and store this copy. Keeping only a reference to the interpolator and reusing it will result in unpredictable behavior (potentially crashing the application).
interpolator
,
boolean
true if the step is the last one
isLast
)

Handle the last accepted step

public void
init(FieldODEStateAndDerivative<T>
initial time, state vector and derivative
initialState
,
T
target time for the integration
finalTime
)

Initialize step handler at the start of an ODE integration.

Method Detail

handleStepback to summary
public void handleStep(FieldStepInterpolator<T> interpolator, boolean isLast) throws MaxCountExceededException

Handle the last accepted step

Parameters
interpolator:FieldStepInterpolator<T>

interpolator for the last accepted step. For efficiency purposes, the various integrators reuse the same object on each call, so if the instance wants to keep it across all calls (for example to provide at the end of the integration a continuous model valid throughout the integration range, as the ContinuousOutputModel class does), it should build a local copy using the clone method of the interpolator and store this copy. Keeping only a reference to the interpolator and reusing it will result in unpredictable behavior (potentially crashing the application).

isLast:boolean

true if the step is the last one

Exceptions
MaxCountExceededException:
if the interpolator throws one because the number of functions evaluations is exceeded
initback to summary
public void init(FieldODEStateAndDerivative<T> initialState, T finalTime)

Initialize step handler at the start of an ODE integration.

This method is called once at the start of the integration. It may be used by the step handler to initialize some internal data if needed.

Parameters
initialState:FieldODEStateAndDerivative<T>

initial time, state vector and derivative

finalTime:T

target time for the integration