pyHarm.StopCriterion.StopCriterionBounds

Classes

StopCriterionBounds

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

Module Contents

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

Bases: 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.

name = 'Stop criterion when out of angular frequency bounds'

factory_keyword: str = 'bounds'

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

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

Returns True if the bounds are reached by the solution.

Parameters:

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

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

Returns:

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

Return type:

bool