Improve the tutorial

Author: PProfizi

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

@@ -43,13 +43,24 @@ Plot a single mesh scoping
 
 Create a single |Scoping| and plot the targeted entities when applied to a single |MeshedRegion|.
 
+First for a node scoping:
+
 .. jupyter-execute::
 
+    # Create a scoping of the first 100 node IDs of the mesh
     node_scoping = dpf.Scoping(location=dpf.locations.nodal, ids=mesh_1.nodes.scoping.ids[0:100])
+    # Plot the node scoping applied to the mesh, with nodes shown as red dots
     node_scoping.plot(mesh=mesh_1, color="red")
+
+Then for an element scoping:
+
+.. jupyter-execute::
+
+    # Create a scoping of the first 100 elements IDs of the mesh
     element_scoping = dpf.Scoping(
         location=dpf.locations.elemental, ids=mesh_1.elements.scoping.ids[0:100]
     )
+    # Plot the element scoping applied to the mesh, with elements shown in green
     element_scoping.plot(mesh=mesh_1, color="green")
 
 
@@ -61,30 +72,49 @@ and plot targeted entities of a |MeshedRegion|.
 
 .. jupyter-execute::
 
+    # Create a scoping of the first 100 node IDs of the mesh
     node_scoping_1 = dpf.Scoping(location=dpf.locations.nodal, ids=mesh_1.nodes.scoping.ids[0:100])
+    # Create a scoping of the 300th to 400th node IDs of the mesh
     node_scoping_2 = dpf.Scoping(
         location=dpf.locations.nodal, ids=mesh_1.nodes.scoping.ids[300:400]
     )
+    # Create a ScopingsContainer
     node_sc = dpf.ScopingsContainer()
+    # Add at least one label to the collection to identify entries
     node_sc.add_label(label="scoping", default_value=1)
+    # Add the first node scoping to the collection
     node_sc.add_scoping(label_space={"scoping": 1}, scoping=node_scoping_1)
+    # Add the second node scoping to the collection
     node_sc.add_scoping(label_space={"scoping": 2}, scoping=node_scoping_2)
+    # Plot the scoping collection applied to the mesh
     node_sc.plot(mesh=mesh_1, show_mesh=True)
 
 Then plot the |ScopingsContainer| applied to a |MeshesContainer| with similarly labeled meshes.
 
 .. jupyter-execute::
 
+    # Create a collection of meshes based on the initial mesh by splitting it by material
     meshes: dpf.MeshesContainer = ops.mesh.split_mesh(mesh=mesh_1, property="mat").eval()
-
-    label_space = {"mat": 1, "body": 1}
+    # Create a node scoping targeting the first 100 node IDs of the mesh for material 1
     node_scoping_3 = dpf.Scoping(
-        location=dpf.locations.nodal, ids=meshes.get_mesh(label_space).nodes.scoping.ids[0:100]
+        location=dpf.locations.nodal,
+        ids=meshes.get_mesh({"mat": 1, "body": 1}).nodes.scoping.ids[0:100],
+    )
+    # Create a node scoping targeting the first 100 node IDs of the mesh for material 2
+    node_scoping_4 = dpf.Scoping(
+        location=dpf.locations.nodal,
+        ids=meshes.get_mesh({"mat": 2, "body": 2}).nodes.scoping.ids[0:100],
     )
+    # Create a collection of scopings
     node_sc_2 = dpf.ScopingsContainer()
+    # Add the appropriate labels to the collection
     node_sc_2.add_label(label="mat")
     node_sc_2.add_label(label="body")
-    node_sc_2.add_scoping(label_space=label_space, scoping=node_scoping_3)
+    # Add the scoping associated to material 1
+    node_sc_2.add_scoping(label_space={"mat": 1, "body": 1}, scoping=node_scoping_3)
+    # Add the scoping associated to material 2
+    node_sc_2.add_scoping(label_space={"mat": 2, "body": 2}, scoping=node_scoping_4)
+    # Plot the collection of scopings applied to the collection of meshes
     node_sc_2.plot(mesh=meshes)
 
 Use DpfPlotter.add_scoping
@@ -94,14 +124,21 @@ We now use the |DpfPlotter| to add scopings applied to |MeshedRegion| to a scene
 
 .. jupyter-execute::
 
+    # Create a node scoping for the first 100 node IDs of the mesh
     node_scoping = dpf.Scoping(location=dpf.locations.nodal, ids=mesh_1.nodes.scoping.ids[0:100])
+    # Create an element scoping for the first 100 elements IDs of the mesh
     element_scoping = dpf.Scoping(
         location=dpf.locations.elemental, ids=mesh_1.elements.scoping.ids[0:100]
     )
 
+    # Import the DpfPlotter
     from ansys.dpf.core.plotter import DpfPlotter
 
+    # Instantiate a DpfPlotter
     plt = DpfPlotter()
+    # Tell the plotter to also show the mesh associated with the first scoping
     plt.add_scoping(node_scoping, mesh_1, show_mesh=True, color="red")
+    # Do not show the mesh for the second scoping as it is the same
     plt.add_scoping(element_scoping, mesh_1, color="green")
+    # Show the resulting scene
     plt.show_figure()