Skip to content

Commit c2031d0

Browse files
committed
Merge remote-tracking branch 'origin/doc/new-tutorials-section' into doc/new-tutorials-section
2 parents 55f2e51 + 36b183f commit c2031d0

File tree

9 files changed

+9
-64
lines changed

9 files changed

+9
-64
lines changed

doc/source/links_and_refs.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,6 @@
6464
.. |DpfPlotter| replace:: :class:`DpfPlotter<ansys.dpf.core.plotter.DpfPlotter>`
6565
.. |Result| replace:: :class:`Result <ansys.dpf.core.results.Result>`
6666
.. |Operator| replace:: :class:`Operator<ansys.dpf.core.dpf_operator.Operator>`
67-
.. |TimeFreqSupport| replace:: :class:`TimeFreqSupport <ansys.dpf.core.time_freq_support.TimeFreqSupport>`
67+
.. |TimeFreqSupport| replace:: :class:`TimeFreqSupport <ansys.dpf.core.time_freq_support.TimeFreqSupport>`
68+
.. |PropertyField| replace:: :class:`PropertyField <ansys.dpf.core.property_field.PropertyField>`
69+
.. |StringField| replace:: :class:`StringField <ansys.dpf.core.string_field.StringField>`

doc/source/user_guide/tutorials/custom_operators_and_plugins/custom_plug_in_package_third_deps.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ Use the :func:`load_library() <ansys.dpf.core.core.load_library>` method to load
144144
"load_operators")
145145
146146
Use the custom operators
147-
--------------------
147+
------------------------
148148

149149
Once the plugin is loaded, you can instantiate the custom operator:
150150

doc/source/user_guide/tutorials/import_data/narrow_down_data.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ Narrow down data
1818
.. |extract_scoping| replace:: :class:`extract_scoping <ansys.dpf.core.operators.utility.extract_scoping.extract_scoping>`
1919
.. |scoping_by_sets| replace:: :func:`scoping_by_sets() <ansys.dpf.core.time_freq_scoping_factory.scoping_by_sets>`
2020
.. |nodal_scoping| replace:: :func:`nodal_scoping() <ansys.dpf.core.mesh_scoping_factory.nodal_scoping>`
21-
.. |ScopingsContainer| replace:: :class:`ScopingsContainer <ansys.dpf.core.scopings_container.ScopingsContainer>`
2221
.. |MeshedRegion.elements| replace:: :func:`MeshedRegion.elements<ansys.dpf.core.meshed_region.MeshedRegion.elements>`
2322
.. |MeshedRegion.nodes| replace:: :func:`MeshedRegion.nodes<ansys.dpf.core.meshed_region.MeshedRegion.nodes>`
2423
.. |Elements.scoping| replace:: :func:`Elements.scoping<ansys.dpf.core.elements.Elements.scoping>`

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ Explore a mesh
77
:bdg-mapdl:`MAPDL` :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>`
1110
.. |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>`
1311

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

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ Explore a mesh metadata
1111
This tutorial requires DPF 9.1 or above (2025 R1).
1212

1313
.. include:: ../../../links_and_refs.rst
14-
.. |PropertyField| replace:: :class:`PropertyField <ansys.dpf.core.property_field.PropertyField>`
15-
.. |StringField| replace:: :class:`StringField <ansys.dpf.core.string_field.StringField>`
1614

1715
This tutorial explains how to read a mesh metadata (data about the elements, nodes, faces, region, zone ...)
1816
before extracting the mesh from a result file.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Extract a mesh in split parts
77
:bdg-fluent:`Fluent` :bdg-cfx:`CFX`
88

99
.. include:: ../../../links_and_refs.rst
10-
.. |MeshesContainer| replace:: :class:`MeshesContainer <ansys.dpf.core.meshes_container.MeshesContainer>`
10+
1111
.. |meshes_provider| replace:: :class:`meshes_provider <ansys.dpf.core.operators.mesh.meshes_provider.meshes_provider>`
1212

1313
This tutorial shows how to extract meshes split on a given space or time from a result file.
@@ -90,7 +90,7 @@ The split meshes are given in a |MeshesContainer| and can be spatially or tempor
9090
print(meshes_41)
9191

9292
Scope the mesh regions to be extracted in split regions
93-
-----------------------------------------------------
93+
-------------------------------------------------------
9494

9595
A region corresponds to a zone for Fluid and CFX results. You can specify the mesh regions you want to get by giving
9696
the zones ids to the ``region_scoping`` argument.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _ref_tutorials_mesh:
22

3-
================
4-
Mesh exploration
5-
================
3+
======
4+
Meshes
5+
======
66

77
The mesh in DPF is represented by the :class:`MeshedRegion <ansys.dpf.core.meshed_region.MeshedRegion>` entity.
88

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,9 @@ Split a mesh
88

99
.. include:: ../../../links_and_refs.rst
1010

11-
.. |MeshesContainer| replace:: :class:`MeshesContainer <ansys.dpf.core.meshes_container.MeshesContainer>`
1211
.. |split_mesh| replace:: :class:`split_mesh <ansys.dpf.core.operators.mesh.split_mesh.split_mesh>`
1312
.. |split_on_property_type| replace:: :class:`split_on_property_type <ansys.dpf.core.operators.scoping.split_on_property_type.split_on_property_type>`
1413
.. |from_scopings| replace:: :class:`from_scopings <ansys.dpf.core.operators.mesh.from_scopings.from_scopings>`
15-
.. |ScopingsContainer| replace:: :class:`ScopingsContainer <ansys.dpf.core.scopings_container.ScopingsContainer>`
16-
.. |PropertyField| replace:: :class:`PropertyField <ansys.dpf.core.property_field.PropertyField>`
1714

1815
This tutorial shows how to split a mesh on a given property.
1916

doc/source/user_guide/tutorials/transform_data/index.rst

Lines changed: 0 additions & 49 deletions
This file was deleted.

0 commit comments

Comments
 (0)