Add DpfPlotter.add_scoping and scoping.plot

Author: PProfizi

src/ansys/dpf/core/plotter.py

@@ -36,6 +36,7 @@
 import tempfile
 from typing import TYPE_CHECKING, List, Union
 import warnings
+from xml.etree.ElementInclude import include
 
 import numpy as np
 
@@ -234,6 +235,37 @@ def get_label_at_grid_point(index):
                 )
         return label_actors
 
+    def add_scoping(
+        self,
+        scoping: dpf.core.Scoping,
+        mesh: dpf.core.MeshedRegion,
+        show_mesh: bool = False,
+        **kwargs,
+    ):
+        # Add the mesh to the scene with low opacity
+        if show_mesh:
+            self._plotter.add_mesh(mesh=mesh.grid, opacity=0.3)
+
+        scoping_mesh = None
+
+        # If the scoping is nodal, use the add_points_label method
+        if scoping.location == locations.nodal:
+            node_indexes = np.where(np.isin(mesh.nodes.scoping.ids, scoping.ids))[0]
+            # grid_points = [mesh.grid.points[node_index] for node_index in node_indexes]
+            scoping_mesh = mesh.grid.extract_points(ind=node_indexes, include_cells=False)
+        # If the scoping is elemental, extract their edges and use active scalars to color them
+        if scoping.location == locations.elemental:
+            element_indexes = np.where(np.isin(mesh.elements.scoping.ids, scoping.ids))[0]
+            scoping_mesh = mesh.grid.extract_cells(ind=element_indexes)
+
+        # If the scoping is faces, extract their edges and use active scalars to color them
+        if scoping.location == locations.faces:
+            raise NotImplementedError("Cannot plot a face scoping.")
+
+        # Filter kwargs
+        kwargs_in = _sort_supported_kwargs(bound_method=self._plotter.add_mesh, **kwargs)
+        self._plotter.add_mesh(mesh=scoping_mesh, **kwargs_in)
+
     def add_field(
         self,
         field,
@@ -689,6 +721,55 @@ def add_field(
             **kwargs,
         )
 
+    def add_scoping(
+        self,
+        scoping: dpf.core.Scoping,
+        mesh: dpf.core.MeshedRegion,
+        show_mesh: bool = False,
+        **kwargs,
+    ):
+        """Add a scoping to the plotter.
+
+        A mesh is required to translate the scoping into entities to plot.
+        Tou can plot the mesh along with the scoping entities using ``show_mesh``.
+
+        Parameters
+        ----------
+        scoping:
+            Scoping with a mesh-based location and IDs of entities to plot.
+        mesh:
+            ``MeshedRegion`` to plot the field on.
+        show_mesh:
+            Whether to show the mesh along with the scoping entities.
+        **kwargs : optional
+            Additional keyword arguments for the plotter. More information
+            are available at :func:`pyvista.plot`.
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.download_cfx_mixing_elbow())
+        >>> mesh = model.metadata.meshed_region
+        >>> node_scoping = dpf.Scoping(
+        ...    location=dpf.locations.nodal,
+        ...    ids=mesh.nodes.scoping.ids[0:100]
+        ...)
+        >>> element_scoping = dpf.Scoping(
+        ...    location=dpf.locations.elemental,
+        ...    ids=mesh.elements.scoping.ids[0:100]
+        ...)
+        >>> from ansys.dpf.core.plotter import DpfPlotter
+        >>> plt = DpfPlotter()
+        >>> plt.add_scoping(node_scoping, mesh, show_mesh=True, color="red")
+        >>> plt.add_scoping(element_scoping, mesh, color="green")
+        >>> plt.show_figure()
+
+        """
+        self._internal_plotter.add_scoping(
+            scoping=scoping, mesh=mesh, show_mesh=show_mesh, **kwargs
+        )
+
     def show_figure(self, **kwargs):
         """Plot the figure built by the plotter object.
 

src/ansys/dpf/core/scoping.py

@@ -491,6 +491,48 @@ def as_local_scoping(self):
         """  # noqa: E501
         return _LocalScoping(self)
 
+    def plot(self, mesh, show_mesh: bool = False, **kwargs):
+        """Plot the entities of the mesh corresponding to the scoping.
+
+        Parameters
+        ----------
+        mesh:
+            Mesh to use to translate the scoping into mesh entities.
+        show_mesh:
+            Whether to also show the mesh with low opacity.
+        **kwargs : optional
+            Additional keyword arguments for the plotter. More information
+            are available at :func:`pyvista.plot`.
+
+        Returns
+        -------
+        (cpos, image):
+            Returns what the pyvista.show() method returns based on arguments.
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> from ansys.dpf.core import examples
+        >>> model = dpf.Model(examples.download_cfx_mixing_elbow())
+        >>> mesh = model.metadata.meshed_region
+        >>> node_scoping = dpf.Scoping(
+        ...    location=dpf.locations.nodal,
+        ...    ids=mesh.nodes.scoping.ids[0:100]
+        ...)
+        >>> node_scoping.plot(mesh=mesh, color="red")
+        >>> element_scoping = dpf.Scoping(
+        ...    location=dpf.locations.elemental,
+        ...    ids=mesh.elements.scoping.ids[0:100]
+        ...)
+        >>> element_scoping.plot(mesh=mesh, color="green")
+
+        """
+        from ansys.dpf.core.plotter import DpfPlotter
+
+        plt = DpfPlotter(**kwargs)
+        plt.add_scoping(scoping=self, mesh=mesh, show_mesh=show_mesh, **kwargs)
+        return plt.show_figure(**kwargs)
+
 
 class _LocalScoping(Scoping):
     """Caches the internal data of the scoping so that it can be modified locally.