pastas.model.Model.get_response_tmax

pastas.model.Model.get_response_tmax(name: str, p: pastas.typing.ArrayLike = None, cutoff: float = 0.999, warn: bool = True) → float | None

Method to get the tmax used for the response function.

Parameters:

• name (str) – A string with the name of the stressmodel.

• p (array_like, optional) – An array_like object with the values as floats representing the model parameters. See Model.get_parameters() for more info if parameters is None.

• cutoff (float, optional) – A float between 0 and 1. Default is 0.999 or 99.9% of the response.

Returns:

tmax – A float with the number of days. None is return if stressmodels has no response function.

Return type:

float or None

Examples

>>> ml.get_response_tmax("recharge", cutoff=0.99)
>>> 703

This means that after 703 days, 99% of the response of the groundwater levels to a recharge pulse has taken place.