From 37f3793b7a3c9ce850ddf146ded5c0f55c29003a Mon Sep 17 00:00:00 2001
From: andy <andy>
Date: Wed, 21 Nov 2012 17:05:33 +0000
Subject: [PATCH] ENH: Added header documentation to pressureTools function
object
---
.../utilities/pressureTools/pressureTools.H | 48 ++++++++++++++-----
1 file changed, 37 insertions(+), 11 deletions(-)
diff --git a/src/postProcessing/functionObjects/utilities/pressureTools/pressureTools.H b/src/postProcessing/functionObjects/utilities/pressureTools/pressureTools.H
index 702d4961995..8b9d468bba9 100644
--- a/src/postProcessing/functionObjects/utilities/pressureTools/pressureTools.H
+++ b/src/postProcessing/functionObjects/utilities/pressureTools/pressureTools.H
@@ -24,29 +24,55 @@ License
Class
Foam::pressureTools
+Group
+ grpUtilitiesFunctionObjects
+
Description
This function object includes tools to manipulate the pressure into
different forms. These currently include:
- static pressure
-
- p_s = rho*p_k
-
+ \f[
+ p_s = \rho p_k
+ \f]
- total pressure
-
- p_T = pRef + p_s + 0.5 rho |U|^2
-
+ \f[
+ p_T = p_{ref} + p_s + 0.5 \rho |U|^2
+ \f]
- static pressure coefficient
-
- Cp_s = p_s / (0.5 rho |U|^2)
-
+ \f[
+ Cp_s = \frac{p_s}{0.5 \rho |U|^2}
+ \f]
- total pressure coefficient
-
- Cp_T = p_T / (0.5 rho |U|^2)
+ \f[
+ Cp_T = \frac{p_T}{0.5 \rho |U|^2}
+ \f]
The function object will operate on both kinematic (p_k) and static
pressure (p_s) fields, and the result is written as a volScalarField.
+ Example of function object specification to calculate pressure coefficient:
+ \verbatim
+ pressureTools1
+ {
+ type pressureTools;
+ functionObjectLibs ("libutilityFunctionObjects.so");
+ ...
+ calcTotal no;
+ calcCoeff yes;
+ }
+ \endverbatim
+
+ \heading Function object usage
+ \table
+ Property | Description | Required | Default value
+ type | type name: pressureTools| yes |
+ calcCoeff | Calculate pressure coefficient | yes |
+ calcTotal | Calculate total coefficient | yes |
+ rhoRef | Reference density for incompressible cases | no | 1
+ pRef | Reference pressure for total pressure |no| 0.0
+ \endtable
+
SourceFiles
pressureTools.C
IOpressureTools.H
--
GitLab