ENH: Updates to function object documentation

This commit is contained in:
andy
2012-07-23 15:23:35 +01:00
parent e6a41726e2
commit a17b0c75c6
30 changed files with 74 additions and 42 deletions

View File

@ -24,7 +24,8 @@ License
Class
Foam::codedFunctionObject
\ingroup grpUtilitiesFunctionObjects
Group
grpUtilitiesFunctionObjects
Description
functionObject using dynamic code compilation.

View File

@ -24,7 +24,8 @@ License
Class
Foam::dsmcFields
\ingroup grpUtilitiesFunctionObjects
Group
grpUtilitiesFunctionObjects
Description
Calculate intensive fields:

View File

@ -24,18 +24,28 @@ License
Class
Foam::pressureCoefficient
\ingroup grpUtilitiesFunctionObjects
Group
grpUtilitiesFunctionObjects
Description
Calculates pressure coefficient, \f$c_p\f$
\f[
c_p = p/p_{dyn,inf}
c_p = \frac{p}{p_{dyn,inf}}
\f]
where:
\f[
p_{dyn,inf} = 0.5 \rho |U_{inf}|^2
\f]
where:
where
\vartable
c_p | pressure coefficient
p | pressure [bar]
\rho | density [kg/m3]
U | velocity [m/s]
\endvartable
p_dyn,inf = 0.5*rho*mag(U_inf)^2
SourceFiles
pressureCoefficient.C

View File

@ -24,7 +24,8 @@ License
Class
Foam::staticPressure
\ingroup grpUtilitiesFunctionObjects
Group
grpUtilitiesFunctionObjects
Description
Converts kinematic pressure to static pressure, from the name of the

View File

@ -24,7 +24,8 @@ License
Class
Foam::timeActivatedFileUpdate
\ingroup grpUtilitiesFunctionObjects
Group
grpUtilitiesFunctionObjects
Description
Performs a file copy/replacement once a specified time has been reached.

View File

@ -24,7 +24,8 @@ License
Class
Foam::yPlusLES
\ingroup grpUtilitiesFunctionObjects
Group
grpUtilitiesFunctionObjects
Description
Evaluates and outputs turbulence y+ for LES models. Values written to

View File

@ -24,7 +24,8 @@ License
Class
Foam::yPlusRAS
\ingroup grpUtilitiesFunctionObjects
Group
grpUtilitiesFunctionObjects
Description
Evaluates and outputs turbulence y+ for RAS models. Values written to