feat: Add StructuredGrid support (#180)

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Roberto Pastor Muela <[email protected]>

Author: 3 people

doc/changelog.d/180.added.md

@@ -0,0 +1 @@
+feat: Add StructuredGrid support

examples/00-basic-pyvista-examples/picker.py

@@ -97,3 +97,36 @@ def name(self):
 pl.plot(mesh_object_cube)
 pl.plot(mesh_object_sphere)
 pl.show()
+
+
+############################
+# Using StructuredGrid mesh
+# ==========================
+
+import numpy as np
+
+
+class CustomStructuredObject:
+    def __init__(self):
+        self.name = "CustomObject"
+        xrng = np.arange(-10, 10, 2, dtype=np.float32)
+        yrng = np.arange(-10, 10, 5, dtype=np.float32)
+        zrng = np.arange(-10, 10, 1, dtype=np.float32)
+        x, y, z = np.meshgrid(xrng, yrng, zrng, indexing='ij')
+        grid = pv.StructuredGrid(x, y, z)
+        self.mesh = grid
+
+    def get_mesh(self):
+        return self.mesh
+
+    def name(self):
+        return self.name
+
+
+pv_backend = PyVistaBackend()
+pl = Plotter(backend=pv_backend)
+
+structured_object = CustomStructuredObject()
+mo_plot = MeshObjectPlot(structured_object, structured_object.get_mesh())
+pl.plot(mo_plot)
+pl.show()

src/ansys/tools/visualization_interface/backends/pyvista/pyvista_interface.py

@@ -136,7 +136,7 @@ def view_zy(self) -> None:
         self.scene.view_zy()
 
     def clip(
-        self, mesh: Union[pv.PolyData, pv.MultiBlock], plane: ClipPlane
+        self, mesh: Union[pv.PolyData, pv.MultiBlock, pv.UnstructuredGrid], plane: ClipPlane
     ) -> Union[pv.PolyData, pv.MultiBlock]:
         """Clip a given mesh with a plane.
 
@@ -218,7 +218,7 @@ def plot_edges(self, custom_object: MeshObjectPlot, **plotting_options) -> None:
 
     def plot(
         self,
-        plottable_object: Union[pv.PolyData, pv.MultiBlock, MeshObjectPlot],
+        plottable_object: Union[pv.PolyData, pv.MultiBlock, MeshObjectPlot, pv.UnstructuredGrid],
         name_filter: str = None,
         **plotting_options,
     ) -> None:
@@ -229,7 +229,7 @@ def plot(
 
         Parameters
         ----------
-        plottable_object : Union[pv.PolyData, pv.MultiBlock, MeshObjectPlot]
+        plottable_object : Union[pv.PolyData, pv.MultiBlock, MeshObjectPlot, pv.UnstructuredGrid, pv.StructuredGrid]
             Object to plot.
         name_filter : str, default: None
             Regular expression with the desired name or names to include in the plotter.
@@ -246,7 +246,7 @@ def plot(
             self._show_edges = plotting_options["show_edges"]
 
         # Check what kind of object we are dealing with
-        if isinstance(plottable_object, (pv.PolyData, pv.UnstructuredGrid)):
+        if isinstance(plottable_object, (pv.PolyData, pv.UnstructuredGrid, pv.StructuredGrid)):
             if "clipping_plane" in plotting_options:
                 mesh = self.clip(plottable_object, plotting_options["clipping_plane"])
                 plotting_options.pop("clipping_plane", None)
@@ -273,9 +273,6 @@ def plot_iter(
     ) -> None:
         """Plot elements of an iterable of any type of objects to the scene.
 
-        Supported object types are ``Body``, ``Component``, ``List[pv.PolyData]``,
-        ``pv.MultiBlock``, and ``Sketch``.
-
         Parameters
         ----------
         plotting_list : List[Any]

src/ansys/tools/visualization_interface/backends/pyvista/widgets/mesh_slider.py

@@ -82,6 +82,8 @@ def callback(self, state: bool) -> None:
                     mesh_id = "UnstructuredGrid(" + mesh.memory_address + ")"
                 elif isinstance(mesh, pv.MultiBlock):
                     mesh_id = "MultiBlock(" + mesh.memory_address + ")"
+                elif isinstance(mesh, pv.StructuredGrid):
+                    mesh_id = "StructuredGrid(" + mesh.memory_address + ")"
                 self._mesh_actor_list.append(self.plotter_helper._pl.scene.actors[mesh_id])
                 self.plotter_helper._pl.scene.remove_actor(mesh_id)
 

tests/test_generic_plotter.py

@@ -22,6 +22,7 @@
 """Test module for the generic plotter."""
 from pathlib import Path
 
+import numpy as np
 import pyvista as pv
 
 from ansys.tools.visualization_interface import ClipPlane, MeshObjectPlot, Plotter
@@ -52,6 +53,7 @@ def test_plotter_add_mb():
     pl.plot(mb)
     pl.show()
 
+
 def test_plotter_add_unstructured_grid():
     """Adds unstructured grid to the plotter."""
     pl = Plotter()
@@ -60,6 +62,18 @@ def test_plotter_add_unstructured_grid():
     pl.plot(ug)
     pl.show()
 
+
+def test_plotter_add_structured_grid():
+    """Adds structured grid to the plotter."""
+    pl = Plotter()
+    xrng = np.arange(-10, 10, 2, dtype=np.float32)
+    yrng = np.arange(-10, 10, 5, dtype=np.float32)
+    zrng = np.arange(-10, 10, 1, dtype=np.float32)
+    x, y, z = np.meshgrid(xrng, yrng, zrng, indexing='ij')
+    grid = pv.StructuredGrid(x, y, z)
+    pl.plot(grid)
+    pl.show()
+
 def test_plotter_add_custom():
     """Adds a MeshObjectPlot object to the plotter."""
     sphere = pv.Sphere()
@@ -90,6 +104,19 @@ def test_clipping_plane():
     pl.show()
 
 
+def test_clipping_plane_structured_grid():
+    """Test clipping plane usage with structured grid."""
+    pl = Plotter()
+    xrng = np.arange(-10, 10, 2, dtype=np.float32)
+    yrng = np.arange(-10, 10, 5, dtype=np.float32)
+    zrng = np.arange(-10, 10, 1, dtype=np.float32)
+    x, y, z = np.meshgrid(xrng, yrng, zrng, indexing='ij')
+    grid = pv.StructuredGrid(x, y, z)
+    clipping_plane = ClipPlane()
+    pl.plot(grid, clipping_plane=clipping_plane)
+    pl.show()
+
+
 def test_plotter_add_list():
     """Adds a list to the plotter."""
     pl = Plotter()