pyHarm.StepSizeRules.StepSizeConstant

Classes

StepSizeConstant

Step size is kept constant.

Module Contents

class pyHarm.StepSizeRules.StepSizeConstant.StepSizeConstant(bounds: list[float, float], **kwargs)

Bases: pyHarm.StepSizeRules.ABCStepSizeRule.ABCStepSizeRule

Step size is kept constant.

factory_keyword: str = 'constant'

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

name = 'constant step size'
getStepSize(ds: float, sollist: list[pyHarm.Solver.SystemSolution], **kwargs) → float

Returns the step size to be used for the prediction step of the analysis.

Parameters:

  • ds (float) – Current step size.

  • sollist (list[SystemSolution]) – list of SystemSolution returned during the analysis.

Returns:

updated step size.

Return type:

float