Site_Effect_Adjustment#

class PySeismoSoil.class_site_effect_adjustment.Site_Effect_Adjustment(input_motion: Ground_Motion, Vs30_in_meter_per_sec: float, z1_in_m: float | None = None, ampl_method: Literal['nl_hh', 'eq_hh'] = 'nl_hh', lenient: bool = False)[source]#

Bases: object

Adjusts rock-outcrop ground motions by applying site effect adjustment using the SAG19 site factors.

Parameters:

  • input_motion (Ground_Motion) – Input ground motion.

  • Vs30_in_meter_per_sec (float) – Vs30 values in SI unit.

  • z1_in_m (float | None) – z1 (basin depth) in meters. If None, it will be estimated from Vs30 using an empirical correlation (see calc_z1_from_Vs30() function in helper_site_response.py).

  • ampl_method (Literal['nl_hh', 'eq_hh']) – Which site response simulation method was used to calculate the amplification factors. ‘nl_hh’ uses the results from nonlinear site response simulation, which is recommended.

  • lenient (bool) – Whether to ensure the given Vs30, z1, and PGA values are within the valid range. If False and the given values fall outside the valid range, the given values (e.g., Vs30 = 170 m/s) will be treated as the closest boundary values (e.g., Vs30 = 175 m/s).

input_motion#

Input ground motion.

Type:

Ground_Motion

Vs30#

Vs30 of the site. (Unit: m/s)

Type:

float

z1#

z1 (basin depth) of the site. (Unit: m/s)

Type:

float

PGA_in_g#

Peak ground acceleration of the input motion. (Unit: g)

Type:

float

Raises:

  • TypeError – When input arguments do not have correct type

  • ValueError – When the value of ampl_method is not one of {‘nl_hh’, ‘eq_hh’}

Methods Summary

run([show_fig, return_fig_obj])

Run the site effect adjustment by querying the SAG19 site factors.

Methods Documentation

run(show_fig: bool = False, return_fig_obj: bool = False, **kwargs_to_plot: dict[Any, Any]) → tuple[PySeismoSoil.class_ground_motion.Ground_Motion, matplotlib.figure.Figure | None, matplotlib.axes._axes.Axes | None][source]#

Run the site effect adjustment by querying the SAG19 site factors.

Parameters:

  • show_fig (bool) – Whether to show a figure demonstrating how the adjustment works.

  • return_fig_obj (bool) – Whether to return the figure and axes objects.

  • **kwargs_to_plot (dict[Any, Any]) – Keyword arguments to pass to matplotlib.pyplot.plot().

Returns:

  • output_motion (Ground_Motion) – Output ground motion with site effects included.

  • fig (Figure | None) – The figure object.

  • ax (Axes | None) – The axes object.