pyHarm.StopCriterion.StopCriterionBoundsOrSolNumber
===================================================

.. py:module:: pyHarm.StopCriterion.StopCriterionBoundsOrSolNumber


Classes
-------

.. autoapisummary::

   pyHarm.StopCriterion.StopCriterionBoundsOrSolNumber.StopCriterionBoundsOrSolNumber


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

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

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


   Subclass of ABCStopCriterion : Stopper based on the number of solutions found.





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



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


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


   .. py:attribute:: default


   .. py:attribute:: stopper_options


   .. py:attribute:: max_solsaved


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

      Returns True if the number of solutions in the list is reached.

      :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 number of solutions is reached.
      :rtype: bool