Skip to content

Commit 258d40f

Browse files
add more explanation on the metadata info on the explore_mesh.rst tutorial
1 parent 925165b commit 258d40f

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

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

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Explore a mesh
99
.. include:: ../../../links_and_refs.rst
1010
.. |PropertyField| replace:: :class:`PropertyField <ansys.dpf.core.property_field.PropertyField>`
1111
.. |element_types| replace:: :class:`list of available element types in a DPF mesh<ansys.dpf.core.elements.element_types>`
12+
.. |StringField| replace:: :class:`StringField <ansys.dpf.core.string_field.StringField>`
1213

1314
This tutorial explains how to access a mesh data and metadata so it can be manipulated.
1415

@@ -111,14 +112,14 @@ The mesh data includes :
111112

112113
- Unit;
113114
- Nodes, elements and faces;
114-
- Named selections.
115+
- Named selections: .
115116

116-
Check all the types of data you can get from a mesh at |MeshedRegion|.
117-
118-
When instantiating nodes, elements, faces and named selections you get the correspondent DPF objects:
117+
When instantiating nodes, elements, faces and named selections you get the corresponding DPF objects:
119118
|Nodes|, |Elements|, |Faces| and |Scoping|.
120119

121-
Here, we get the mesh nodes.
120+
For more information of other types of data you can get from a mesh, see the API reference of the |MeshedRegion| class.
121+
122+
In this tutorial, we explore the data about the mesh nodes.
122123

123124
.. tab-set::
124125

@@ -179,7 +180,9 @@ Explore the mesh metadata
179180

180181
You can access the mesh metadata by manipulating the |MeshedRegion| object properties.
181182

182-
You can check which ones are available.
183+
The mesh metadata information describes the mesh composition.
184+
185+
You can access which metadata information is available for a given result file.
183186

184187
.. tab-set::
185188

@@ -228,7 +231,9 @@ You can also chose which property you want to extract.
228231
When extracting the properties you get a |PropertyField| with that information. Their data is mapped to
229232
the entity they are defined at.
230233

231-
The element type is given as a number. Check the |element_types| to find the
234+
Here, we extract the element types for the mesh elements.
235+
236+
The element type is given as a number. See the |element_types| to find the
232237
corresponding element name.
233238

234239
.. tab-set::
@@ -272,4 +277,7 @@ corresponding element name.
272277
el_types_4 = meshed_region_4.property_field(property_name="eltype")
273278

274279
# Print the element types by element
275-
print(el_types_4)
280+
print(el_types_4)
281+
282+
For more information about how to explore a mesh metadata before extracting it from a result file, see the
283+
:ref:`<ref_tutorials_explore_mesh_metadata>`tutorial.

0 commit comments

Comments
 (0)