salvus.mesh.data_structures.salvus_mesh.side_sets

def legacy_from_side_set(
    side_set: SideSet,
) -> tuple[npt.NDArray, npt.NDArray]: ...

Convert a SideSet data structure to the legacy format.

def legacy_from_side_sets(
    side_sets: tuple[SideSet, ...],
) -> dict[str, tuple[npt.NDArray, npt.NDArray]]: ...

Convert a list of SideSet data structures to the legacy format.

def side_set_from_legacy(
    legacy_name: str, legacy_data: tuple[npt.NDArray, npt.NDArray]
) -> SideSet: ...

Convert a single legacy side set to the new SideSet data structure.

def side_sets_from_legacy(
    legacy_data: dict[str, tuple[npt.NDArray, npt.NDArray]],
) -> tuple[SideSet, ...]: ...

Convert legacy side set data to the new SideSet data structure.

New format makes having a key-based storage superfluous. Anything on a mesh has a retrieval method.

class BoundaryCondition(enum.Enum):
    def __init__(self): ...

Enumeration of supported boundary conditions for side sets.

Note that this enumeration is the union of allowed types between the wave equation (elastic and acoustic), the diffusion equation, and the Poisson equation.

class SideSet(builtins.object):
    def __init__(
        self,
        name: str,
        element_ids: npt.NDArray[np.int64],
        face_ids: npt.NDArray[np.int64],
        boundary_condition: BoundaryCondition | None = None,
        boundary_condition_parameters: (
            AbsorbingBoundaryParameters | None
        ) = None,
    ) -> None: ...

Side set data structure for defining boundary facets on a mesh.

Elements refer to a mesh’ elements by their global index. Facets are referred to by their local (in-element) index.

def identity(name: str) -> SideSet: ...

def from_legacy(
    legacy_name: str, legacy_data: tuple[npt.NDArray, npt.NDArray]
) -> SideSet: ...