Mondaic
This API reference is not for the latest stable Salvus version.

salvus.mesh.mesh.smoothiesem

Smoothiesem Global Mesh

Functions

run_mesher_smoothiesem()

def run_mesher_smoothiesem(
    inputs: Union[salvus.mesh.simple_mesh.SmoothieSEM, dict],
    mesh_processing_callback: Optional[
        Callable, SurfaceMaskGenerator, RayMaskGenerator
    ] = None,
    n_axial_mask: Optional[int] = None,
    nsection: Optional[int] = None,
    cutout: bool = False,
    make_unique_points: bool = True,
    vizualization_side_sets: bool = False,
    verbose: bool = False,
) -> salvus.mesh.unstructured_mesh.UnstructuredMesh:
    ...
Parameters
  • inputs Union[salvus.mesh.simple_mesh.SmoothieSEM, dict] — SmoothieSEM simple config
  • mesh_processing_callback Optional[Callable, SurfaceMaskGenerator, RayMaskGenerator] — a function that takes an UnstructureMesh as the only input and returns the same type. E.g. useful to mask the mesh.
  • n_axial_mask Optional[int] — how many elements to cut out for the cylindrical part. Defaults should work well for allmost all cases. (EXPERIMENTAL)
  • nsection Optional[int] — only mesh the first n azimuthal sections (for tube meshes, EXPERIMENTAL)
  • cutout bool — cut out some elements for visualization (EXPERIMENTAL)
  • make_unique_points bool — making unique points is pretty expensive, depending on postprocessing it’s not needed though (EXPERIMENTAL)
  • vizualization_side_sets bool — add additional sides sets for vizualization of the mesh in paraview (EXPERIMENTAL)
  • verbose bool — print some debugging info
Returns salvus.mesh.unstructured_mesh.UnstructuredMesh

Classes

SmoothieSEMLateralRefinement

class SmoothieSEMLateralRefinement(builtins.object):
    def __init__(
        self,
        theta_min: float,
        theta_max: float,
        r_min: float,
        r_max: float = 0.0,
        phi_min: float = -180.0,
        phi_max: float = 180.0,
        scale: float = 1.0,
    ):
        ...

an object to store lateral refinement parameters for SmoothieSEM in an immutable way

Parameters
  • theta_min float — minimum colatitude
  • theta_max float — maximum colatitude
  • r_min float — minimum radius in km
  • r_max float — maximum radius in km
  • phi_min float — minmum longitude
  • phi_max float — maximum longitude
  • scale float — potential scaling used in the mesh
Attributes
phi_max float

maximum longitude

phi_min float

minimum longitude

r_max float

maximum adius

r_min float

minmum radius

theta_max float

maximum colatitude

theta_min float

mimimum colatitude