updates

Author: luisaFelixSalles

doc/source/user_guide/tutorials/plot/plotting_data_on_specific_placements.rst

@@ -152,7 +152,7 @@ Plot the result on the path
 Create the plotter and add fields and meshes. For more information about
 plotting data on a mesh check the tutorial: :ref:`ref_plotting_data_on_the_mesh`
 
-First, define the |DpfPlotter| object [2]_ and then add |MeshedRegion|
+First, define the |DpfPlotter| object [2]_, then add |MeshedRegion|
 to it using the |add_mesh| method and add the field using the |add_field| method.
 
 To display the figure built by the plotter object use the |show_figure|  method.
@@ -375,18 +375,18 @@ elements with shape functions.
 
     # Map the points coordinates with the displacement results and get the field
     mapped_disp_points = ops.mapping.on_coordinates(fields_container=my_disp,
-                                               coordinates=dpf.fields_factory.field_from_array(arr=my_points.coordinates.data),
-                                               create_support=True,
-                                               mesh=my_meshed_region
-                                               ).eval()[0]
+                                                    coordinates=dpf.fields_factory.field_from_array(arr=my_points.coordinates.data),
+                                                    create_support=True,
+                                                    mesh=my_meshed_region
+                                                    ).eval()[0]
 
 Plot displacement field on the points
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Create the plotter and add fields and meshes. For more information about
 plotting data on a mesh check the tutorial: :ref:`ref_plotting_data_on_the_mesh`
 
-First, define the |DpfPlotter| object [2]_ and then add |MeshedRegion|
+First, define the |DpfPlotter| object [2]_, then add |MeshedRegion|
 to it using the |add_mesh| method and add the field using the |add_field| method.
 
 To display the figure built by the plotter object use the |show_figure| method.
@@ -409,10 +409,10 @@ To display the figure built by the plotter object use the |show_figure| method.
     :hide-code:
 
     mapped_disp_points = ops.mapping.on_coordinates(fields_container=my_disp,
-                                               coordinates=dpf.fields_factory.field_from_array(arr=my_points.coordinates.data),
-                                               create_support=True,
-                                               mesh=my_meshed_region
-                                               ).eval()[0]
+                                                    coordinates=dpf.fields_factory.field_from_array(arr=my_points.coordinates.data),
+                                                    create_support=True,
+                                                    mesh=my_meshed_region
+                                                    ).eval()[0]
     my_plotter = dpf.plotter.DpfPlotter()
     my_plotter.add_mesh(meshed_region=my_meshed_region,style="surface", show_edges=True, color="w", opacity=0.3)
     my_plotter.add_field(field=mapped_disp_points,point_size=20.0, render_points_as_spheres=True)
@@ -433,7 +433,7 @@ Check the `Create points`_ section to understand how we defined the points coord
 .. code-block:: python
 
     # Create the Line object
-    my_line = geo.Line(coordinates=[[0.0, 0.06, 0.0], [0.03, 0.03, 0.03]]
+    my_line = geo.Line(coordinates=[[0.0, 0.06, 0.0], [0.03, 0.03, 0.03]],
                        n_points=50
                        )
 
@@ -452,7 +452,7 @@ You can plot the |Line| together with the mesh:
  .. jupyter-execute::
     :hide-code:
 
-    my_line = geo.Line(coordinates=[[0.0, 0.06, 0.0], [0.03, 0.03, 0.03]]
+    my_line = geo.Line(coordinates=[[0.0, 0.06, 0.0], [0.03, 0.03, 0.03]],
                        n_points=50
                        )
     my_line.plot(mesh=my_meshed_region, cpos=camera_position)
@@ -471,18 +471,19 @@ elements with shape functions.
 
     # Map the line coordinates with the displacement results and get the field
     mapped_disp_line = ops.mapping.on_coordinates(fields_container=my_disp,
-                                               coordinates=my_line.mesh.nodes.coordinates_field,
-                                               create_support=True,
-                                               mesh=my_meshed_region
-                                               ).eval()[0]
+                                                  coordinates=my_line.mesh.nodes.coordinates_field,
+                                                  create_support=True,
+                                                  mesh=my_meshed_region
+                                                   ).eval()[0]
 
 Plot displacement field on the line
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+Plot displacement field on the |Line| and display mesh in background.
 Create the plotter and add fields and meshes. For more information about
 plotting data on a mesh check the tutorial: :ref:`ref_plotting_data_on_the_mesh`
 
-First, define the |DpfPlotter| object [2]_ and then add |MeshedRegion|
+First, define the |DpfPlotter| object [2]_, then add |MeshedRegion|
 to it using the |add_mesh| method and add the field using the |add_field| method.
 
 To display the figure built by the plotter object use the |show_figure| method.
@@ -505,13 +506,13 @@ To display the figure built by the plotter object use the |show_figure| method.
     :hide-code:
 
     mapped_disp_line = ops.mapping.on_coordinates(fields_container=my_disp,
-                                               coordinates=my_line.mesh.nodes.coordinates_field),
-                                               create_support=True,
-                                               mesh=my_meshed_region
-                                               ).eval()[0]
+                                                  coordinates=my_line.mesh.nodes.coordinates_field,
+                                                  create_support=True,
+                                                  mesh=my_meshed_region
+                                                   ).eval()[0]
     my_plotter = dpf.plotter.DpfPlotter()
     my_plotter.add_mesh(meshed_region=my_meshed_region,style="surface", show_edges=True, color="w", opacity=0.3)
-    my_plotter.add_field(field=mapped_disp_line)
+    my_plotter.add_field(field=mapped_disp_line,meshed_region=my_line.mesh)
     my_plotter.show_figure(show_axes=True, cpos=camera_position)
 
 Plane
@@ -576,18 +577,19 @@ elements with shape functions.
 
     # Map the line coordinates with the displacement results and get the field
     mapped_disp_plane = ops.mapping.on_coordinates(fields_container=my_disp,
-                                               coordinates=my_plane.mesh.nodes.coordinates_field,
-                                               create_support=True,
-                                               mesh=my_meshed_region
-                                               ).eval()[0]
+                                                   coordinates=my_plane.mesh.nodes.coordinates_field,
+                                                   create_support=True,
+                                                   mesh=my_meshed_region
+                                                   ).eval()[0]
 
 Plot displacement field on the plane
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+Plot displacement field on the |Plane| and display mesh in background.
 Create the plotter and add fields and meshes. For more information about
 plotting data on a mesh check the tutorial: :ref:`ref_plotting_data_on_the_mesh`
 
-First, define the |DpfPlotter| object [2]_ and then add |MeshedRegion|
+First, define the |DpfPlotter| object [2]_, then add |MeshedRegion|
 to it using the |add_mesh| method and add the field using the |add_field| method.
 
 To display the figure built by the plotter object use the |show_figure| method.
@@ -600,7 +602,7 @@ To display the figure built by the plotter object use the |show_figure| method.
     # We use custom style for the mesh so we can visualise the points
     my_plotter.add_mesh(meshed_region=my_meshed_region,style="surface", show_edges=True, color="w", opacity=0.3)
     # Add the Field to the DpfPlotter object
-    my_plotter.add_field(field=mapped_disp_plane)
+    my_plotter.add_field(field=mapped_disp_plane, meshed_region=my_plane.mesh, show_edges=False)
     # Display the plot
     my_plotter.show_figure(show_axes=True, cpos=camera_position)
 
@@ -610,13 +612,13 @@ To display the figure built by the plotter object use the |show_figure| method.
     :hide-code:
 
     mapped_disp_plane = ops.mapping.on_coordinates(fields_container=my_disp,
-                                               coordinates=my_plane.mesh.nodes.coordinates_field,
-                                               create_support=True,
-                                               mesh=my_meshed_region
-                                               ).eval()[0]
+                                                   coordinates=my_plane.mesh.nodes.coordinates_field,
+                                                   create_support=True,
+                                                   mesh=my_meshed_region
+                                                   ).eval()[0]
     my_plotter = dpf.plotter.DpfPlotter()
     my_plotter.add_mesh(meshed_region=my_meshed_region,style="surface", show_edges=True, color="w", opacity=0.3)
-    my_plotter.add_field(field=mapped_disp_plane)
+    my_plotter.add_field(field=mapped_disp_plane, meshed_region=my_plane.mesh, show_edges=False)
     my_plotter.show_figure(show_axes=True, cpos=camera_position)
 
 .. rubric:: Footnotes

doc/source/user_guide/tutorials/plot/plotting_data_on_the_mesh.rst

@@ -10,6 +10,9 @@ Plotting data on the mesh
 .. |plot| replace:: :func:`plot()<ansys.dpf.core.field.Field.plot>`
 .. |plotMesh| replace:: :func:`plot()<ansys.dpf.core.meshed_region.MeshedRegion.plot>`
 .. |DpfPlotter| replace:: :class:`DpfPlotter<ansys.dpf.core.plotter.DpfPlotter>`
+.. |add_mesh| replace:: :func:`add_mesh()<ansys.dpf.core.plotter.DpfPlotter.add_mesh>`
+.. |add_field| replace:: :func:`add_field()<ansys.dpf.core.plotter.DpfPlotter.add_field>`
+.. |show_figure| replace:: :func:`show_figure()<ansys.dpf.core.plotter.DpfPlotter.show_figure>`
 .. |Field| replace:: :class:`Field<ansys.dpf.core.field.Field>`
 .. |FieldsContainer| replace:: :class:`FieldsContainer<ansys.dpf.core.field.Field>`
 
@@ -167,12 +170,10 @@ You have to give the Fields supporting mesh as a attribute:
 Using the DpfPlotter class
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-First define the |DpfPlotter| object [2]_ and then add the Field
-to it using the :func:`add_field()<ansys.dpf.core.plotter.DpfPlotter.add_field>` method.
+First define the |DpfPlotter| object [2]_ and then add the Field to it using the |add_field| method.
 You have to give the Fields supporting mesh as an attribute to this method.
 
-To display the figure built by the plotter object you need to use the
-:func:`show_figure()<ansys.dpf.core.plotter.DpfPlotter.show_figure>`  method.
+To display the figure built by the plotter object you need to use the |show_figure|  method.
 
 .. code-block:: python
 
@@ -242,11 +243,9 @@ Using the DpfPlotter class
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 First, define the |DpfPlotter| object [2]_ and then add |MeshedRegion|
-to it using the :func:`add_mesh()<ansys.dpf.core.plotter.DpfPlotter.add_mesh>` method and add the
-field using the :func:`add_field()<ansys.dpf.core.plotter.DpfPlotter.add_field>` method.
+to it using the |add_mesh| method and add the field using the |add_field| method.
 
-To display the figure built by the plotter object use the
-:func:`show_figure()<ansys.dpf.core.plotter.DpfPlotter.show_figure>`  method.
+To display the figure built by the plotter object use the |show_figure|  method.
 
 .. code-block:: python
 
@@ -291,5 +290,4 @@ parameter (the argument must be supported by the installed PyVista version).
 The default |DpfPlotter| object settings display the mesh with edges and lighting
 enabled. Nevertheless, as we use the `PyVista <https://github.com/pyvista/pyvista>`_
 library to create the plot you can use additional PyVista arguments for the |DpfPlotter|
-object and :func:`add_field()<ansys.dpf.core.plotter.DpfPlotter.add_field>` method
-(available at: :func:`pyvista.plot`).
+object and |add_field| method (available at: :func:`pyvista.plot`).

doc/source/user_guide/tutorials/plot/plotting_meshes.rst

@@ -8,6 +8,8 @@ Plotting meshes
 .. |Model| replace:: :class:`Model <ansys.dpf.core.model.Model>`
 .. |plot| replace:: :func:`plot()<ansys.dpf.core.model.Model.plot>`
 .. |DpfPlotter| replace:: :class:`DpfPlotter<ansys.dpf.core.plotter.DpfPlotter>`
+.. |add_mesh| replace:: :func:`add_mesh()<ansys.dpf.core.plotter.DpfPlotter.add_mesh>`
+.. |show_figure| replace:: :func:`show_figure()<ansys.dpf.core.plotter.DpfPlotter.show_figure>`
 
 DPF-Core has a variety of plotting methods for generating 3D plots of
 Ansys models directly from Python. These methods use VTK and leverage
@@ -142,10 +144,10 @@ parameter (the argument must be supported by the installed PyVista version).
 More information about the available arguments are available at :class:`pyvista.Plotter`.
 
 First you have to define the |DpfPlotter| object and then add the |MeshedRegion|
-to it using the :func::func:`add_mesh()<ansys.dpf.core.plotter.DpfPlotter.add_mesh>` method.
+to it using the |add_mesh| method.
 
 To display the figure built by the plotter object you need to use the
-:func:`show_figure()<ansys.dpf.core.plotter.DpfPlotter.show_figure>`  method.
+|show_figure|  method.
 
 .. code-block:: python
 
@@ -168,7 +170,7 @@ To display the figure built by the plotter object you need to use the
 The default |DpfPlotter| object settings display the mesh with edges,and lighting
 enabled. Nevertheless, as we use the `PyVista <https://github.com/pyvista/pyvista>`_
 library to create the plot you can use additional PyVista arguments for the |DpfPlotter|
-object and :func:`add_mesh()<ansys.dpf.core.plotter.DpfPlotter.add_mesh>` method
+object and |add_mesh| method
 (available at: :func:`pyvista.plot`).
 
 You can also plot results data on its supporting mesh. For a detailed demonstration