ThresholdTransform#

class ThresholdTransform(value=nan, vmin=nan, vmax=nan, name='ThresholdTransform', nparam=2)[source]#

ThresholdTransform lowers the simulation when it exceeds a certain value.

Parameters
  • value (float, optional) – The starting value above which the simulation is lowered

  • vmin (float, optional) – The minimum value above which the simulation is lowered

  • vmin – The maximum value above which the simulation is lowered

  • name (str, optional) – Name of the transform

  • nparam (int, optional) – The number of parameters. Default is nparam=2. The first parameter then is the threshold, and the second parameter is the factor with which the simulation is lowered.

Notes

In geohydrology this transform can be used in a situation where the groundwater level reaches the surface level and forms a lake. Because of the larger storage of the lake, the (groundwater) level then rises slower when it rains.

Methods#

__init__

set_init_parameters

set_model

simulate

to_dict