pastas.rfunc.Polder
===================

.. toctree::
   :hidden:

   /api/pastas/rfunc/Polder.get_init_parameters
   /api/pastas/rfunc/Polder.get_tmax
   /api/pastas/rfunc/Polder.gain
   /api/pastas/rfunc/Polder.step
   /api/pastas/rfunc/Polder.moment
   /api/pastas/rfunc/Polder.impulse

.. py:class:: pastas.rfunc.Polder(cutoff: float = 0.999, use_block: bool = True, **kwargs)



   
   The Polder function, using the standard A, a, b parameters.

   :param cutoff: Fraction of the step response after which the response is truncated.
                  Default is 0.999.
   :type cutoff: float, optional
   :param use_block: Use the block response (rather than the impulse response) to simulate
                     the effect of a stress. The block response approximates the stress
                     as uniform during a time interval dt. When False, the impulse response
                     is used which means that the the entire stress occurs midway the time
                     interval dt. The impulse response is generally quicker to compute.
   :type use_block: bool, optional

   .. attribute:: up

      Whether a positive stress causes the head to go up (`True`), down
      (`False`), or either direction (`None`).

      :type: bool or None, optional

   .. attribute:: gain_scale_factor

      Scale factor used to set the initial value and bounds of the gain
      parameter, computed as `1 / gain_scale_factor`.

      :type: float, optional

   .. rubric:: Notes

   The function is explained in Eq. 123.32 in :cite:t:`bruggeman_analytical_1999`.















   ..
       !! processed by numpydoc !!

   .. py:property:: nparam
      :type: int


      
      Number of parameters of the response function.
















      ..
          !! processed by numpydoc !!

Methods
-------

.. autoapisummary::

   pastas.rfunc.Polder.get_init_parameters
   pastas.rfunc.Polder.get_tmax
   pastas.rfunc.Polder.gain
   pastas.rfunc.Polder.step
   pastas.rfunc.Polder.moment
   pastas.rfunc.Polder.impulse