pyHarm.StopCriterion.FactoryStopCriterion
=========================================

.. py:module:: pyHarm.StopCriterion.FactoryStopCriterion

.. autoapi-nested-parse::

   Factory module responsible for creating the ABCStopCriterion needed.

   .. attribute:: Stopper_dico

      Dictionary containing all the StopCriterions available.

      :type: dict[str,ABCStopCriterion]



Attributes
----------

.. autoapisummary::

   pyHarm.StopCriterion.FactoryStopCriterion.Stopper_dico


Functions
---------

.. autoapisummary::

   pyHarm.StopCriterion.FactoryStopCriterion.generateStopCriterion


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

.. py:data:: Stopper_dico

   Dictionary containing all the StopCriterions available.

   :type: dict[str,ABCStopCriterion]

.. py:function:: generateStopCriterion(name_stopcriterion: str, bounds: list[float, float], ds_min: float, stopcriterion_options) -> pyHarm.StopCriterion.ABCStopCriterion.ABCStopCriterion

   Factory function that creates a ABCSystem object.

   :param name_stopcriterion: Type of the ABCStopCriterion object that is to be instantiated.
   :type name_stopcriterion: str
   :param bounds: angular frequency bounds [puls_inf, puls_sup].
   :type bounds: list[float,float]
   :param ds_min: minimum step size.
   :type ds_min: float
   :param stopcriterion_options: dictionary containing options to pass to the instantiated ABCStopCriterion.
   :type stopcriterion_options: dict

   :returns: Instance of the required ABCStopCriterion class.
   :rtype: ABCStopCriterion