Class AbstractODEDetector<T extends AbstractODEDetector<T>>

    • Field Detail

      • DEFAULT_MAX_CHECK

        public static final double DEFAULT_MAX_CHECK
        Default maximum checking interval (s).
        See Also:
        Constant Field Values
      • DEFAULT_THRESHOLD

        public static final double DEFAULT_THRESHOLD
        Default convergence threshold (s).
        See Also:
        Constant Field Values
      • DEFAULT_MAX_ITER

        public static final int DEFAULT_MAX_ITER
        Default maximum number of iterations in the event time search.
        See Also:
        Constant Field Values
    • Constructor Detail

      • AbstractODEDetector

        protected AbstractODEDetector​(AdaptableInterval maxCheck,
                                      int maxIter,
                                      BracketedUnivariateSolver<UnivariateFunction> solver,
                                      ODEEventHandler handler)
        Build a new instance.
        Parameters:
        maxCheck - maximum checking interval, must be strictly positive (s)
        maxIter - maximum number of iterations in the event time search
        solver - root-finding algorithm to use to detect state events
        handler - event handler to call at event occurrences
    • Method Detail

      • init

        public void init​(ODEStateAndDerivative s0,
                         double t)
        Initialize event detector at the start of an ODE integration.

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

        The default implementation initializes the handler

        This implementation sets the direction of integration and initializes the event handler. If a subclass overrides this method it should call super.init(s0, t).

        Specified by:
        init in interface ODEEventDetector
        Parameters:
        s0 - initial time, state vector and derivative
        t - target time for the integration
      • getMaxIterationCount

        public int getMaxIterationCount()
        Get the upper limit in the iteration count for event localization.
        Specified by:
        getMaxIterationCount in interface ODEEventDetector
        Returns:
        upper limit in the iteration count for event localization
      • withMaxCheck

        public T withMaxCheck​(double newMaxCheck)
        Setup the maximum checking interval.

        This will override a maximum checking interval if it has been configured previously.

        Parameters:
        newMaxCheck - maximum checking interval
        Returns:
        a new detector with updated configuration (the instance is not changed)
      • withMaxCheck

        public T withMaxCheck​(AdaptableInterval newMaxCheck)
        Setup the maximum checking interval.

        This will override a maximum checking interval if it has been configured previously.

        Parameters:
        newMaxCheck - maximum checking interval
        Returns:
        a new detector with updated configuration (the instance is not changed)
        Since:
        3.0
      • withMaxIter

        public T withMaxIter​(int newMaxIter)
        Setup the maximum number of iterations in the event time search.

        This will override a number of iterations if it has been configured previously.

        Parameters:
        newMaxIter - maximum number of iterations in the event time search
        Returns:
        a new detector with updated configuration (the instance is not changed)
      • withThreshold

        public T withThreshold​(double newThreshold)
        Setup the convergence threshold.

        This is equivalent to call withSolver(new BracketingNthOrderBrentSolver(0, newThreshold, 0, 5)), so it will override a solver if one has been configured previously.

        Parameters:
        newThreshold - convergence threshold
        Returns:
        a new detector with updated configuration (the instance is not changed)
        See Also:
        withSolver(BracketedUnivariateSolver)
      • withSolver

        public T withSolver​(BracketedUnivariateSolver<UnivariateFunction> newSolver)
        Setup the root-finding algorithm to use to detect state events.

        This will override a solver if it has been configured previously.

        Parameters:
        newSolver - root-finding algorithm to use to detect state events
        Returns:
        a new detector with updated configuration (the instance is not changed)
        See Also:
        withThreshold(double)
      • withHandler

        public T withHandler​(ODEEventHandler newHandler)
        Setup the event handler to call at event occurrences.

        This will override a handler if it has been configured previously.

        Parameters:
        newHandler - event handler to call at event occurrences
        Returns:
        a new detector with updated configuration (the instance is not changed)
      • create

        protected abstract T create​(AdaptableInterval newMaxCheck,
                                    int newmaxIter,
                                    BracketedUnivariateSolver<UnivariateFunction> newSolver,
                                    ODEEventHandler newHandler)
        Build a new instance.
        Parameters:
        newMaxCheck - maximum checking interval
        newmaxIter - maximum number of iterations in the event time search
        newSolver - root-finding algorithm to use to detect state events
        newHandler - event handler to call at event occurrences
        Returns:
        a new instance of the appropriate sub-type
      • isForward

        public boolean isForward()
        Check if the current propagation is forward or backward.
        Returns:
        true if the current propagation is forward