salvus.mesh.data_structures.common

def distinguish_mesh_path(
    filename: pathlib.Path | str,
) -> type[ChunkedMesh | UnstructuredMesh | Mesh]: ...

Distinguish between mesh types based on file contents.

Useful when a path is given and the mesh type is unknown.

def is_mesh_file(filename: pathlib.Path | str) -> bool: ...

Check if a file is a valid Salvus Mesh file.

def is_unstructured_mesh_file(filename: pathlib.Path | str) -> bool: ...

Check if a file is a valid Salvus UnstructuredMesh file.

def read_dim_from_h5(filename: pathlib.Path | str) -> int: ...

Read the spatial dimension of a mesh from an HDF5 file.

def visco_params_in_file(filename: pathlib.Path | str) -> bool: ...

Check if a mesh file contains visco material parameters.

class MeshBlockLike(typing.Protocol):
    def __init__(self):
        ...

Base class for protocol classes.

Protocol classes are defined as::

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example::

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as::

class GenProto(Protocol[T]):
    def meth(self) -> T:
        ...

class MeshLike(typing.Protocol):
    def __init__(self):
        ...

Protocol for operations on block-based meshes.

Mesh and ChunkedMesh implement this protocol.

def to_mesh(self) -> Mesh: ...

def to_unstructured_mesh(self) -> UnstructuredMesh: ...