Mondaic Documentation
www.mondaic.com
Mondaic
Version:
No results found.
python_api
/
salvus
/
mesh
/
layered_meshing
/
layered_model
/
reductions

salvus.mesh.layered_meshing.layered_model.reductions

salvus.mesh.layered_meshing.layered_model.reductions salvus mesh layered_meshing layered_model reductions
Pre-defined reductions for use with layered models.

Functions

get_max_element_size_reduction_function()

Create a reduction function that returns the maximum element sizes.
SIGNATURE
def get_max_element_size_reduction_function(
    reference_frequency: float_,
    elements_per_wavelength: list[tuple[float_, ...]],
) -> layered_model._ReduceLayersProtocol[list[float]]: ...
ARGUMENTS
Required
reference_frequency
Type:float_
Description:
The reference frequency of the simulation.
Required
elements_per_wavelength
Type:list[tuple[float_, ...]]
Description:
The number of elements per wavelength. Must already be expanded to the entire domain, i.e. via a call to MeshResolution.broadcast_elements_per_wavelength(...).
RETURNS
Return type: layered_model._ReduceLayersProtocol[list[float]]
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()

Create a reduction function that returns the minimum wavelength.
SIGNATURE
def get_min_wavelength_reduction_function(
    reference_frequency: float_,
) -> layered_model._ReduceLayersProtocol[realized.RealizedParameter]: ...
ARGUMENTS
Required
reference_frequency
Type:float_
Description:
Frequency to compute the minimum wavelength at.
RETURNS
Return type: layered_model._ReduceLayersProtocol[realized.RealizedParameter]
A function that can be used with layered_model.reduce_layers(...) to get the minimum wavelength in each layer.

max_elevation()

Get a layer's maximum elevation.
SIGNATURE
def max_elevation(layer: layer.Layer) -> float: ...
ARGUMENTS
Required
layer
Type:layer.Layer
Description:
The layer.
RETURNS
Return type: float
The layer's max elevation.

max_layer_thickness()

Get a layer's maximum thickness.
SIGNATURE
def max_layer_thickness(layer: layer.Layer) -> float: ...
ARGUMENTS
Required
layer
Type:layer.Layer
Description:
The layer.
RETURNS
Return type: float
The layer's maximum thickness.

min_elevation()

Get a layer's maximum elevation.
SIGNATURE
def min_elevation(layer: layer.Layer) -> float: ...
ARGUMENTS
Required
layer
Type:layer.Layer
Description:
The layer.
RETURNS
Return type: float
The layer's max elevation.

min_layer_thickness()

Get a layer's minimum thickness.
SIGNATURE
def min_layer_thickness(layer: layer.Layer) -> float: ...
ARGUMENTS
Required
layer
Type:layer.Layer
Description:
The layer.
RETURNS
Return type: float
The layer's minimum thickness.
Previous
plot
Next
meshing_protocol
We use cookies to analyze our traffic, but won't track you until explicit consent is given. Using our contact form will create relevant cookies and transmit data to third party services to keep track of your request. Read more about how we use personal information in our Privacy Policy.
PAGE CONTENTS