Class Geometry

python/dolfinx/mesh.py:276–348

The geometry of a :class:`dolfinx.mesh.Mesh`.

class Geometry(typing.Generic[Real]):
    """The geometry of a :class:`dolfinx.mesh.Mesh`."""

    _cpp_object: _cpp.mesh.Geometry_float32 | _cpp.mesh.Geometry_float64

    def __init__(self, geometry: _cpp.mesh.Geometry_float32 | _cpp.mesh.Geometry_float64):
        """Initialize a geometry from a C++ geometry.

        Args:
            geometry: The C++ geometry object.

        Note:
            Geometry objects should usually be constructed with the
            :func:`create_geometry` and not using this class
            initializer. This class is combined with different base
            classes that depend on the scalar type used in the Geometry.
        """
        self._cpp_object = geometry

    @property
    def cmaps(self) -> list[_CoordinateElement]:
        """The coordinate maps."""
        return [_CoordinateElement(cm) for cm in self._cpp_object.cmaps]

    @property
    def cmap(self) -> _CoordinateElement:
        """The coordinate map (deprecated, use ``cmaps[0]``)."""
        warnings.warn(
            "cmap is deprecated. Use cmaps[0] instead.",
            DeprecationWarning,
            stacklevel=2,
        )
        return self.cmaps[0]

    @property
    def dim(self):
        """Dimension of the Euclidean coordinate system."""
        return self._cpp_object.dim

    @property
    def dofmaps(self) -> list[npt.NDArray[np.int32]]:
        """The geometry dofmaps, one per cell type."""
        return self._cpp_object.dofmaps

    @property
    def dofmap(self) -> npt.NDArray[np.int32]:
        """Dofmap for the geometry (deprecated, use ``dofmaps[0]``).

        Shape is ``(num_cells, dofs_per_cell)``.
        """
        warnings.warn(
            "dofmap is deprecated. Use dofmaps[0] instead.",
            DeprecationWarning,
            stacklevel=2,
        )
        return self._cpp_object.dofmaps[0]

    def index_map(self) -> _IndexMap: