pastas.recharge.FlexModel
=========================

.. toctree::
   :hidden:

   /api/pastas/recharge/FlexModel.get_init_parameters
   /api/pastas/recharge/FlexModel.simulate
   /api/pastas/recharge/FlexModel.get_root_zone_balance
   /api/pastas/recharge/FlexModel.get_interception_balance
   /api/pastas/recharge/FlexModel.get_snow_balance
   /api/pastas/recharge/FlexModel.to_dict

.. py:class:: pastas.recharge.FlexModel(interception: bool = True, snow: bool = False, gw_uptake: bool = False)



   
   Recharge to the groundwater calculated according to
   :cite:t:`collenteur_estimation_2021`.

   :param interception: Use an interception reservoir in the model or not.
   :type interception: bool, optional
   :param snow: Account for snowfall and snowmelt in the model. If True, a temperature series
                should be provided to the RechargeModel.
   :type snow: bool, optional
   :param gw_uptake: If True, the potential evaporation that is left after evaporation from the
                     interception reservoir and the root zone reservoir is subtracted from the
                     recharge flux. An additional parameter can be used to scale the excess
                     evaporation. Note that this is an EXPERIMENTAL FEATURE that may be removed in
                     the future!
   :type gw_uptake: bool, optional

   .. rubric:: Notes

   For a detailed description of the recharge model and parameters we refer to
   :cite:t:`collenteur_estimation_2021`. The water balance for the unsaturated zone
   reservoir is written as:

   .. math::

       \frac{dS}{dt} = P_e - E_a - R

   where the recharge is calculated as:

   .. math::

       R = K_s \left( \frac{S}{S_u}\right) ^\gamma

   If snow=True, a snow reservoir is added on top. For a detailed description of the
   degree-day snow model and parameters we refer to :cite:t:`kavetski_model_2007`.
   The water balance for the snow reservoir is written as:

   .. math::

       \frac{dSs}{dt} = Ps - M

   Note that the preferred unit of the precipitation and evaporation is mm/d and the
   temperature is degree celsius.















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

.. autoapisummary::

   pastas.recharge.FlexModel.get_init_parameters
   pastas.recharge.FlexModel.simulate
   pastas.recharge.FlexModel.get_root_zone_balance
   pastas.recharge.FlexModel.get_interception_balance
   pastas.recharge.FlexModel.get_snow_balance
   pastas.recharge.FlexModel.to_dict