From f4b882f1448695b979e8b5e5261e2d990cbbad10 Mon Sep 17 00:00:00 2001 From: Your Name Date: Mon, 22 May 2023 18:41:51 +0530 Subject: [PATCH 1/7] Update reduction doc. --- doc/source/api/solver/reduction.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/source/api/solver/reduction.rst b/doc/source/api/solver/reduction.rst index 1828e72858c..77840ff23b0 100644 --- a/doc/source/api/solver/reduction.rst +++ b/doc/source/api/solver/reduction.rst @@ -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:: + For reduction functions like "volume", "mass_flow", "mass_average" and, + "mass_integrated_average" the fluxes are evaluated on boundaries and face zones, + so the chosen location cannot be a user-defined surface. + Usage of context ---------------- @@ -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 an user-defined surface. + Volume average ~~~~~~~~~~~~~~ Compute the volume averaged value of the specified expression over the specified locations. @@ -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 an user-defined surface. + Mass integrated average ~~~~~~~~~~~~~~~~~~~~~~~ Compute the total mass-weighted value of the specified expression over the specified locations. @@ -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 an user-defined surface. + Mass flow ~~~~~~~~~ Compute the total mass flow rate of the specified locations. @@ -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 an user-defined surface. + Mass flow average ~~~~~~~~~~~~~~~~~ Compute the mass-flow-weighted average value of the specified expression over the specified locations. From 8603d125851e4f7d9ebdbe6a17dade8d2a521ab7 Mon Sep 17 00:00:00 2001 From: Your Name Date: Mon, 22 May 2023 21:23:53 +0530 Subject: [PATCH 2/7] Update the doc. --- doc/source/api/solver/reduction.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/source/api/solver/reduction.rst b/doc/source/api/solver/reduction.rst index 77840ff23b0..dce0e1a1fb7 100644 --- a/doc/source/api/solver/reduction.rst +++ b/doc/source/api/solver/reduction.rst @@ -43,9 +43,9 @@ an area-average of absolute pressure over the velocity inlet. Similarly one can use the other functions available currently with PyFluent. .. note:: - For reduction functions like "volume", "mass_flow", "mass_average" and, - "mass_integrated_average" the fluxes are evaluated on boundaries and face zones, - so the chosen location cannot be a user-defined surface. + 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 ---------------- From 41a7f4c082063f798edee305525746050d666666 Mon Sep 17 00:00:00 2001 From: Your Name Date: Mon, 22 May 2023 21:31:38 +0530 Subject: [PATCH 3/7] Update vale acceptance list. --- doc/styles/Vocab/ANSYS/accept.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/styles/Vocab/ANSYS/accept.txt b/doc/styles/Vocab/ANSYS/accept.txt index 4333929060a..7b06b78b309 100644 --- a/doc/styles/Vocab/ANSYS/accept.txt +++ b/doc/styles/Vocab/ANSYS/accept.txt @@ -64,3 +64,6 @@ transcript UDFs Univa venv +mass_flow +mass_average +mass_integrated_average From 4dbb500228ff826c1006b12297c03b4b562a2bf5 Mon Sep 17 00:00:00 2001 From: Prithwish Mukherjee <109645853+prmukherj@users.noreply.github.com> Date: Mon, 22 May 2023 21:51:41 +0530 Subject: [PATCH 4/7] Update doc/source/api/solver/reduction.rst Co-authored-by: Sean Pearson <93727996+seanpearsonuk@users.noreply.github.com> --- doc/source/api/solver/reduction.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/api/solver/reduction.rst b/doc/source/api/solver/reduction.rst index dce0e1a1fb7..31e866f8416 100644 --- a/doc/source/api/solver/reduction.rst +++ b/doc/source/api/solver/reduction.rst @@ -110,7 +110,7 @@ Compute the total volume of the specified locations. >>> reduction.volume(locations) .. note:: - Only boundaries and face zones are allowed locations. It cannot be an user-defined surface. + Only boundaries and face zones are allowed locations. It cannot be a user-defined surface. Volume average ~~~~~~~~~~~~~~ From 4fc03f8a05d888c527f12e4a11ab76571409b4ed Mon Sep 17 00:00:00 2001 From: Prithwish Mukherjee <109645853+prmukherj@users.noreply.github.com> Date: Mon, 22 May 2023 21:51:51 +0530 Subject: [PATCH 5/7] Update doc/source/api/solver/reduction.rst Co-authored-by: Sean Pearson <93727996+seanpearsonuk@users.noreply.github.com> --- doc/source/api/solver/reduction.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/api/solver/reduction.rst b/doc/source/api/solver/reduction.rst index 31e866f8416..67eae395374 100644 --- a/doc/source/api/solver/reduction.rst +++ b/doc/source/api/solver/reduction.rst @@ -202,7 +202,7 @@ 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 an user-defined surface. + Only boundaries and face zones are allowed locations. It cannot be a user-defined surface. Mass integrated average ~~~~~~~~~~~~~~~~~~~~~~~ From 0902bdabe07bee4c1160155ecf3c25fd2bc68df3 Mon Sep 17 00:00:00 2001 From: Prithwish Mukherjee <109645853+prmukherj@users.noreply.github.com> Date: Mon, 22 May 2023 21:51:59 +0530 Subject: [PATCH 6/7] Update doc/source/api/solver/reduction.rst Co-authored-by: Sean Pearson <93727996+seanpearsonuk@users.noreply.github.com> --- doc/source/api/solver/reduction.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/api/solver/reduction.rst b/doc/source/api/solver/reduction.rst index 67eae395374..827049178cd 100644 --- a/doc/source/api/solver/reduction.rst +++ b/doc/source/api/solver/reduction.rst @@ -224,7 +224,7 @@ 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 an user-defined surface. + Only boundaries and face zones are allowed locations. It cannot be a user-defined surface. Mass flow average ~~~~~~~~~~~~~~~~~ From 2056733fb00406e0c9d05e98b60bb6713a3d98db Mon Sep 17 00:00:00 2001 From: Prithwish Mukherjee <109645853+prmukherj@users.noreply.github.com> Date: Mon, 22 May 2023 21:52:12 +0530 Subject: [PATCH 7/7] Update doc/source/api/solver/reduction.rst Co-authored-by: Sean Pearson <93727996+seanpearsonuk@users.noreply.github.com> --- doc/source/api/solver/reduction.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/api/solver/reduction.rst b/doc/source/api/solver/reduction.rst index 827049178cd..37d1f794de3 100644 --- a/doc/source/api/solver/reduction.rst +++ b/doc/source/api/solver/reduction.rst @@ -213,7 +213,7 @@ 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 an user-defined surface. + Only boundaries and face zones are allowed locations. It cannot be a user-defined surface. Mass flow ~~~~~~~~~