recharge
========

.. py:module:: pastas.recharge

.. autoapi-nested-parse::

   This module contains the classes for recharge models.

   This module contains the different classes that can be used to simulate the effect of
   precipitation and evapotranspiration on groundwater levels. Depending on the
   mathematical formulation this effect may be interpreted as:

   1. seepage to the groundwater
   2. precipitation excess,
   3. groundwater recharge.

   For the implementation of each model we refer to the references listed in the
   documentation of each recharge model.

   The classes defined here are designed to be used in conjunction with the stressmodel
   "RechargeModel", which requires an instance of one of the classes defined here.

   .. codeauthor:: R.A. Collenteur, University of Graz

   .. seealso::

      :py:obj:`pastas.stressmodels.RechargeModel`
          The recharge models listed above are provided to a RechargeModel.

   .. rubric:: Examples

   Use recharge models with a RechargeModel stress model::

       rch = ps.rch.FlexModel()
       sm = ps.RechargeModel(prec, evap, recharge=rch, rfunc=ps.Gamma(), name="rch")
       ml.add_stressmodel(sm)

   After solving a model, the simulated recharge flux can be obtained::

       rch_sim = ml.get_stress("rch")

   ..
       !! processed by numpydoc !!


Classes
-------

.. toctree::
   :hidden:

   /api/pastas/recharge/RechargeBase
   /api/pastas/recharge/Linear
   /api/pastas/recharge/FlexModel
   /api/pastas/recharge/Berendrecht
   /api/pastas/recharge/Peterson

.. autoapisummary::

   pastas.recharge.RechargeBase
   pastas.recharge.Linear
   pastas.recharge.FlexModel
   pastas.recharge.Berendrecht
   pastas.recharge.Peterson