transition_function#

PySeismoSoil.helper_hh_model.transition_function(gamma: ndarray, *, a: float, gamma_t: float) → ndarray[source]#

Calculate the transition function of the HH model, as defined in Equation (7) of Shi & Asimaki (2017).

Parameters:

  • gamma (np.ndarray) – The shear strain array. Must be a 1D array. Its unit should be ‘1’, rather than ‘%’.

  • a (float) – A shape parameter describing how fast the transition happens.

  • gamma_t (float) – Transition strain: the x value at which the transition happens.

Returns:

w – The transition function, ranging from 0 to 1. Same shape as x.

Return type:

np.ndarray