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

salvus.mesh.mesh_block.mesh_block_collection

Salvus’ mesh block collection class.

Classes

MeshBlockCollection

class MeshBlockCollection(builtins.object):
    def __init__(
        self,
        mesh_blocks: Optional[
            Sequence[salvus.mesh.mesh_block.mesh_block.MeshBlock],
            salvus.mesh.mesh_block.mesh_block.MeshBlock,
        ] = None,
    ):
        ...

A simple collection of a list of mesh block objects.

Parameters
  • mesh_blocks Optional[Sequence[salvus.mesh.mesh_block.mesh_block.MeshBlock], salvus.mesh.mesh_block.mesh_block.MeshBlock] — The mesh blocks making up the collection.
Attributes
ndim int

Dimensionality of the mesh grid collection.

nodes_per_element int

Dimension dependent number of nodes per linear element.

number_of_elements int

Total number of elements in all child mesh grids.

number_of_points int

Total number of grid points in all child mesh grids.

Methods
add_mask()
def add_mask(self, criterion: Callable) -> None:
    ...

Add a mask to each of child mesh grids.

Parameters
  • criterion Callable — callback function with the signature criterion(x, y) for 2D and criterion(x, y, z) for 3D which returns an array of bool, True for those elements that should be masked out.
Returns None
get_unstructured_mesh()
def get_unstructured_mesh(
    self, scale: float = 1.0
) -> salvus.mesh.unstructured_mesh.UnstructuredMesh:
    ...

Convert the list of mesh grids to an unstructured mesh object.

Parameters
  • scale float — The scale of the mesh.
Returns salvus.mesh.unstructured_mesh.UnstructuredMesh
plot()
def plot(self, show: bool = True) -> Optional[matplotlib.figure.Figure]:
    ...

Plot the mesh grid collection.

Parameters
  • show bool — Show the figure.
Returns Optional[matplotlib.figure.Figure]