Class Mesh

python/dolfinx/mesh.py:351–442

A mesh.

class Mesh(typing.Generic[Real]):
    """A mesh."""

    _mesh: _cpp.mesh.Mesh_float32 | _cpp.mesh.Mesh_float64
    _topology: Topology
    _geometry: Geometry[Real]
    _ufl_domain: ufl.Mesh | None

    def __init__(
        self,
        msh: _cpp.mesh.Mesh_float32 | _cpp.mesh.Mesh_float64,
        domain: ufl.Mesh | None,
    ):
        """Initialize mesh from a C++ mesh.

        Args:
            msh: A C++ mesh object.
            domain: A UFL domain.

        Note:
            Mesh objects should usually be constructed using
            :func:`create_mesh` and not using this class initializer.
            This class is combined with different base classes that
            depend on the scalar type used in the Mesh.
        """
        self._cpp_object = msh
        self._topology = Topology(self._cpp_object.topology)
        self._geometry = Geometry(self._cpp_object.geometry)
        self._ufl_domain = domain
        if self._ufl_domain is not None:
            self._ufl_domain._ufl_cargo = self._cpp_object  # type: ignore

    @property
    def comm(self):
        """MPI communicator associated with the mesh."""
        return self._cpp_object.comm

    @property
    def name(self):
        """Name of the mesh."""
        return self._cpp_object.name

    @name.setter
    def name(self, value):
        self._cpp_object.name = value

    def ufl_cell(self) -> ufl.Cell:
        """Return the UFL cell type.

        Note:
            This method is required for UFL compatibility.
        """
        return ufl.Cell(self.topology.cell_name())

    def ufl_domain(self) -> ufl.Mesh | None:
        """Return the ufl domain corresponding to the mesh.

        Returns: