Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update reduction docs #3501

Merged
merged 11 commits into from
Nov 22, 2024
Merged

docs: update reduction docs #3501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
fe292be
docs: Update reduction docs.
prmukherj Nov 21, 2024
2080847
Update doc manually.
prmukherj Nov 21, 2024
3f02fc4
Update doc manually [specify solvers].
prmukherj Nov 21, 2024
3d1b334
Update doc manually [Add examples].
prmukherj Nov 21, 2024
af550a4
Merge branch 'main' into doc/update_reduction_docs
prmukherj Nov 21, 2024
9c19cb3
Update field data docs.
prmukherj Nov 21, 2024
2ae3488
Merge branch 'doc/update_reduction_docs' of https://github.com/ansys/…
prmukherj Nov 21, 2024
767985b
Update docs with converged examples.
prmukherj Nov 22, 2024
7412252
Update field data docs.
prmukherj Nov 22, 2024
e608933
Update tests.
prmukherj Nov 22, 2024
3444c83
Update doc/source/user_guide/fields/reduction.rst
prmukherj Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions doc/source/user_guide/fields/field_data.rst
View file
Open in desktop
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