pyHarm.StepSizeRules.StepSizeConstant
=====================================

.. py:module:: pyHarm.StepSizeRules.StepSizeConstant


Classes
-------

.. autoapisummary::

   pyHarm.StepSizeRules.StepSizeConstant.StepSizeConstant


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

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

   Bases: :py:obj:`pyHarm.StepSizeRules.ABCStepSizeRule.ABCStepSizeRule`


   Step size is kept constant.


   .. py:attribute:: factory_keyword
      :type:  str
      :value: 'constant'


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


   .. py:attribute:: name
      :value: 'constant step size'



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

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

      :param ds: Current step size.
      :type ds: float
      :param sollist: list of SystemSolution returned during the analysis.
      :type sollist: list[SystemSolution]

      :returns: updated step size.
      :rtype: float