Version:

salvus.mesh.layered_meshing.meshing_protocol.coarsening_policy.intralayer_variable

salvus.mesh.layered_meshing.meshing_protocol.coarsening_policy.intralayer_variable salvus mesh layered_meshing meshing_protocol coarsening_policy intralayer_variable
Constant size function.

Classes

IntralayerVariable

Use a constant element size in each dimension.
SIGNATURE
class IntralayerVariable(
    salvus.mesh.layered_meshing.meshing_protocol.coarsening_policy.IntralayerCoarseningPolicy
):
    def __init__(
        self,
        fixed_horizontal_element_boundaries: list[list[float]] = default,
        min_layer_thickness: float | None = None,
        allow_deformed_bounding_interfaces: bool = False,
    ) -> None: ...
ARGUMENTS
Optional
fixed_horizontal_element_boundaries
Type:list[list[float]]
Default value:<factory>
Description:
An optional array of horizontal coordinate values where fixed element boundaries should occur. Useful for respecting the mesh of simple vertical structures and the like. For 3-D meshes one can pass a list of lists of values, which correspond to the first and second coordinate axes (i.e x and y) respectively.
Optional
min_layer_thickness
Type:float | None
Default value:None
Description:
If a float is specified here, mask out all elements in this layer where the layer thickness is less than this value. Useful for masking out elements in shallow water layers.
Optional
allow_deformed_bounding_interfaces
Type:bool
Default value:False
Description:
This policy reduces the wavelength oracle to its minimum value along the horizontal axes, and therefore works best when the mesh is regular. If maintaining a strict average number of elements per wavelength is not critical for the application, setting this value to True will allow for the policy to be injected in cases where the bounding interfaces are not flat.

Methods

IntralayerVariable.basic_block()
Returns a MeshBlock that has potentially variable element sizes.
SIGNATURE
def basic_block(
    self,
    elm_p_wav: tuple[float, ...],
    n_elm_h: list[int],
    n_elm_c: int,
    i_bot: Interface,
    i_top: Interface,
    b_flat: float,
    t_flat: float,
    mw: _pd.realized.RealizedParameter,
    cs: CoordinateSystem,
) -> list[MeshBlock]: ...
ARGUMENTS
Required
elm_p_wav
Type:tuple[float, ...]
Description:
The number of elements per wavelength.
Required
n_elm_h
Type:list[int]
Description:
The number of elements in the horizontal directions.
Required
n_elm_c
Type:int
Description:
The total number of elements in the connectors.
Required
i_bot
Type:Interface
Description:
The bottom interface.
Required
i_top
Type:Interface
Description:
The top interface.
Required
b_flat
Type:float
Description:
The bottom elevation of the flattened mesh block.
Required
t_flat
Type:float
Description:
The top elevation of the flattened mesh block.
Required
mw
Type:_pd.realized.RealizedParameter
Description:
The minimum wavelengths.
Required
cs
Type:CoordinateSystem
Description:
The coordinate system.
PAGE CONTENTS