Equiv_Linear_Simulation#

class PySeismoSoil.class_simulation.Equiv_Linear_Simulation(soil_profile: Vs_Profile, input_motion: Ground_Motion, GGmax_and_damping_curves: Multiple_GGmax_Damping_Curves, boundary: Literal['elastic', 'rigid'] = 'elastic')[source]#

Bases: Simulation

Equivalent linear 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".

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

  • 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.

Raises:

TypeError – When GGmax_and_damping_curves is None

Methods Summary

run([verbose, show_fig, save_fig, ...])

Start equivalent linear simulation.

Methods Documentation

run(verbose: bool = True, show_fig: bool = False, save_fig: bool = False, motion_name: str | None = None, save_txt: bool = False, save_full_time_history: bool = False, output_dir: str | None = None) → Simulation_Results[source]#

Start equivalent linear simulation.

Parameters:

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

  • show_fig (bool) – Whether to show figures of the simulation results (input and output motions, maximum accel/veloc/displ/strain/stress profiles)

  • save_fig (bool) – Whether to save figures to output_dir. Only effective when show_fig is set to True.

  • motion_name (str | None) – Name of the input ground motion. For example, “Northridge”. If not provided (i.e., None), the current time stamp will be used.

  • save_txt (bool) – Whether to save the results as text files to output_dir.

  • save_full_time_history (bool) – When saving simulation results, whether to save the full time histories (i.e., every time step, every depth) of the acceleration, velocity, displacement, stress, and strain.

  • output_dir (str | None) – Directory for saving the figures and/or result files.

Returns:

sim_results – An object that contains all the simulation results.

Return type:

Simulation_Results