Class AbstractIntegrator

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractIntegrator​(java.lang.String name)
      Build an instance.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addEventHandler​(EventHandler handler, double maxCheckInterval, double convergence, int maxIterationCount)
      Add an event handler to the integrator.
      void addStepHandler​(StepHandler handler)
      Add a step handler to this integrator.
      void clearEventHandlers()
      Remove all the event handlers that have been added to the integrator.
      void clearStepHandlers()
      Remove all the step handlers that have been added to the integrator.
      void computeDerivatives​(double t, double[] y, double[] yDot)
      Compute the derivatives and check the number of evaluations.
      double getCurrentSignedStepsize()
      Get the current signed value of the integration stepsize.
      double getCurrentStepStart()
      Get the current value of the step start time ti.
      int getEvaluations()
      Get the number of evaluations of the differential equations function.
      java.util.Collection<EventHandler> getEventHandlers()
      Get all the event handlers that have been added to the integrator.
      int getMaxEvaluations()
      Get the maximal number of functions evaluations.
      java.lang.String getName()
      Get the name of the method.
      java.util.Collection<StepHandler> getStepHandlers()
      Get all the step handlers that have been added to the integrator.
      void setMaxEvaluations​(int maxEvaluations)
      Set the maximal number of differential equations function evaluations.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • AbstractIntegrator

        public AbstractIntegrator​(java.lang.String name)
        Build an instance.
        Parameters:
        name - name of the method
    • Method Detail

      • getName

        public java.lang.String getName()
        Get the name of the method.
        Specified by:
        getName in interface ODEIntegrator
        Returns:
        name of the method
      • addEventHandler

        public void addEventHandler​(EventHandler handler,
                                    double maxCheckInterval,
                                    double convergence,
                                    int maxIterationCount)
        Add an event handler to the integrator.
        Specified by:
        addEventHandler in interface ODEIntegrator
        Parameters:
        handler - event handler
        maxCheckInterval - maximal time interval between switching function checks (this interval prevents missing sign changes in case the integration steps becomes very large)
        convergence - convergence threshold in the event time search
        maxIterationCount - upper limit of the iteration count in the event time search
        See Also:
        ODEIntegrator.getEventHandlers(), ODEIntegrator.clearEventHandlers()
      • getCurrentStepStart

        public double getCurrentStepStart()
        Get the current value of the step start time ti.

        This method can be called during integration (typically by the object implementing the differential equations problem) if the value of the current step that is attempted is needed.

        The result is undefined if the method is called outside of calls to integrate.

        Specified by:
        getCurrentStepStart in interface ODEIntegrator
        Returns:
        current value of the step start time ti
      • getCurrentSignedStepsize

        public double getCurrentSignedStepsize()
        Get the current signed value of the integration stepsize.

        This method can be called during integration (typically by the object implementing the differential equations problem) if the signed value of the current stepsize that is tried is needed.

        The result is undefined if the method is called outside of calls to integrate.

        Specified by:
        getCurrentSignedStepsize in interface ODEIntegrator
        Returns:
        current signed value of the stepsize
      • setMaxEvaluations

        public void setMaxEvaluations​(int maxEvaluations)
        Set the maximal number of differential equations function evaluations.

        The purpose of this method is to avoid infinite loops which can occur for example when stringent error constraints are set or when lots of discrete events are triggered, thus leading to many rejected steps.

        Specified by:
        setMaxEvaluations in interface ODEIntegrator
        Parameters:
        maxEvaluations - maximal number of function evaluations (negative values are silently converted to maximal integer value, thus representing almost unlimited evaluations)
      • getMaxEvaluations

        public int getMaxEvaluations()
        Get the maximal number of functions evaluations.
        Specified by:
        getMaxEvaluations in interface ODEIntegrator
        Returns:
        maximal number of functions evaluations
      • getEvaluations

        public int getEvaluations()
        Get the number of evaluations of the differential equations function.

        The number of evaluations corresponds to the last call to the integrate method. It is 0 if the method has not been called yet.

        Specified by:
        getEvaluations in interface ODEIntegrator
        Returns:
        number of evaluations of the differential equations function
      • computeDerivatives

        public void computeDerivatives​(double t,
                                       double[] y,
                                       double[] yDot)
                                throws DerivativeException
        Compute the derivatives and check the number of evaluations.
        Parameters:
        t - current value of the independent time variable
        y - array containing the current value of the state vector
        yDot - placeholder array where to put the time derivative of the state vector
        Throws:
        DerivativeException - this user-defined exception should be used if an error is is triggered by user code