pyHarm.StepSizeRules.ABCStepSizeRule
====================================

.. py:module:: pyHarm.StepSizeRules.ABCStepSizeRule


Classes
-------

.. autoapisummary::

   pyHarm.StepSizeRules.ABCStepSizeRule.ABCStepSizeRule


Module Contents
---------------

.. py:class:: ABCStepSizeRule(bounds: list[float, float], **kwargs)

   Bases: :py:obj:`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.

   :param bounds: List containing the step size bounds [min_step, max_step].
   :type bounds: list[float,float]

   .. attribute:: ds_min

      min step size.

      :type: float

   .. attribute:: ds_max

      max step size.

      :type: float


   .. py:property:: factory_keyword
      :type: str

      :abstractmethod:


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


   .. py:attribute:: ds_min


   .. py:attribute:: ds_max


   .. py:method:: getStepSize(ds: float, sollist: list[pyHarm.Solver.SystemSolution], **kwargs) -> float
      :abstractmethod:


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




   .. py:method:: ProjectInBounds(ds: float) -> float

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

      :param ds: step-size.
      :type ds: float

      :returns: step-size projected onto the bounds if it is out of the bounds.
      :rtype: float