pyHarm.StopCriterion.StopCriterionBoundsOrSolNumber

Classes

StopCriterionBoundsOrSolNumber

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

Module Contents

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

Bases: pyHarm.StopCriterion.StopCriterionBounds.StopCriterionBounds

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

name = 'Stop criterion when out of angular frequency bounds'
factory_keyword: str = 'solnumber'

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

default
stopper_options
max_solsaved
getStopCriterionStatus(sol: pyHarm.Solver.SystemSolution, sollist: list[pyHarm.Solver.SystemSolution], **kwargs) bool

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

Parameters:
  • sol (SystemSolution) – Actual SystemSolution out of the solver process.

  • sollist (list[SystemSolution]) – List containing all previous SystemSolution.

Returns:

True if the number of solutions is reached.

Return type:

bool