RechargeModel#

class RechargeModel(prec, evap, rfunc=None, name='recharge', recharge=<pastas.recharge.Linear object>, temp=None, cutoff=0.999, settings=('prec', 'evap', 'evap'), metadata=(None, None, None))[source]#

Stressmodel simulating the effect of groundwater recharge on the groundwater head.

Parameters
  • prec (pandas.Series or pastas.timeseries.TimeSeries) – pandas.Series or pastas.timeseries object containing the precipitation series.

  • evap (pandas.Series or pastas.timeseries.TimeSeries) – pandas.Series or pastas.timeseries object containing the potential evaporation series.

  • rfunc (pastas.rfunc instance (class is deprecated), optional) – Response function used in the convolution with the stress. Default is Exponential.

  • name (str, optional) – Name of the stress. Default is “recharge”.

  • recharge (pastas.recharge instance, optional) – String with the name of the recharge model. Options are: Linear ( default), FlexModel and Berendrecht. These can be accessed through ps.rch.

  • temp (pandas.Series or pastas.timeseries.TimeSeries, optional) – pandas.Series or pastas.TimeSeries object containing the temperature series. It depends on the recharge model is this argument is required or not.

  • cutoff (float, optional) – float between 0 and 1 to determine how long the response is (default) is 99.9% of the actual response time). Used to reduce computation times.

  • settings (list of dicts or str, optional) – The settings of the precipitation and evaporation time series, in this order. This can be a string referring to a predefined settings dict, or a dict with the settings to apply. Refer to the docstring of pastas.Timeseries for further information. Default is ( “prec”, “evap”).

  • metadata (tuple of dicts or list of dicts, optional) – dictionary containing metadata about the stress. This is passed onto the TimeSeries object.

Notes

This stress model computes the contribution of precipitation and potential evaporation in two steps. In the first step a recharge flux is computed by a model determined by the input argument recharge. In the second step this recharge flux is convoluted with a response function to obtain the contribution of recharge to the groundwater levels.

Examples

>>> sm = ps.RechargeModel(rain, evap, rfunc=ps.Exponential(),
>>>                       recharge=ps.rch.FlexModel(), name="rch")
>>> ml.add_stressmodel(sm)

Warning

We recommend not to store a RechargeModel is a variable named rm. This name is already reserved in IPython to remove files and will cause problems later.

Attributes#

nparam

Methods#

__init__

dump_stress

Method to dump all stresses in the stresses list.

get_nsplit

Determine in how many timeseries the contribution can be split.

get_stress

Method to obtain the recharge stress calculated by the model.

get_water_balance

Method to obtain the water balance components.

set_init_parameters

Internal method to set the initial parameters.

simulate

Method to simulate the contribution of recharge to the head.

to_dict

Method to export the StressModel object.

update_stress

Method to update the settings of the individual TimeSeries.