public interface StepHandlerWithJacobians
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.
Note that is is possible to register a
classical step handler
in the low level integrator used to build a
rather than implementing this class. The step handlers registered at low level
will see the big compound state whether the step handlers defined by this interface
see the original state, and its jacobians in separate arrays.
The compound state is guaranteed to contain the original state in the first elements, followed by the jacobian with respect to initial state (in row order), followed by the jacobian with respect to parameters (in row order). If for example the original state dimension is 6 and there are 3 parameters, the compound state will be a 60 elements array. The first 6 elements will be the original state, the next 36 elements will be the jacobian with respect to initial state, and the remaining 18 elements will be the jacobian with respect to parameters.
Dealing with low level step handlers is cumbersome if one really needs the jacobians in these methods, but it also prevents many data being copied back and forth between state and jacobians on one side and compound state on the other side. So for performance reasons, it is recommended to use this interface only if jacobians are really needed and to use lower level handlers if only state is needed.
|Modifier and Type
|Method and Description
Handle the last accepted step
Determines whether this handler needs dense output.
Reset the step handler.
This method allows the integrator to avoid performing extra computation if the handler does not need dense output.
void handleStep(StepInterpolatorWithJacobians interpolator, boolean isLast) throws DerivativeException
interpolator - 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 - true if the step is the last one
DerivativeException - this exception is propagated to the
caller if the underlying user function triggers one
Copyright © 2010 - 2020 Adobe. All Rights Reserved