WellModel

class WellModel(stress, rfunc, name, distances, up=False, cutoff=0.999, settings='well', sort_wells=True)[source]

Convolution of one or more stresses with one response function.

Parameters
  • stress (list) – list containing the stresses timeseries.

  • rfunc (pastas.rfunc) – this model only works with the HantushWellModel response function.

  • name (str) – Name of the stressmodel.

  • distances (list or list-like) – list of distances to oseries, must be ordered the same as the stresses.

  • up (bool, optional) – whether a positive stress has an increasing or decreasing effect on the model, by default False, in which case positive stress lowers e.g., the groundwater level.

  • 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 (str, list of dict, optional) – settings of the timeseries, by default “well”.

  • sort_wells (bool, optional) – sort wells from closest to furthest, by default True.

Notes

This class implements convolution of multiple series with a the same response function. This can be applied when dealing with multiple wells in a time series model. The distance from an influence to the location of the oseries has to be provided for each stress.

Warning

This model only works with the HantushWellModel response function.

Attributes

nparam

Methods

__init__

Initialize self.

dump_stress

Method to dump all stresses in the stresses list.

get_distances

get_nsplit

Determine in how many timeseries the contribution can be split.

get_parameters

Get parameters including distance to observation point and return as array (dimensions = (nstresses, 4)).

get_stress

Returns the stress or stresses of the time series object as a pandas DataFrame.

handle_stress

Internal method to handle user provided stress in init.

set_init_parameters

Set the initial parameters (back) to their default values.

simulate

to_dict

Method to export the WellModel object.

update_stress

Method to update the settings of the individual TimeSeries.