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

salvus.mesh.simple_mesh

User-friendly meshing interface.

Classes

AxiSEM

class AxiSEM(salvus.mesh.simple_mesh.config.BaseMesh):
    def __init__(self):
        ...

AxiSEM mesh.

Methods
apply()
def apply(self, d: Union[Dict, _DeepSetter]) -> None:
    ...

Set the contents with a dictionary.

Parameters
  • d Union[Dict, _DeepSetter] — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter:
    ...

Return a deep copy of the object.

Returns _DeepSetter
create_mesh()
def create_mesh(
    self,
    verbose: bool = False,
    get_dictionary: bool = False,
    mesh_processing_callback: Optional[
        Callable, SurfaceMaskGenerator, RayMaskGenerator
    ] = None,
) -> Union[
    Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict],
    salvus.mesh.unstructured_mesh.UnstructuredMesh,
]:
    ...

Create the actual unstructured mesh object.

Parameters
  • verbose bool — Increase verbosity.
  • get_dictionary bool — Return the dictionary defining the mesh.
  • mesh_processing_callback Optional[Callable, SurfaceMaskGenerator, RayMaskGenerator] — optional call back function for mesh processing called directly after the mesh is finished to do efficient post processing, e.g. masking
Returns Union[Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict], salvus.mesh.unstructured_mesh.UnstructuredMesh]
get_dictionary()
def get_dictionary(self) -> Dict:
    ...

Get the contents of this object as a dictionary.

Returns Dict
validate()
def validate(self) -> None:
    ...

Validates the current state of the configuration against its schema.

Returns None

AxiSEMCartesian

class AxiSEMCartesian(salvus.mesh.simple_mesh.config.BaseMesh):
    def __init__(self):
        ...

AxiSEMCartesian mesh.

Methods
apply()
def apply(self, d: Union[Dict, _DeepSetter]) -> None:
    ...

Set the contents with a dictionary.

Parameters
  • d Union[Dict, _DeepSetter] — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter:
    ...

Return a deep copy of the object.

Returns _DeepSetter
create_mesh()
def create_mesh(
    self,
    verbose: bool = False,
    get_dictionary: bool = False,
    mesh_processing_callback: Optional[
        Callable, SurfaceMaskGenerator, RayMaskGenerator
    ] = None,
) -> Union[
    Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict],
    salvus.mesh.unstructured_mesh.UnstructuredMesh,
]:
    ...

Create the actual unstructured mesh object.

Parameters
  • verbose bool — Increase verbosity.
  • get_dictionary bool — Return the dictionary defining the mesh.
  • mesh_processing_callback Optional[Callable, SurfaceMaskGenerator, RayMaskGenerator] — optional call back function for mesh processing called directly after the mesh is finished to do efficient post processing, e.g. masking
Returns Union[Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict], salvus.mesh.unstructured_mesh.UnstructuredMesh]
get_dictionary()
def get_dictionary(self) -> Dict:
    ...

Get the contents of this object as a dictionary.

Returns Dict
validate()
def validate(self) -> None:
    ...

Validates the current state of the configuration against its schema.

Returns None

Cartesian2D

class Cartesian2D(salvus.mesh.simple_mesh.config.BaseMesh):
    def __init__(self):
        ...

Cartesian2D mesh.

Methods
apply()
def apply(self, d: Union[Dict, _DeepSetter]) -> None:
    ...

Set the contents with a dictionary.

Parameters
  • d Union[Dict, _DeepSetter] — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter:
    ...

Return a deep copy of the object.

Returns _DeepSetter
create_mesh()
def create_mesh(
    self,
    verbose: bool = False,
    get_dictionary: bool = False,
    mesh_processing_callback: Optional[
        Callable, SurfaceMaskGenerator, RayMaskGenerator
    ] = None,
) -> Union[
    Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict],
    salvus.mesh.unstructured_mesh.UnstructuredMesh,
]:
    ...

Create the actual unstructured mesh object.

Parameters
  • verbose bool — Increase verbosity.
  • get_dictionary bool — Return the dictionary defining the mesh.
  • mesh_processing_callback Optional[Callable, SurfaceMaskGenerator, RayMaskGenerator] — optional call back function for mesh processing called directly after the mesh is finished to do efficient post processing, e.g. masking
Returns Union[Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict], salvus.mesh.unstructured_mesh.UnstructuredMesh]
get_dictionary()
def get_dictionary(self) -> Dict:
    ...

Get the contents of this object as a dictionary.

Returns Dict
validate()
def validate(self) -> None:
    ...

Validates the current state of the configuration against its schema.

Returns None

Cartesian2DHomogeneous

class Cartesian2DHomogeneous(salvus.mesh.simple_mesh.config.BaseMesh):
    def __init__(self):
        ...

Cartesian2DHomogeneous mesh.

Methods
apply()
def apply(self, d: Union[Dict, _DeepSetter]) -> None:
    ...

Set the contents with a dictionary.

Parameters
  • d Union[Dict, _DeepSetter] — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter:
    ...

Return a deep copy of the object.

Returns _DeepSetter
create_mesh()
def create_mesh(
    self,
    verbose: bool = False,
    get_dictionary: bool = False,
    mesh_processing_callback: Optional[
        Callable, SurfaceMaskGenerator, RayMaskGenerator
    ] = None,
) -> Union[
    Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict],
    salvus.mesh.unstructured_mesh.UnstructuredMesh,
]:
    ...

Create the actual unstructured mesh object.

Parameters
  • verbose bool — Increase verbosity.
  • get_dictionary bool — Return the dictionary defining the mesh.
  • mesh_processing_callback Optional[Callable, SurfaceMaskGenerator, RayMaskGenerator] — optional call back function for mesh processing called directly after the mesh is finished to do efficient post processing, e.g. masking
Returns Union[Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict], salvus.mesh.unstructured_mesh.UnstructuredMesh]
get_dictionary()
def get_dictionary(self) -> Dict:
    ...

Get the contents of this object as a dictionary.

Returns Dict
validate()
def validate(self) -> None:
    ...

Validates the current state of the configuration against its schema.

Returns None

Cartesian3D

class Cartesian3D(salvus.mesh.simple_mesh.config.BaseMesh):
    def __init__(self):
        ...

Cartesian3D mesh.

Methods
apply()
def apply(self, d: Union[Dict, _DeepSetter]) -> None:
    ...

Set the contents with a dictionary.

Parameters
  • d Union[Dict, _DeepSetter] — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter:
    ...

Return a deep copy of the object.

Returns _DeepSetter
create_mesh()
def create_mesh(
    self,
    verbose: bool = False,
    get_dictionary: bool = False,
    mesh_processing_callback: Optional[
        Callable, SurfaceMaskGenerator, RayMaskGenerator
    ] = None,
) -> Union[
    Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict],
    salvus.mesh.unstructured_mesh.UnstructuredMesh,
]:
    ...

Create the actual unstructured mesh object.

Parameters
  • verbose bool — Increase verbosity.
  • get_dictionary bool — Return the dictionary defining the mesh.
  • mesh_processing_callback Optional[Callable, SurfaceMaskGenerator, RayMaskGenerator] — optional call back function for mesh processing called directly after the mesh is finished to do efficient post processing, e.g. masking
Returns Union[Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict], salvus.mesh.unstructured_mesh.UnstructuredMesh]
get_dictionary()
def get_dictionary(self) -> Dict:
    ...

Get the contents of this object as a dictionary.

Returns Dict
validate()
def validate(self) -> None:
    ...

Validates the current state of the configuration against its schema.

Returns None

Cartesian3DHomogeneous

class Cartesian3DHomogeneous(salvus.mesh.simple_mesh.config.BaseMesh):
    def __init__(self):
        ...

Cartesian3DHomogeneous mesh.

Methods
apply()
def apply(self, d: Union[Dict, _DeepSetter]) -> None:
    ...

Set the contents with a dictionary.

Parameters
  • d Union[Dict, _DeepSetter] — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter:
    ...

Return a deep copy of the object.

Returns _DeepSetter
create_mesh()
def create_mesh(
    self,
    verbose: bool = False,
    get_dictionary: bool = False,
    mesh_processing_callback: Optional[
        Callable, SurfaceMaskGenerator, RayMaskGenerator
    ] = None,
) -> Union[
    Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict],
    salvus.mesh.unstructured_mesh.UnstructuredMesh,
]:
    ...

Create the actual unstructured mesh object.

Parameters
  • verbose bool — Increase verbosity.
  • get_dictionary bool — Return the dictionary defining the mesh.
  • mesh_processing_callback Optional[Callable, SurfaceMaskGenerator, RayMaskGenerator] — optional call back function for mesh processing called directly after the mesh is finished to do efficient post processing, e.g. masking
Returns Union[Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict], salvus.mesh.unstructured_mesh.UnstructuredMesh]
get_dictionary()
def get_dictionary(self) -> Dict:
    ...

Get the contents of this object as a dictionary.

Returns Dict
validate()
def validate(self) -> None:
    ...

Validates the current state of the configuration against its schema.

Returns None

Circular2D

class Circular2D(salvus.mesh.simple_mesh.config.BaseMesh):
    def __init__(self):
        ...

Circular2D mesh.

Methods
apply()
def apply(self, d: Union[Dict, _DeepSetter]) -> None:
    ...

Set the contents with a dictionary.

Parameters
  • d Union[Dict, _DeepSetter] — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter:
    ...

Return a deep copy of the object.

Returns _DeepSetter
create_mesh()
def create_mesh(
    self,
    verbose: bool = False,
    get_dictionary: bool = False,
    mesh_processing_callback: Optional[
        Callable, SurfaceMaskGenerator, RayMaskGenerator
    ] = None,
) -> Union[
    Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict],
    salvus.mesh.unstructured_mesh.UnstructuredMesh,
]:
    ...

Create the actual unstructured mesh object.

Parameters
  • verbose bool — Increase verbosity.
  • get_dictionary bool — Return the dictionary defining the mesh.
  • mesh_processing_callback Optional[Callable, SurfaceMaskGenerator, RayMaskGenerator] — optional call back function for mesh processing called directly after the mesh is finished to do efficient post processing, e.g. masking
Returns Union[Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict], salvus.mesh.unstructured_mesh.UnstructuredMesh]
get_dictionary()
def get_dictionary(self) -> Dict:
    ...

Get the contents of this object as a dictionary.

Returns Dict
validate()
def validate(self) -> None:
    ...

Validates the current state of the configuration against its schema.

Returns None

Globe3D

class Globe3D(salvus.mesh.simple_mesh.config.BaseMesh):
    def __init__(self):
        ...

Globe3D mesh.

Methods
apply()
def apply(self, d: Union[Dict, _DeepSetter]) -> None:
    ...

Set the contents with a dictionary.

Parameters
  • d Union[Dict, _DeepSetter] — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter:
    ...

Return a deep copy of the object.

Returns _DeepSetter
create_mesh()
def create_mesh(
    self,
    verbose: bool = False,
    get_dictionary: bool = False,
    mesh_processing_callback: Optional[
        Callable, SurfaceMaskGenerator, RayMaskGenerator
    ] = None,
) -> Union[
    Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict],
    salvus.mesh.unstructured_mesh.UnstructuredMesh,
]:
    ...

Create the actual unstructured mesh object.

Parameters
  • verbose bool — Increase verbosity.
  • get_dictionary bool — Return the dictionary defining the mesh.
  • mesh_processing_callback Optional[Callable, SurfaceMaskGenerator, RayMaskGenerator] — optional call back function for mesh processing called directly after the mesh is finished to do efficient post processing, e.g. masking
Returns Union[Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict], salvus.mesh.unstructured_mesh.UnstructuredMesh]
get_dictionary()
def get_dictionary(self) -> Dict:
    ...

Get the contents of this object as a dictionary.

Returns Dict
validate()
def validate(self) -> None:
    ...

Validates the current state of the configuration against its schema.

Returns None

Globe3DSurfaceWaves

class Globe3DSurfaceWaves(salvus.mesh.simple_mesh.config.BaseMesh):
    def __init__(self):
        ...

Globe3DSurfaceWaves mesh.

Methods
apply()
def apply(self, d: Union[Dict, _DeepSetter]) -> None:
    ...

Set the contents with a dictionary.

Parameters
  • d Union[Dict, _DeepSetter] — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter:
    ...

Return a deep copy of the object.

Returns _DeepSetter
create_mesh()
def create_mesh(
    self,
    verbose: bool = False,
    get_dictionary: bool = False,
    mesh_processing_callback: Optional[
        Callable, SurfaceMaskGenerator, RayMaskGenerator
    ] = None,
) -> Union[
    Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict],
    salvus.mesh.unstructured_mesh.UnstructuredMesh,
]:
    ...

Create the actual unstructured mesh object.

Parameters
  • verbose bool — Increase verbosity.
  • get_dictionary bool — Return the dictionary defining the mesh.
  • mesh_processing_callback Optional[Callable, SurfaceMaskGenerator, RayMaskGenerator] — optional call back function for mesh processing called directly after the mesh is finished to do efficient post processing, e.g. masking
Returns Union[Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict], salvus.mesh.unstructured_mesh.UnstructuredMesh]
get_dictionary()
def get_dictionary(self) -> Dict:
    ...

Get the contents of this object as a dictionary.

Returns Dict
validate()
def validate(self) -> None:
    ...

Validates the current state of the configuration against its schema.

Returns None

SmoothieSEM

class SmoothieSEM(salvus.mesh.simple_mesh.config.BaseMesh):
    def __init__(self):
        ...

SmoothieSEM mesh.

Methods
apply()
def apply(self, d: Union[Dict, _DeepSetter]) -> None:
    ...

Set the contents with a dictionary.

Parameters
  • d Union[Dict, _DeepSetter] — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter:
    ...

Return a deep copy of the object.

Returns _DeepSetter
create_mesh()
def create_mesh(
    self,
    verbose: bool = False,
    get_dictionary: bool = False,
    mesh_processing_callback: Optional[
        Callable, SurfaceMaskGenerator, RayMaskGenerator
    ] = None,
) -> Union[
    Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict],
    salvus.mesh.unstructured_mesh.UnstructuredMesh,
]:
    ...

Create the actual unstructured mesh object.

Parameters
  • verbose bool — Increase verbosity.
  • get_dictionary bool — Return the dictionary defining the mesh.
  • mesh_processing_callback Optional[Callable, SurfaceMaskGenerator, RayMaskGenerator] — optional call back function for mesh processing called directly after the mesh is finished to do efficient post processing, e.g. masking
Returns Union[Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict], salvus.mesh.unstructured_mesh.UnstructuredMesh]
get_dictionary()
def get_dictionary(self) -> Dict:
    ...

Get the contents of this object as a dictionary.

Returns Dict
validate()
def validate(self) -> None:
    ...

Validates the current state of the configuration against its schema.

Returns None

SphericalChunk3D

class SphericalChunk3D(salvus.mesh.simple_mesh.config.BaseMesh):
    def __init__(self):
        ...

SphericalChunk3D mesh.

Methods
apply()
def apply(self, d: Union[Dict, _DeepSetter]) -> None:
    ...

Set the contents with a dictionary.

Parameters
  • d Union[Dict, _DeepSetter] — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter:
    ...

Return a deep copy of the object.

Returns _DeepSetter
create_mesh()
def create_mesh(
    self,
    verbose: bool = False,
    get_dictionary: bool = False,
    mesh_processing_callback: Optional[
        Callable, SurfaceMaskGenerator, RayMaskGenerator
    ] = None,
) -> Union[
    Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict],
    salvus.mesh.unstructured_mesh.UnstructuredMesh,
]:
    ...

Create the actual unstructured mesh object.

Parameters
  • verbose bool — Increase verbosity.
  • get_dictionary bool — Return the dictionary defining the mesh.
  • mesh_processing_callback Optional[Callable, SurfaceMaskGenerator, RayMaskGenerator] — optional call back function for mesh processing called directly after the mesh is finished to do efficient post processing, e.g. masking
Returns Union[Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict], salvus.mesh.unstructured_mesh.UnstructuredMesh]
get_dictionary()
def get_dictionary(self) -> Dict:
    ...

Get the contents of this object as a dictionary.

Returns Dict
validate()
def validate(self) -> None:
    ...

Validates the current state of the configuration against its schema.

Returns None

SphericalChunk3DSurfaceWaves

class SphericalChunk3DSurfaceWaves(salvus.mesh.simple_mesh.config.BaseMesh):
    def __init__(self):
        ...

SphericalChunk3DSurfaceWaves mesh.

Methods
apply()
def apply(self, d: Union[Dict, _DeepSetter]) -> None:
    ...

Set the contents with a dictionary.

Parameters
  • d Union[Dict, _DeepSetter] — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter:
    ...

Return a deep copy of the object.

Returns _DeepSetter
create_mesh()
def create_mesh(
    self,
    verbose: bool = False,
    get_dictionary: bool = False,
    mesh_processing_callback: Optional[
        Callable, SurfaceMaskGenerator, RayMaskGenerator
    ] = None,
) -> Union[
    Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict],
    salvus.mesh.unstructured_mesh.UnstructuredMesh,
]:
    ...

Create the actual unstructured mesh object.

Parameters
  • verbose bool — Increase verbosity.
  • get_dictionary bool — Return the dictionary defining the mesh.
  • mesh_processing_callback Optional[Callable, SurfaceMaskGenerator, RayMaskGenerator] — optional call back function for mesh processing called directly after the mesh is finished to do efficient post processing, e.g. masking
Returns Union[Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict], salvus.mesh.unstructured_mesh.UnstructuredMesh]
get_dictionary()
def get_dictionary(self) -> Dict:
    ...

Get the contents of this object as a dictionary.

Returns Dict
validate()
def validate(self) -> None:
    ...

Validates the current state of the configuration against its schema.

Returns None

TidalLoading

class TidalLoading(salvus.mesh.simple_mesh.config.BaseMesh):
    def __init__(self):
        ...

TidalLoading mesh.

Methods
apply()
def apply(self, d: Union[Dict, _DeepSetter]) -> None:
    ...

Set the contents with a dictionary.

Parameters
  • d Union[Dict, _DeepSetter] — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter:
    ...

Return a deep copy of the object.

Returns _DeepSetter
create_mesh()
def create_mesh(
    self,
    verbose: bool = False,
    get_dictionary: bool = False,
    mesh_processing_callback: Optional[
        Callable, SurfaceMaskGenerator, RayMaskGenerator
    ] = None,
) -> Union[
    Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict],
    salvus.mesh.unstructured_mesh.UnstructuredMesh,
]:
    ...

Create the actual unstructured mesh object.

Parameters
  • verbose bool — Increase verbosity.
  • get_dictionary bool — Return the dictionary defining the mesh.
  • mesh_processing_callback Optional[Callable, SurfaceMaskGenerator, RayMaskGenerator] — optional call back function for mesh processing called directly after the mesh is finished to do efficient post processing, e.g. masking
Returns Union[Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict], salvus.mesh.unstructured_mesh.UnstructuredMesh]
get_dictionary()
def get_dictionary(self) -> Dict:
    ...

Get the contents of this object as a dictionary.

Returns Dict
validate()
def validate(self) -> None:
    ...

Validates the current state of the configuration against its schema.

Returns None

TidalLoading

class TidalLoading(salvus.mesh.simple_mesh.config.BaseMesh):
    def __init__(self):
        ...

TidalLoading mesh.

Methods
apply()
def apply(self, d: Union[Dict, _DeepSetter]) -> None:
    ...

Set the contents with a dictionary.

Parameters
  • d Union[Dict, _DeepSetter] — The dictionary to set.
Returns None
copy()
def copy(self) -> _DeepSetter:
    ...

Return a deep copy of the object.

Returns _DeepSetter
create_mesh()
def create_mesh(
    self,
    verbose: bool = False,
    get_dictionary: bool = False,
    mesh_processing_callback: Optional[
        Callable, SurfaceMaskGenerator, RayMaskGenerator
    ] = None,
) -> Union[
    Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict],
    salvus.mesh.unstructured_mesh.UnstructuredMesh,
]:
    ...

Create the actual unstructured mesh object.

Parameters
  • verbose bool — Increase verbosity.
  • get_dictionary bool — Return the dictionary defining the mesh.
  • mesh_processing_callback Optional[Callable, SurfaceMaskGenerator, RayMaskGenerator] — optional call back function for mesh processing called directly after the mesh is finished to do efficient post processing, e.g. masking
Returns Union[Tuple[salvus.mesh.unstructured_mesh.UnstructuredMesh, Dict], salvus.mesh.unstructured_mesh.UnstructuredMesh]
get_dictionary()
def get_dictionary(self) -> Dict:
    ...

Get the contents of this object as a dictionary.

Returns Dict
validate()
def validate(self) -> None:
    ...

Validates the current state of the configuration against its schema.

Returns None

Submodules