Fix plot behavior when using keywords screenshot and off_screen

ansys/dpf/core/field.py

@@ -237,7 +237,7 @@ def to_nodal(self):
         op.inputs.connect(self)
         return op.outputs.field()
 
-    def plot(self, notebook=None, shell_layers=None):
+    def plot(self, notebook=None, shell_layers=None, **kwargs):
         """Plot the field or fields container on the mesh support if it exists.
 
         Warning
@@ -266,9 +266,12 @@ def plot(self, notebook=None, shell_layers=None):
         shell_layers : shell_layers, optional
             Enum used to set the shell layers if the model to plot
             contains shell elements. The default is ``None``.
+        **kwargs : optional
+            Additional keyword arguments for the plotter. For additional keyword
+            arguments, see ``help(pyvista.plot)``.
         """
-        pl = Plotter(self.meshed_region)
-        pl.plot_contour(self, notebook, shell_layers)
+        pl = Plotter(self.meshed_region, **kwargs)
+        pl.plot_contour(self, notebook, shell_layers, **kwargs)
 
     def resize(self, nentities, datasize):
         """Allocate memory.

ansys/dpf/core/meshed_region.py

@@ -8,7 +8,7 @@
 from ansys.dpf.core.common import locations, types, nodal_properties, elemental_properties
 from ansys.dpf.core.elements import Elements, element_types
 from ansys.dpf.core.nodes import Nodes
-from ansys.dpf.core.plotter import Plotter as _DpfPlotter
+from ansys.dpf.core.plotter import DpfPlotter, Plotter
 from ansys.dpf.core.cache import class_handling_cache
 from ansys.grpc.dpf import meshed_region_pb2, meshed_region_pb2_grpc
 
@@ -406,20 +406,18 @@ def plot(
         >>> model.metadata.meshed_region.plot(field)
 
         """
-        pl = _DpfPlotter(self)
         if field_or_fields_container is not None:
-            return pl.plot_contour(
-                field_or_fields_container,
-                notebook,
-                shell_layers,
-                off_screen,
-                show_axes,
-                **kwargs
-            )
+            pl = Plotter(self, **kwargs)
+            return pl.plot_contour(field_or_fields_container, notebook,
+                                   shell_layers, off_screen, show_axes, **kwargs)
 
-        # otherwise, simply plot self
+        # otherwise, simply plot the mesh
+        kwargs["off_screen"] = off_screen
         kwargs["notebook"] = notebook
-        return pl.plot_mesh(**kwargs)
+        pl = DpfPlotter(**kwargs)
+        pl.add_mesh(self, **kwargs)
+        kwargs["show_axes"] = show_axes
+        return pl.show_figure(**kwargs)
 
     def deep_copy(self, server=None):
         """Create a deep copy of the meshed region's data on a given server.

ansys/dpf/core/meshes_container.py

@@ -47,6 +47,9 @@ def plot(self, fields_container=None, **kwargs):
         ----------
         fields_container : FieldsContainer, optional
             Data to plot. The default is ``None``.
+        **kwargs : optional
+            Additional keyword arguments for the plotter. For additional keyword
+            arguments, see ``help(pyvista.plot)``.
 
         Examples
         --------
@@ -64,9 +67,11 @@ def plot(self, fields_container=None, **kwargs):
         >>> meshes_cont.plot(disp_fc)
 
         """
+        # DPF defaults
         kwargs.setdefault("show_edges", True)
-        notebook = kwargs.pop("notebook", None)
-        pl = DpfPlotter(notebook=notebook)
+        # Initiate plotter
+        pl = DpfPlotter(**kwargs)
+        # If a fields' container is given
         if fields_container is not None:
             for i in range(len(fields_container)):
                 label_space = fields_container.get_label_space(i)
@@ -80,13 +85,15 @@ def plot(self, fields_container=None, **kwargs):
                 field = fields_container[i]
                 pl.add_field(field, mesh_to_send, **kwargs)
         else:
+            # If no field given, associate a random color to each mesh in the container
             from random import random
             random_color = "color" not in kwargs
             for mesh in self:
                 if random_color:
                     kwargs["color"] = [random(), random(), random()]
                 pl.add_mesh(mesh, **kwargs)
-        pl.show_figure()
+        # Plot the figure
+        pl.show_figure(**kwargs)
 
     def get_meshes(self, label_space):
         """Retrieve the meshes at a label space.

ansys/dpf/core/model.py

@@ -214,6 +214,16 @@ def __str__(self):
     def plot(self, color="w", show_edges=True, **kwargs):
         """Plot the mesh of the model.
 
+        Parameters
+        ----------
+        color : str
+            color of the mesh faces in PyVista format. The default is white with ``"w"``.
+        show_edges : bool
+            Whether to show the mesh edges. The default is ``True``.
+        **kwargs : optional
+            Additional keyword arguments for the plotter. For additional keyword
+            arguments, see ``help(pyvista.plot)``.
+
         Examples
         --------
         Plot the model using the default options.
@@ -225,9 +235,12 @@ def plot(self, color="w", show_edges=True, **kwargs):
         >>> model.plot()
 
         """
-        self.metadata.meshed_region.grid.plot(
-            color=color, show_edges=show_edges, **kwargs
-        )
+        from ansys.dpf.core.plotter import DpfPlotter
+        kwargs["color"] = color
+        kwargs["show_edges"] = show_edges
+        pl = DpfPlotter(**kwargs)
+        pl.add_mesh(self.metadata.meshed_region, **kwargs)
+        pl.show_figure(**kwargs)
 
     @property
     def mesh_by_default(self):