mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
ENH: Updates to function object documentation
This commit is contained in:
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::codedFunctionObject
|
||||
|
||||
\ingroup grpUtilitiesFunctionObjects
|
||||
Group
|
||||
grpUtilitiesFunctionObjects
|
||||
|
||||
Description
|
||||
functionObject using dynamic code compilation.
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::dsmcFields
|
||||
|
||||
\ingroup grpUtilitiesFunctionObjects
|
||||
Group
|
||||
grpUtilitiesFunctionObjects
|
||||
|
||||
Description
|
||||
Calculate intensive fields:
|
||||
|
||||
@ -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
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::staticPressure
|
||||
|
||||
\ingroup grpUtilitiesFunctionObjects
|
||||
Group
|
||||
grpUtilitiesFunctionObjects
|
||||
|
||||
Description
|
||||
Converts kinematic pressure to static pressure, from the name of the
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::yPlusLES
|
||||
|
||||
\ingroup grpUtilitiesFunctionObjects
|
||||
Group
|
||||
grpUtilitiesFunctionObjects
|
||||
|
||||
Description
|
||||
Evaluates and outputs turbulence y+ for LES models. Values written to
|
||||
|
||||
@ -24,7 +24,8 @@ License
|
||||
Class
|
||||
Foam::yPlusRAS
|
||||
|
||||
\ingroup grpUtilitiesFunctionObjects
|
||||
Group
|
||||
grpUtilitiesFunctionObjects
|
||||
|
||||
Description
|
||||
Evaluates and outputs turbulence y+ for RAS models. Values written to
|
||||
|
||||
Reference in New Issue
Block a user