custom title for mesh.plot(field) (#131)

* Update plotter.py

adding recognition of "text" in kwargs for contour_plot, adding a title on the lower_edge using pyvista.Plotter.add_text

* Add test_plot_fields_on_mesh_scoping_title

Add test_plot_fields_on_mesh_scoping_title to test the additional "text" argument for custom titles with mesh.plot(field)

* Update test_plotter.py

Remove blanks on line 210 to avoid flake8 error on build

Author: TheGoldfish01

ansys/dpf/core/plotter.py

@@ -271,6 +271,9 @@ def plot_contour(
         kwargs.setdefault("show_edges", True)
         kwargs.setdefault("nan_color", "grey")
         kwargs.setdefault("stitle", name)
+        text = kwargs.pop('text', None)
+        if text is not None:
+            plotter.add_text(text, position='lower_edge')
         plotter.add_mesh(mesh.grid, scalars=overall_data, **kwargs)
 
         if background is not None:

tests/test_plotter.py

@@ -208,6 +208,23 @@ def test_plot_fields_on_mesh_scoping(multishells):
     mesh.plot(s[0])
 
 
+@pytest.mark.skipif(not HAS_PYVISTA, reason="Please install pyvista")
+def test_plot_fields_on_mesh_scoping_title(multishells):
+    model = core.Model(multishells)
+    mesh = model.metadata.meshed_region
+    stress = model.results.stress()
+    stress.inputs.requested_location.connect("Nodal")
+    scoping = core.Scoping()
+    scoping.location = "Nodal"
+    l = list(range(0, 400))
+    l += list(range(1500, 2000))
+    l += list(range(2200, 2600))
+    scoping.ids = l
+    stress.inputs.mesh_scoping.connect(scoping)
+    s = stress.outputs.fields_container()
+    mesh.plot(s[0], text="test")
+
+
 @pytest.mark.skipif(not HAS_PYVISTA, reason="Please install pyvista")
 def test_throw_on_several_time_steps(plate_msup):
     model = core.Model(plate_msup)