pastas.rfunc.Edelman
====================

.. toctree::
   :hidden:

   /api/pastas/rfunc/Edelman.get_init_parameters
   /api/pastas/rfunc/Edelman.get_tmax
   /api/pastas/rfunc/Edelman.impulse
   /api/pastas/rfunc/Edelman.step

.. py:class:: pastas.rfunc.Edelman(cutoff: float = 0.999, **kwargs)



   
   The function of Edelman, describing the propagation of an instantaneous
   water level change into an adjacent half-infinite aquifer.

   :param up: indicates whether a positive stress will cause the head to go up (True,
              default) or down (False), if None the head can go both ways.
   :type up: bool or None, optional
   :param gain_scale_factor: the scale factor is used to set the initial value and the bounds of the gain
                             parameter, computed as 1 / gain_scale_factor.
   :type gain_scale_factor: float, optional
   :param cutoff: proportion after which the step function is cut off.
   :type cutoff: float, optional

   .. rubric:: Notes

   The Edelman function is explained in :cite:t:`edelman_over_1947`.

   The impulse response function for this class can be viewed on the Documentation
   website or using `latexify` by running the following code in a Jupyter notebook
   environment::

       ps.Edelman.impulse















   ..
       !! processed by numpydoc !!
Methods
-------

.. autoapisummary::

   pastas.rfunc.Edelman.get_init_parameters
   pastas.rfunc.Edelman.get_tmax
   pastas.rfunc.Edelman.impulse
   pastas.rfunc.Edelman.step