Skip to content

Commit ac2e713

Browse files
add more explanation on the metadata info on the explore_mesh_metadata.rst tutorial
1 parent 258d40f commit ac2e713

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

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

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ Explore a mesh metadata
77
:bdg-lsdyna:`LSDYNA` :bdg-fluent:`Fluent` :bdg-cfx:`CFX`
88

99
.. include:: ../../../links_and_refs.rst
10+
.. |PropertyField| replace:: :class:`PropertyField <ansys.dpf.core.property_field.PropertyField>`
11+
.. |StringField| replace:: :class:`StringField <ansys.dpf.core.string_field.StringField>`
1012

1113
This tutorial explains how to read a mesh metadata (data about the elements, nodes, faces, region, zone ...)
1214
before extracting the mesh from a result file.
@@ -92,13 +94,15 @@ access the analysis results metadata and to instanciate results providers by ope
9294
# Create the Model
9395
model_4 = dpf.Model(data_sources=result_file_path_4)
9496

95-
Read the mesh metadata
96-
----------------------
97+
Explore the mesh metadata
98+
-------------------------
9799

98100
You can access the mesh metadata with the |MeshInfo| object. It reads the metadata information before extracting
99-
the MeshedRegion from the result file.
101+
the |MeshedRegion| from the result file.
100102

101-
The mesh metadata information includes :
103+
The mesh metadata information is stored in a |PropertyField| or in a |StringField|. They contain information
104+
that describes the mesh composition and their data is mapped to the entity they are defined at.
105+
The mesh metadata information information can be:
102106

103107
- Properties;
104108
- Parts;
@@ -108,7 +112,7 @@ The mesh metadata information includes :
108112
- Number of nodes and elements;
109113
- Elements types.
110114

111-
Get the the mesh metadata information and print the available ones.
115+
You can access which metadata information is available for a given result file.
112116

113117
.. tab-set::
114118

@@ -142,7 +146,7 @@ Get the the mesh metadata information and print the available ones.
142146
# Print the mesh metadata information
143147
print(mesh_info_4)
144148

145-
You can extract each of those mesh information by manipulating the |MeshInfo| object properties.
149+
You can also extract each of those mesh metadata information by manipulating the |MeshInfo| object properties.
146150

147151
For example, we can check the part names (for the LSDYNA result file) or the cell zone names
148152
(for the Fluent or CFX result files):

0 commit comments

Comments
 (0)