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

Jump to bottom

Update reduction doc. #1626

Merged
merged 7 commits into from
May 23, 2023
Merged

Update reduction doc. #1626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f4b882f
Update reduction doc.
May 22, 2023
8603d12
Update the doc.
May 22, 2023
41a7f4c
Update vale acceptance list.
May 22, 2023
4dbb500
Update doc/source/api/solver/reduction.rst
prmukherj May 22, 2023
4fc03f8
Update doc/source/api/solver/reduction.rst
prmukherj May 22, 2023
0902bda
Update doc/source/api/solver/reduction.rst
prmukherj May 22, 2023
2056733
Update doc/source/api/solver/reduction.rst
prmukherj May 22, 2023
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
17 changes: 17 additions & 0 deletions doc/source/api/solver/reduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ an area-average of absolute pressure over the velocity inlet.

Similarly one can use the other functions available currently with PyFluent.

.. note::
The fluxes are evaluated on boundaries and face zones. So, for 'volume', 'mass_flow',
'mass_average' and 'mass_integrated_average' the chosen location cannot be a
user-defined surface.

Usage of context
----------------

Expand Down Expand Up @@ -104,6 +109,9 @@ Compute the total volume of the specified locations.

>>> reduction.volume(locations)

.. note::
Only boundaries and face zones are allowed locations. It cannot be a user-defined surface.

Volume average
~~~~~~~~~~~~~~
Compute the volume averaged value of the specified expression over the specified locations.
Expand Down Expand Up @@ -193,6 +201,9 @@ Compute the mass-weighted average value of the specified expression over the spe

>>> reduction.mass_average(expression, locations)

.. note::
Only boundaries and face zones are allowed locations. It cannot be a user-defined surface.

Mass integrated average
~~~~~~~~~~~~~~~~~~~~~~~
Compute the total mass-weighted value of the specified expression over the specified locations.
Expand All @@ -201,6 +212,9 @@ Compute the total mass-weighted value of the specified expression over the speci

>>> reduction.mass_integrated_average(expression, locations)

.. note::
Only boundaries and face zones are allowed locations. It cannot be a user-defined surface.

Mass flow
~~~~~~~~~
Compute the total mass flow rate of the specified locations.
Expand All @@ -209,6 +223,9 @@ Compute the total mass flow rate of the specified locations.

>>> reduction.mass_flow(locations)

.. note::
Only boundaries and face zones are allowed locations. It cannot be a user-defined surface.

Mass flow average
~~~~~~~~~~~~~~~~~
Compute the mass-flow-weighted average value of the specified expression over the specified locations.
Expand Down
3 changes: 3 additions & 0 deletions doc/styles/Vocab/ANSYS/accept.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,6 @@ transcript
UDFs
Univa
venv
mass_flow
mass_average
mass_integrated_average