mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
ENH: Updates to doxygen docs
This commit is contained in:
@ -34,13 +34,14 @@ Description
|
||||
the calculation. The current options include:
|
||||
- \c mean: arithmetic mean:
|
||||
\f[
|
||||
\overline{x} = \frac{\Sigma x i}{\Sigma i}
|
||||
\overline{x} = \frac{1}{N}\displaystyle\sum\limits_{i=0}^N x_i
|
||||
\f]
|
||||
- \c prime2Mean: prime-squared mean
|
||||
\f[
|
||||
\overline{x'}^2 = \frac{\Sigma (x - \overline{x}) i}{\Sigma i}
|
||||
\overline{x'}^2 = \frac{1}{N}\displaystyle\sum\limits_{i=0}^N
|
||||
(x_i - \overline{x})^2
|
||||
\f]
|
||||
- base: average over 'time', or 'iteration' (\f$i\f$ in the above)
|
||||
- base: average over 'time', or 'iteration' (\f$N\f$ in the above)
|
||||
- window: optional averaging window, specified in 'base' units
|
||||
|
||||
\note
|
||||
|
||||
@ -28,6 +28,7 @@ Description
|
||||
Face source variant of field value function object. Values of user-
|
||||
specified fields reported for collections of faces.
|
||||
|
||||
\verbatim
|
||||
faceObj1 // Name also used to identify output folder
|
||||
{
|
||||
type faceSource;
|
||||
@ -48,6 +49,7 @@ Description
|
||||
U
|
||||
);
|
||||
}
|
||||
\endverbatim
|
||||
|
||||
source:
|
||||
- faceZone : requires a 'sourceName' entry to specify the faceZone
|
||||
@ -56,34 +58,37 @@ Description
|
||||
sampleDict.
|
||||
|
||||
operation is one of:
|
||||
- none
|
||||
- sum
|
||||
- average
|
||||
- weightedAverage
|
||||
- areaAverage
|
||||
- areaIntegrate
|
||||
- min
|
||||
- max
|
||||
- CoV (Coefficient of variation: standard deviation/mean)
|
||||
- areaNormalAverage (vector with first component (average of) inproduct
|
||||
of value and face area vector)
|
||||
- areaNormalIntegrate ( ,, ,, (sum of) ,,
|
||||
- none
|
||||
- sum
|
||||
- average (ensemble)
|
||||
- weightedAverage
|
||||
- areaAverage
|
||||
- areaIntegrate
|
||||
- min
|
||||
- max
|
||||
- CoV (Coefficient of variation: standard deviation/mean)
|
||||
- areaNormalAverage (vector with first component (average of) inproduct
|
||||
of value and face area vector)
|
||||
- areaNormalIntegrate ( ,, ,, (sum of) ,,
|
||||
|
||||
Notes:
|
||||
For example, to calculate the volumetric or mass flux across a patch,
|
||||
apply the 'sum' operator to the flux field (typically \c phi)
|
||||
|
||||
\note
|
||||
- faces on empty patches get ignored
|
||||
- if the field is a volField the faceZone can only consist of boundary
|
||||
faces.
|
||||
- all fields get oriented according to the faceZone (so you might e.g. see
|
||||
negative pressure)
|
||||
- using sampledSurfaces:
|
||||
- they do not do surface fields
|
||||
- if interpolate=true they use interpolationCellPoint
|
||||
otherwise they use cell values
|
||||
- each triangle in sampledSurface is logically only in one cell
|
||||
so interpolation will be wrong when triangles are larger than
|
||||
cells. This can only happen for sampling on triSurfaceMesh.
|
||||
- take care when using isoSurfaces - these might have duplicate
|
||||
triangles so integration might be wrong
|
||||
- if the field is a volField the \c faceZone can only consist of boundary
|
||||
faces
|
||||
- all fields get oriented according to the \c faceZone (so you might
|
||||
e.g. see negative pressure)
|
||||
- using \c sampledSurfaces:
|
||||
- they do not do surface fields
|
||||
- if interpolate=true they use \c interpolationCellPoint
|
||||
otherwise they use cell values
|
||||
- each triangle in \c sampledSurface is logically only in one cell
|
||||
so interpolation will be wrong when triangles are larger than
|
||||
cells. This can only happen for sampling on \c triSurfaceMesh
|
||||
- take care when using isoSurfaces - these might have duplicate
|
||||
triangles so integration might be wrong
|
||||
|
||||
SourceFiles
|
||||
faceSource.C
|
||||
|
||||
@ -33,6 +33,11 @@ Description
|
||||
|
||||
\heading Patch usage
|
||||
|
||||
\table
|
||||
Property | Description | Required | Default value
|
||||
T | temperature field name | no | T
|
||||
\endtable
|
||||
|
||||
Example of the boundary condition specification:
|
||||
\verbatim
|
||||
myPatch
|
||||
|
||||
@ -28,8 +28,11 @@ Group
|
||||
grpIcoWallFunctions
|
||||
|
||||
Description
|
||||
This boundary condition is applied to turbulence \c k, \c q, and \c R
|
||||
when using wall functions, and simply enforces a zero-gradient condition.
|
||||
This boundary condition provides a suitable condition for turbulence
|
||||
\c k, \c q, and \c R fields for the case of high Reynolds number flow using
|
||||
wall functions.
|
||||
|
||||
It is a simple wrapper around the zero-gradient condition.
|
||||
|
||||
\heading Patch usage
|
||||
|
||||
|
||||
Reference in New Issue
Block a user