Interface ODEStepHandler

  • All Known Subinterfaces:
    All Known Implementing Classes:
    ContinuousOutputModel, DenseOutputModel, DummyStepHandler, StepNormalizer

    public interface ODEStepHandler
    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.

    See Also:
    ODEIntegrator, ODEStateInterpolator
    • Method Detail

      • init

        default void init​(ODEStateAndDerivative initialState,
                          double 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.

        The default implementation does nothing

        initialState - initial time, state vector and derivative
        finalTime - target time for the integration
      • handleStep

        void handleStep​(ODEStateInterpolator interpolator,
                        boolean isLast)
                 throws MathIllegalStateException
        Handle the last accepted step
        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 DenseOutputModel 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
        MathIllegalStateException - if the interpolator throws one because the number of functions evaluations is exceeded