Skip to content

Commit

Permalink
docs: update reduction docs (#3501)
Browse files Browse the repository at this point in the history
* docs: Update reduction docs.

* Update doc manually.

* Update doc manually [specify solvers].

* Update doc manually [Add examples].

* Update field data docs.

* Update docs with converged examples.

* Update field data docs.

* Update tests.

* Update doc/source/user_guide/fields/reduction.rst

Co-authored-by: Sean Pearson <[email protected]>

---------

Co-authored-by: Sean Pearson <[email protected]>
  • Loading branch information
prmukherj and seanpearsonuk authored Nov 22, 2024
1 parent bbc8ecc commit 90d5818
Show file tree
Hide file tree
Showing 7 changed files with 215 additions and 270 deletions.
15 changes: 0 additions & 15 deletions doc/source/user_guide/fields/field_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,6 @@ the ``get_surface_data`` method and specifying ``FacesConnectivity`` for ``data_
array([12, 13, 17, 16])
If a single surface is provided as input, the response contains face vertices, connectivity data, and normal or centroid data.
If multiple surfaces are provided as input, the response is a dictionary containing a map of surface IDs to face
vertices, connectivity data, and normal or centroid data.

Get scalar field data
~~~~~~~~~~~~~~~~~~~~~
You can call the ``get_scalar_field_data`` method to get scalar field data, such as absolute pressure:
Expand All @@ -98,9 +94,6 @@ You can call the ``get_scalar_field_data`` method to get scalar field data, such
>>> abs_press_data["cold-inlet"][120]
101325.0
If a single surface is provided as input, scalar field data is returned.
If multiple surfaces are provided as input, a dictionary containing a map of surface IDs to scalar field data is returned.

Get vector field data
~~~~~~~~~~~~~~~~~~~~~
You can call the ``get_vector_field_data`` method to get vector field data.
Expand All @@ -111,9 +104,6 @@ You can call the ``get_vector_field_data`` method to get vector field data.
>>> velocity_vector_data["cold-inlet"].shape
(152, 3)
If a single surface is provided as input, vector field data is returned.
If multiple surfaces are provided as input, a dictionary containing a map of surface IDs to vector field data is returned.

Get pathlines field data
~~~~~~~~~~~~~~~~~~~~~~~~
You can call the ``get_pathlines_field_data`` method to get pathlines field data.
Expand All @@ -134,11 +124,6 @@ Dictionary containing a map of surface IDs to the path-line data is returned.
For example, pathlines connectivity, vertices, and field.


.. note::
In Fluent, a surface name can be associated with multiple surface IDs.
Thus, a response contains a surface ID as a key of the returned dictionary.


Making multiple requests in a single transaction
------------------------------------------------
You can get data for multiple fields in a single transaction.
Expand Down
Loading

0 comments on commit 90d5818

Please sign in to comment.