update the read_mesh_metadata.rst to the tutorials guidelines

Author: luisaFelixSalles

doc/source/user_guide/tutorials/mesh/read_mesh_metadata.rst

@@ -6,88 +6,98 @@ Read a mesh metadata
 
 :bdg-lsdyna:`LSDYNA` :bdg-fluent:`Fluent` :bdg-cfx:`CFX`
 
-.. |MeshedRegion| replace:: :class:`MeshedRegion <ansys.dpf.core.meshed_region.MeshedRegion>`
-.. |Model| replace:: :class:`Model <ansys.dpf.core.model.Model>`
-.. |DataSources| replace:: :class:`Model <ansys.dpf.core.data_sources.DataSources>`
-.. |MeshInfo| replace:: :class:`MeshInfo <ansys.dpf.core.mesh_info.MeshInfo>`
-.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
+.. include:: ../../../links_and_refs.rst
 
 This tutorial explains how to read a mesh metadata (data about the elements, nodes, faces, region, zone ...)
-for LSDYNA, Fluent or CFX result files.
+before extracting the mesh from a result file.
 
-The mesh object in DPF is a |MeshedRegion|. You can obtain a |MeshedRegion| by creating your
-own by scratch or by getting it from a result file. For more information check the
-:ref:`tutorials_create_a_mesh_from_scratch` and :ref:`tutorials_get_mesh_from_result_file` tutorials.
+:jupyter-download-script:`Download tutorial as Python script<read_mesh_metadata>`
+:jupyter-download-notebook:`Download tutorial as Jupyter notebook<read_mesh_metadata>`
 
-We have the |MeshInfo| object to read metadata information before extracting the |MeshedRegion|.
-You can obtain this object by creating a |Model| with a result file.
+Get the result file
+-------------------
 
-Define the |Model|
-------------------
-
-Here we we will download result files available in our |Examples| package.
-For more information about how to import your result file in DPF check
-the :ref:`ref_tutorials_import_data` tutorial section.
+First, import a result file. For this tutorial, you can use one available in the |Examples| module.
+For more information about how to import your own result file in DPF, see the :ref:`ref_tutorials_import_data`
+tutorial section.
 
 .. tab-set::
 
     .. tab-item:: LSDYNA
 
         .. jupyter-execute::
 
-            # Import the ``ansys.dpf.core`` module, including examples files and the operators subpackage
+            # Import the ``ansys.dpf.core`` module
             from ansys.dpf import core as dpf
+            # Import the examples module
             from ansys.dpf.core import examples
-            from ansys.dpf.core import operators as ops
-            # Define the result file
+
+            # Define the result file path
             result_file_path_2 = examples.download_d3plot_beam()
-            # Create the DataSources object
-            my_data_sources_2 = dpf.DataSources()
-            my_data_sources_2.set_result_file_path(filepath=result_file_path_2[0], key="d3plot")
-            my_data_sources_2.add_file_path(filepath=result_file_path_2[3], key="actunits")
-            # Create the model
-            my_model_2 = dpf.Model(data_sources=my_data_sources_2)
-            # Get the mesh
-            my_meshed_region_2 = my_model_2.metadata.meshed_region
 
     .. tab-item:: Fluent
 
         .. jupyter-execute::
 
-            # Import the ``ansys.dpf.core`` module, including examples files and the operators subpackage
+            # Import the ``ansys.dpf.core`` module
             from ansys.dpf import core as dpf
+            # Import the examples module
             from ansys.dpf.core import examples
-            from ansys.dpf.core import operators as ops
-            # Define the result file
+
+            # Define the result file path
             result_file_path_3 = examples.download_fluent_axial_comp()["flprj"]
-            # Create the model
-            my_model_3 = dpf.Model(data_sources=result_file_path_3)
-            # Get the mesh
-            my_meshed_region_3 = my_model_3.metadata.meshed_region
 
     .. tab-item:: CFX
 
         .. jupyter-execute::
 
-            # Import the ``ansys.dpf.core`` module, including examples files and the operators subpackage
+            # Import the ``ansys.dpf.core`` module
             from ansys.dpf import core as dpf
+            # Import the examples module
             from ansys.dpf.core import examples
-            from ansys.dpf.core import operators as ops
-            # Define the result file
+
+            # Define the result file path
             result_file_path_4 = examples.download_cfx_mixing_elbow()
-            # Create the model
-            my_model_4 = dpf.Model(data_sources=result_file_path_4)
-            # Get the mesh
-            my_meshed_region_4 = my_model_4.metadata.meshed_region
+
+Create the |Model|
+------------------
+
+Create a |Model| object with the result file. The |Model| is a helper designed to give shortcuts to
+access the analysis results metadata and to instanciate results providers by opening a |DataSources| or a Streams.
+
+.. tab-set::
+
+    .. tab-item:: LSDYNA
+
+        .. jupyter-execute::
+
+            # Create the DataSources object
+            ds_2 = dpf.DataSources()
+            ds_2.set_result_file_path(filepath=result_file_path_2[0], key="d3plot")
+            ds_2.add_file_path(filepath=result_file_path_2[3], key="actunits")
+            # Create the Model
+            model_2 = dpf.Model(data_sources=ds_2)
+
+    .. tab-item:: Fluent
+
+        .. jupyter-execute::
+
+            # Create the Model
+            model_3 = dpf.Model(data_sources=result_file_path_3)
+
+    .. tab-item:: CFX
+
+        .. jupyter-execute::
+
+            # Create the Model
+            model_4 = dpf.Model(data_sources=result_file_path_4)
 
 Read the mesh metadata
 ----------------------
 
-The |Model| is a helper designed to give shortcuts to access the analysis results
-metadata, by opening a DataSources or a Streams, and to instanciate results provider
-for it.
+You can access the mesh metadata with the |MeshInfo| object. It reads the metadata information before extracting
+the MeshedRegion from the result file.
 
-From the |Model| you can access the |MeshedRegion| metadata information with the |MeshInfo| object.
 The mesh metadata information includes :
 
 - Properties;
@@ -98,7 +108,7 @@ The mesh metadata information includes :
 - Number of nodes and elements;
 - Elements types.
 
-Get the the mesh metadata information and print the available ones:
+Get the the mesh metadata information and print the available ones.
 
 .. tab-set::
 
@@ -107,30 +117,34 @@ Get the the mesh metadata information and print the available ones:
         .. jupyter-execute::
 
             # Get the mesh metadata information
-            my_mesh_info_2 = my_model_2.metadata.mesh_info
+            mesh_info_2 = model_2.metadata.mesh_info
+
             # Print the mesh metadata information
-            print(my_mesh_info_2)
+            print(mesh_info_2)
 
     .. tab-item:: Fluent
 
         .. jupyter-execute::
 
             # Get the mesh metadata information
-            my_mesh_info_3 = my_model_3.metadata.mesh_info
+            mesh_info_3 = model_3.metadata.mesh_info
+
             # Print the mesh metadata information
-            print(my_mesh_info_3)
+            print(mesh_info_3)
 
     .. tab-item:: CFX
 
         .. jupyter-execute::
 
             # Get the mesh metadata information
-            my_mesh_info_4 = my_model_4.metadata.mesh_info
+            mesh_info_4 = model_4.metadata.mesh_info
+
             # Print the mesh metadata information
-            print(my_mesh_info_4)
+            print(mesh_info_4)
 
 You can extract each of those mesh information by manipulating the |MeshInfo| object properties.
-For example we can check the part names (for the LSDYNA result file) or the cell zone names
+
+For example, we can check the part names (for the LSDYNA result file) or the cell zone names
 (for the Fluent or CFX result files):
 
 .. tab-set::
@@ -140,24 +154,30 @@ For example we can check the part names (for the LSDYNA result file) or the cell
         .. jupyter-execute::
 
             # Get the part names
-            my_cell_zones_2 = my_mesh_info_2.get_property("part_names")
-            print(my_cell_zones_2)
+            cell_zones_2 = mesh_info_2.get_property("part_names")
+
+            # Print the part names
+            print(cell_zones_2)
 
     .. tab-item:: Fluent
 
         .. jupyter-execute::
 
             # Get the cell zone names
-            my_cell_zones_3 = my_mesh_info_3.get_property("cell_zone_names")
-            print(my_cell_zones_3)
+            cell_zones_3 = mesh_info_3.get_property("cell_zone_names")
+
+            # Print the cell zone names
+            print(cell_zones_3)
 
     .. tab-item:: CFX
 
         .. jupyter-execute::
 
             # Get the cell zone names
-            my_cell_zones_4 = my_mesh_info_4.get_property("cell_zone_names")
-            print(my_cell_zones_4)
+            cell_zones_4 = mesh_info_4.get_property("cell_zone_names")
+
+            # Print the cell zone names
+            print(cell_zones_4)
 
-For more information on reading a mesh from a LSDYNA, Fluent or CFX file check the examples sections:
-:ref:`examples_lsdyna`, :ref:`fluids_examples` and :ref:`examples_cfx`.
+For more information on reading a mesh from a LSDYNA, Fluent or CFX file check the :ref:`examples_lsdyna`,
+:ref:`fluids_examples` and :ref:`examples_cfx` examples sections.