Add ScopingsContainer.plot

Author: PProfizi

src/ansys/dpf/core/scopings_container.py

@@ -28,9 +28,16 @@
 Contains classes associated to the DPF ScopingsContainer
 """
 
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 from ansys.dpf.core import scoping
 from ansys.dpf.core.collection_base import CollectionBase
 
+if TYPE_CHECKING:
+    from ansys.dpf.core import MeshedRegion, MeshesContainer
+
 
 class ScopingsContainer(CollectionBase[scoping.Scoping]):
     """A class used to represent a ScopingsContainer which contains scopings split on a given space.
@@ -125,3 +132,69 @@ def add_scoping(self, label_space, scoping):
             DPF scoping to add.
         """
         return super()._add_entry(label_space, scoping)
+
+    def plot(
+        self,
+        mesh: MeshedRegion | MeshesContainer,
+        show_mesh: bool = False,
+        colors: list[str] = None,
+        **kwargs,
+    ):
+        """Plot the entities of the mesh or meshes corresponding to the scopings.
+
+        Parameters
+        ----------
+        mesh:
+            Mesh or meshes to use to translate the scopings into mesh entities.
+            Associates each scoping to a mesh using labels if ``mesh`` is a collection of meshes.
+        show_mesh:
+            Whether to also show the mesh with low opacity.
+        colors:
+            List of colors to use for the scoping entities.
+        **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_1 = dpf.Scoping(
+        ...    location=dpf.locations.nodal,
+        ...    ids=mesh.nodes.scoping.ids[0:100]
+        ...)
+        >>> node_scoping_2 = dpf.Scoping(
+        ...    location=dpf.locations.nodal,
+        ...    ids=mesh.nodes.scoping.ids[300:400]
+        ...)
+        >>> node_sc = dpf.ScopingsContainer()
+        >>> node_sc.add_label(label="scoping", default_value=1)
+        >>> node_sc.add_scoping(label_space={"scoping": 1}, scoping=node_scoping_1)
+        >>> node_sc.add_scoping(label_space={"scoping": 2}, scoping=node_scoping_2)
+        >>> node_sc.plot(mesh=mesh, show_mesh=True)
+
+        """
+        from itertools import cycle
+
+        from ansys.dpf.core.plotter import DpfPlotter
+
+        colors_cycle = cycle(
+            colors if colors else ["red", "blue", "green", "orange", "black", "yellow"]
+        )
+        plt = DpfPlotter(**kwargs)
+        for i, scoping_i in enumerate(self):
+            plt.add_scoping(
+                scoping=scoping_i,
+                mesh=mesh,
+                color=next(colors_cycle),
+                show_mesh=show_mesh if i == 0 else False,
+                **kwargs,
+            )
+        return plt.show_figure(**kwargs)