Skip to content

Commit cffc5a3

Browse files
updates the examples package references
1 parent 9bca49d commit cffc5a3

File tree

5 files changed

+10
-5
lines changed

5 files changed

+10
-5
lines changed

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Explore a mesh
1515
.. |Faces| replace:: :class:`Faces <ansys.dpf.core.faces.Faces>`
1616
.. |Scoping| replace:: :class:`Scoping <ansys.dpf.core.scoping.Scoping>`
1717
.. |PropertyField| replace:: :class:`PropertyField <ansys.dpf.core.property_field.PropertyField>`
18+
.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
1819

1920
This tutorial explains how to access the mesh data and metadata (data about the elements, nodes, faces, region, zone ...)
2021
so it can be manipulated.
@@ -30,7 +31,7 @@ The mesh object in DPF is a |MeshedRegion|. You can obtain a |MeshedRegion| by c
3031
own by scratch or by getting it from a result file. For more information check the
3132
:ref:`tutorials_create_a_mesh_from_scratch` and :ref:`tutorials_get_mesh_from_result_file` tutorials.
3233

33-
Here we we will download a result file available in our `Examples` package.
34+
Here we we will download a result file available in our |Examples| package.
3435
For more information about how to import your result file in DPF check
3536
the :ref:`ref_tutorials_import_data` tutorial section.
3637

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Get a mesh from a result file
1212
.. |Model| replace:: :class:`Model <ansys.dpf.core.model.Model>`
1313
.. |DataSources| replace:: :class:`Model <ansys.dpf.core.data_sources.DataSources>`
1414
.. |mesh_provider| replace:: :class:`mesh_provider <ansys.dpf.core.operators.mesh.mesh_provider.mesh_provider>`
15+
.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
1516

1617
The mesh object in DPF is a |MeshedRegion|. You can obtain a |MeshedRegion| by creating your
1718
own by scratch or by getting it from a result file.
@@ -22,7 +23,7 @@ This tutorial explains how to extract the models mesh from a result file.
2223
Import the result file
2324
----------------------
2425

25-
Here we we will download result files available in our `Examples` package.
26+
Here we we will download result files available in our |Examples| package.
2627
For more information about how to import your result file in DPF check
2728
the :ref:`ref_tutorials_import_data` tutorial section.
2829

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Extract a mesh in split parts
1010
.. |MeshesContainer| replace:: :class:`MeshesContainer <ansys.dpf.core.meshes_container.MeshesContainer>`
1111
.. |DataSources| replace:: :class:`Model <ansys.dpf.core.data_sources.DataSources>`
1212
.. |meshes_provider| replace:: :class:`mesh_provider <ansys.dpf.core.operators.mesh.mesh_provider.mesh_provider>`
13+
.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
1314

1415
This tutorial show how to get meshes split on a given space or time for Fluent or CFX result files.
1516

@@ -21,7 +22,7 @@ Define the |DataSources|
2122
The |meshes_provider| operator needs a |DataSources| object.
2223

2324
In this part we will download simulation result files available
24-
in our ``Examples`` package.
25+
in our |Examples| package.
2526

2627
.. tab-set::
2728

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Read a mesh metadata
1010
.. |Model| replace:: :class:`Model <ansys.dpf.core.model.Model>`
1111
.. |DataSources| replace:: :class:`Model <ansys.dpf.core.data_sources.DataSources>`
1212
.. |MeshInfo| replace:: :class:`MeshInfo <ansys.dpf.core.mesh_info.MeshInfo>`
13+
.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
1314

1415
This tutorial explains how to read a mesh metadata (data about the elements, nodes, faces, region, zone ...)
1516
for LSDYNA, Fluent or CFX result files.
@@ -24,7 +25,7 @@ You can obtain this object by creating a |Model| with a result file.
2425
Define the |Model|
2526
------------------
2627

27-
Here we we will download result files available in our `Examples` package.
28+
Here we we will download result files available in our |Examples| package.
2829
For more information about how to import your result file in DPF check
2930
the :ref:`ref_tutorials_import_data` tutorial section.
3031

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ This tutorial show how to split a mesh into different meshes.
1616
.. |DataSources| replace:: :class:`Model <ansys.dpf.core.data_sources.DataSources>`
1717
.. |Scoping| replace:: :class:`Scoping <ansys.dpf.core.scoping.Scoping>`
1818
.. |ScopingsContainer| replace:: :class:`ScopingsContainer <ansys.dpf.core.scopings_container.ScopingsContainer>`
19+
.. |Examples| replace:: :mod:`Examples<ansys.dpf.core.examples>`
1920

2021
The mesh object in DPF is a |MeshedRegion|. If you want to split your mesh you can store them in a |MeshedRegion|.
2122

@@ -33,7 +34,7 @@ own by scratch or by getting it from a result file. For more information check t
3334
:ref:`tutorials_create_a_mesh_from_scratch` and :ref:`tutorials_get_mesh_from_result_file` tutorials.
3435

3536
In this part we will download simulation result files available
36-
in our ``Examples`` package.
37+
in our |Examples| package.
3738

3839
.. tab-set::
3940

0 commit comments

Comments
 (0)