pyHarm.StepSizeRules.ABCStepSizeRule¶

Classes¶

ABCStepSizeRule

This is the abstract class ruling the stepsize rules class. The step size rules are responsible for adjusting the step size of the analysis depending on the given inputs.

Module Contents¶

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

Bases: abc.ABC

This is the abstract class ruling the stepsize rules class. The step size rules are responsible for adjusting the step size of the analysis depending on the given inputs.

Parameters:: bounds (list[float,float]) – List containing the step size bounds [min_step, max_step].

ds_min¶

min step size.

Type:: float

ds_max¶

max step size.

Type:: float

property factory_keyword: str¶

Abstractmethod:

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

ds_min¶

ds_max¶

abstractmethod getStepSize(ds: float, sollist: list[pyHarm.Solver.SystemSolution], **kwargs) → float¶: Returns the step size to be used for the prediction step of the analysis.

ProjectInBounds(ds: float) → float¶

Projects the step-size onto the bounds if the step-size is out of the required bounds.

Parameters:: ds (float) – step-size.
Returns:: step-size projected onto the bounds if it is out of the bounds.
Return type:: float