This API reference is not for the latest stable Salvus version.
salvus.mesh.layered_meshing.layered_model.reductions
Pre-defined reductions for use with layered models.
Functions
get_max_element_size_reduction_function()
get_max_element_size_reduction_function()def get_max_element_size_reduction_function(
n_dim: int, mesh_resolution: salvus.project.components.types.MeshResolution
) -> salvus.mesh.layered_meshing.layered_model.layered_model:
...Create a reduction function that returns the maximum element sizes.
Parameters
n_dimint — The dimension of the layered model.mesh_resolutionsalvus.project.components.types.MeshResolution — The resolution of the desired mesh.
Returns salvus.mesh.layered_meshing.layered_model.layered_model — A function that can be used with
layered_model.reduce_layers(...) to get the maximum allowable element size in each layer.get_min_wavelength_reduction_function()
get_min_wavelength_reduction_function()def get_min_wavelength_reduction_function(
n_dim: int, mesh_resolution: salvus.project.components.types.MeshResolution
) -> salvus.mesh.layered_meshing.layered_model.layered_model:
...Create a reduction function that returns the minimum wavelength.
Parameters
n_dimint — The dimension of the layered model.mesh_resolutionsalvus.project.components.types.MeshResolution — The resolution of the desired mesh.
Returns salvus.mesh.layered_meshing.layered_model.layered_model — A function that can be used with
layered_model.reduce_layers(...) to get the minimum wavelength in each layer.max_elevation()
max_elevation()def max_elevation(
layer: salvus.mesh.layered_meshing.layered_model.layer.Layer,
) -> float:
...Get a layer’s maximum elevation.
Parameters
layersalvus.mesh.layered_meshing.layered_model.layer.Layer — The layer.
Returns float — The layer’s max elevation.
max_layer_thickness()
max_layer_thickness()def max_layer_thickness(
layer: salvus.mesh.layered_meshing.layered_model.layer.Layer,
) -> float:
...Get a layer’s maximum thickness.
Parameters
layersalvus.mesh.layered_meshing.layered_model.layer.Layer — The layer.
Returns float — The layer’s maximum thickness.
min_elevation()
min_elevation()def min_elevation(
layer: salvus.mesh.layered_meshing.layered_model.layer.Layer,
) -> float:
...Get a layer’s maximum elevation.
Parameters
layersalvus.mesh.layered_meshing.layered_model.layer.Layer — The layer.
Returns float — The layer’s max elevation.
min_layer_thickness()
min_layer_thickness()def min_layer_thickness(
layer: salvus.mesh.layered_meshing.layered_model.layer.Layer,
) -> float:
...Get a layer’s minimum thickness.
Parameters
layersalvus.mesh.layered_meshing.layered_model.layer.Layer — The layer.
Returns float — The layer’s minimum thickness.