hh_param_from_profile#

PySeismoSoil.helper_hh_calibration.hh_param_from_profile(vs_profile: ndarray, *, Tmax: numpy.ndarray | None = None, show_fig: bool = False, save_fig: bool = False, fig_output_dir: str | None = None, save_HH_G_file: bool = False, HH_G_file_dir: str | None = None, profile_name: str | None = None, verbose: bool = True) → ndarray[source]#

Get HH parameters of each soil layer from the Vs values of every layer.

Parameters:

  • vs_profile (np.ndarray) –

    Shear-wave velocity profile, as a 2D numpy array. It should have the following columns:

    Thickness (m)

    Vs (m/s)

    Damping

    Density

    Material Number

    …

    …

    …

    …

    …

  • Tmax (np.ndarray | None) – Shear strength of each layer of soil. If None, it will be calculated using a combination of Ladd (1991) and Mohr-Coulomb criteria.

  • show_fig (bool) – Whether to show figures G/Gmax and stress-strain curves of MKZ, FKZ, and HH for each layer.

  • save_fig (bool) – Whether to save the figures to the hard drive. Only effective if show_fig is set to True.

  • fig_output_dir (str | None) – The output directory for the figures. Only effective if show_fig and save_fig are both True.

  • save_HH_G_file (bool) – Whether to save the HH parameters to the hard drive (as a “HH_G” file).

  • HH_G_file_dir (str | None) – The output directory for the “HH_G” file. Only effective if save_HH_G_file is True.

  • profile_name (str | None) – The name of the Vs profile, such as “CE.12345”. If None, a string of current date and time will be used as the profile name.

  • verbose (bool) – Whether to print progresses on the console.

Returns:

HH_G_param – The HH parameters of each layer. It’s a 2D array of shape (9, n_layer). For each layer (i.e., column), the values are in this order:

gamma_t, a, gamma_ref, beta, s, Gmax, mu, Tmax, d

Return type:

np.ndarray

Raises:

ValueError – When HH_G_file_dir is None