pyHarm.StopCriterion.StopCriterionBounds
========================================

.. py:module:: pyHarm.StopCriterion.StopCriterionBounds


Classes
-------

.. autoapisummary::

   pyHarm.StopCriterion.StopCriterionBounds.StopCriterionBounds


Module Contents
---------------

.. py:class:: StopCriterionBounds(bounds: list[float, float], ds_min: float, **kwargs)

   Bases: :py:obj:`pyHarm.StopCriterion.ABCStopCriterion.ABCStopCriterion`


   Subclass of ABCStopCriterion : Stopper based on the angular frequency bounds given, the computation stops once a solution is found outside of the bounds.





   .. py:attribute:: name
      :value: 'Stop criterion when out of angular frequency bounds'



   .. py:attribute:: factory_keyword
      :type:  str
      :value: 'bounds'


      Returns:
      str: keyword that is used to call the creation of this class in the system factory.


   .. py:method:: getStopCriterionStatus(sol: pyHarm.Solver.SystemSolution, sollist: list[pyHarm.Solver.SystemSolution], **kwargs) -> bool

      Returns True if the bounds are reached by the solution.

      :param sol: Actual SystemSolution out of the solver process.
      :type sol: SystemSolution
      :param sollist: List containing all previous SystemSolution.
      :type sollist: list[SystemSolution]

      :returns: True if the solution is out of the bounds or if the minimum step size is reached for at least two solutions.
      :rtype: bool