Polder#

class Polder(cutoff=0.999, **kwargs)[source]#

The Polder function, using the standard A, a, b parameters.

Parameters
  • up (bool or None, optional) – indicates whether a positive stress will cause the head to go up (True, default) or down (False), if None the head can go both ways.

  • gain_scale_factor (float, optional) – the scale factor is used to set the initial value and the bounds of the gain parameter, computed as 1 / gain_scale_factor.

  • cutoff (float, optional) – proportion after which the step function is cut off.

Notes

The impulse response function for this class can be viewed on the Documentation website or using latexify by running the following code in a Jupyter notebook environment:

ps.Polder.impulse

The function is explained in Eq. 123.32 in:cite:t:bruggeman_analytical_1999.

Methods#

__init__

block

Method to return the block function.

gain

get_init_parameters

Get initial parameters and bounds.

get_t

Internal method to determine the times at which to evaluate the step response, from t=0.

get_tmax

Method to get the response time for a certain cutoff.

impulse

Method to return the impulse response function.

polder_function

step

Method to return the step function.

to_dict

Method to export the response function to a dictionary.

update_rfunc_settings

Internal method to set the settings of the response function.