Version:

salvus.toolbox.toolbox_geotech

salvus.toolbox.toolbox_geotech salvus toolbox toolbox_geotech
Geotechnical utilities.

Functions

get_simple_building()

Get a mesh modelling a simple idealized skyscraper.
This function will build a "skyscraper" type elastic model from a collection of SalvusMesh structured grid objects. A variety of features are parameterized and can be modified on the fly. This function may serve as a starting point for a more complex or realistic model and mesh as generated by the user.
SIGNATURE
def get_simple_building(
    basement_width: float,
    basement_depth: float,
    building_width: float,
    story_height: float,
    ceiling_height: float,
    wall_width: float,
    n_stories: int,
    vs_min: float,
    f_max: float,
    nelem_per_wavelength: float = 2,
    boundaries: tuple[list[str], float] = (["x0", "x1", "y0"], 10),
    buffer_elements: int = 0,
) -> tuple[UnstructuredMesh, float]: ...
ARGUMENTS
Required
basement_width
Type:float
Description:
Width of basement foundation (below tower).
Required
basement_depth
Type:float
Description:
Depth of basement foundation (below tower).
Required
building_width
Type:float
Description:
Width of building itself.
Required
story_height
Type:float
Description:
Height of each story of the building.
Required
ceiling_height
Type:float
Description:
Thickness of each ceiling.
Required
wall_width
Type:float
Description:
Thickness of the walls.
Required
n_stories
Type:int
Description:
Number of stories.
Required
vs_min
Type:float
Description:
Minimum shear-wave velocity in the model.
Required
f_max
Type:float
Description:
Maximum frequency which will be modelled.
Optional
nelem_per_wavelength
Type:float
Default value:2
Description:
Number of elements per shortest wavelength in the model, calculated from vs_min and f_max.
Optional
boundaries
Type:tuple[list[str], float]
Default value:(['x0', 'x1', 'y0'], 10)
Description:
Extrude the mesh from side sets boundaries[0], by approximately boundaries[1] elements.
Optional
buffer_elements
Type:int
Default value:0
Description:
Add a buffer zone of normal elements between the building and the absorbing boundary layer.
RETURNS
Return type: tuple[UnstructuredMesh, float]
A tuple containing the mesh, along with the minimum boundary extrusion size in meters.

Used in tutorials

Functionality from this module is used in the following tutorials.
PAGE CONTENTS