RechargeModel#

class RechargeModel(prec, evap, rfunc=None, name='recharge', recharge=None, temp=None, settings=('prec', 'evap', 'evap'), metadata=(None, None, None))[source]#

Stressmodel simulating the effect of groundwater recharge on the head.

Parameters:

prec (pandas.Series) – pandas.Series with pandas.DatetimeIndex containing the precipitation series.
evap (pandas.Series) – pandas.Series with pandas.DatetimeIndex containing the potential evaporation series.
rfunc (pastas.rfunc instance, optional) – Instance of the response function used in the convolution with the stress. Default is ps.Exponential().
name (str, optional) – Name of the stress. Default is “recharge”.
recharge (pastas.recharge instance, optional) – Instance of a recharge model. Options are: Linear, FlexModel and Berendrecht. These can be accessed through ps.rch. Default is ps.rch.Linear().
temp (pandas.Series, optional) – pandas.Series with pandas.DatetimeIndex containing the temperature series. It depends on the recharge model is this argument is required or not.
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 (defined in ps.rcParams[“timeseries”]), or a dict with the settings to apply. Refer to the docs of pastas.Timeseries for further information.
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__`
`get_nsplit`	Determine in how many time series the contribution can be split.
`get_settings`	Method to obtain the settings of the stresses.
`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 RechargeModel object.
`update_stress`	Method to update the settings of the all stresses in the stress model.