pyHarm.StopCriterion.FactoryStopCriterion

Factory module responsible for creating the ABCStopCriterion needed.

pyHarm.StopCriterion.FactoryStopCriterion.Stopper_dico

Dictionary containing all the StopCriterions available.

Type:

dict[str,ABCStopCriterion]

Attributes

Stopper_dico

Dictionary containing all the StopCriterions available.

Functions

generateStopCriterion(...)

Factory function that creates a ABCSystem object.

Module Contents

pyHarm.StopCriterion.FactoryStopCriterion.Stopper_dico

Dictionary containing all the StopCriterions available.

Type:

dict[str,ABCStopCriterion]

pyHarm.StopCriterion.FactoryStopCriterion.generateStopCriterion(name_stopcriterion: str, bounds: list[float, float], ds_min: float, stopcriterion_options) → pyHarm.StopCriterion.ABCStopCriterion.ABCStopCriterion

Factory function that creates a ABCSystem object.

Parameters:

  • name_stopcriterion (str) – Type of the ABCStopCriterion object that is to be instantiated.

  • bounds (list[float,float]) – angular frequency bounds [puls_inf, puls_sup].

  • ds_min (float) – minimum step size.

  • stopcriterion_options (dict) – dictionary containing options to pass to the instantiated ABCStopCriterion.

Returns:

Instance of the required ABCStopCriterion class.

Return type:

ABCStopCriterion