Simulation#

class PySeismoSoil.class_simulation.Simulation(soil_profile: Vs_Profile, input_motion: Ground_Motion, *, boundary: Literal['elastic', 'rigid'] = 'elastic', G_param: PySeismoSoil.class_parameters.HH_Param_Multi_Layer | PySeismoSoil.class_parameters.MKZ_Param_Multi_Layer | None = None, xi_param: PySeismoSoil.class_parameters.HH_Param_Multi_Layer | PySeismoSoil.class_parameters.MKZ_Param_Multi_Layer | None = None, GGmax_and_damping_curves: PySeismoSoil.class_curves.Multiple_GGmax_Damping_Curves | None = None)[source]#

Bases: object

Class implementation of a base site response simulation.

Parameters:

  • soil_profile (Vs_Profile) – Soil profile.

  • input_motion (Ground_Motion) – Input ground motion. It should be the “rock outcrop” motion if boundary is set to "elastic", and it should be the recorded motion at the bottom of the Vs profile (i.e., the “borehole” motion) if boundary is set to "rigid".

  • boundary (Literal['elastic', 'rigid']) – Boundary condition. “Elastic” means that the boundary allows waves to propagate through. “Rigid” means that all downgoing waves are reflected back to the soil medium.

  • G_param (HH_Param_Multi_Layer | MKZ_Param_Multi_Layer | None) – Parameters that describe the G/Gmax curves.

  • xi_param (HH_Param_Multi_Layer | MKZ_Param_Multi_Layer | None) – Parameters that describe the damping curves.

  • GGmax_and_damping_curves (Multiple_GGmax_Damping_Curves | None) – G/Gmax and damping curves of every soil layer.

soil_profile#

Same as the input parameter soil_profile.

Type:

Vs_Profile

input_motion#

Same as the input parameter input_motion.

Type:

Ground_Motion

boundary#

Same as the input parameter boundary.

Type:

Literal[‘elastic’, ‘rigid’]

G_param#

Same as the input parameter G_param.

Type:

HH_Param_Multi_Layer | MKZ_Param_Multi_Layer | None

xi_param#

Same as the input parameter xi_param.

Type:

HH_Param_Multi_Layer | MKZ_Param_Multi_Layer | None

GGmax_and_damping_curves#

Same as the input parameter GGmax_and_damping_curves.

Type:

Multiple_GGmax_Damping_Curves | None

Raises:

  • TypeError – When input arguments have incorrect or incompatible types

  • ValueError – When input arguments have incorrect or invalid values