Commit 853ec2bf authored by Mark Olesen's avatar Mark Olesen
Browse files

STYLE: doxygen fixes for surfaceFieldValue

parent 3b6027d1
...@@ -47,7 +47,7 @@ Usage ...@@ -47,7 +47,7 @@ Usage
log true; log true;
writeControl writeTime; writeControl writeTime;
writeFields true; writeFields false;
regionType patch; regionType patch;
name movingWall; name movingWall;
...@@ -77,27 +77,27 @@ Usage ...@@ -77,27 +77,27 @@ Usage
Where the entries comprise: Where the entries comprise:
\table \table
Property | Description | Required | Default value Property | Description | Required | Default
type | type name: surfaceFieldValue | yes | type | type name: surfaceFieldValue | yes |
log | write data to standard output | no | no log | write data to standard output | no | no
writeFields | Write the region field values | yes | writeFields | Write the region field values | yes |
writeArea | Write the area of the surfaceFieldValue | no | writeArea | Write the area of the surfaceFieldValue | no |
surfaceFormat | output value format | no | surfaceFormat | output value format | no |
regionType | face regionType: see below | yes | regionType | face regionType: see below | yes |
name | name of face regionType if required | no | name | name of face regionType if required | no |
operation | operation to perform | yes | operation | operation to perform | yes |
postOperation | post-operation to perform | no | none | postOperation | post-operation to perform | no | none
weightField | name of field to apply weighting | no | weightField | name of field to apply weighting | no |
scaleFactor | scale factor | no | 1 scaleFactor | scale factor | no | 1
fields | list of fields to operate on | yes | fields | list of fields to operate on | yes |
\endtable \endtable
Where \c regionType is defined by Where \c regionType is defined by
\plaintable \plaintable
faceZone | requires a 'name' entry to specify the faceZone faceZone | requires a \b name entry to specify the faceZone
patch | requires a 'name' entry to specify the patch patch | requires a \b name entry to specify the patch
surface | requires a 'name' entry to specify the surfMesh surface | requires a \b name entry to specify the surfMesh
sampledSurface | requires a 'sampledSurfaceDict' sub-dictionary sampledSurface | requires a \b sampledSurfaceDict sub-dictionary
\endplaintable \endplaintable
The \c operation is one of: The \c operation is one of:
...@@ -113,17 +113,19 @@ Usage ...@@ -113,17 +113,19 @@ Usage
areaAverage | area-weighted average areaAverage | area-weighted average
areaIntegrate | area integral areaIntegrate | area integral
CoV | coefficient of variation: standard deviation/mean CoV | coefficient of variation: standard deviation/mean
areaNormalAverage| area-weighted average in face normal direction areaNormalAverage | area-weighted average in face normal direction
areaNormalIntegrate | area-weighted integral in face normal directon areaNormalIntegrate | area-weighted integral in face normal directon
uniformity | uniformity index uniformity | uniformity index
weightedSum | weighted sum weightedSum | weighted sum
weightedAverage | weighted average weightedAverage | weighted average
weightedAreaAverage | weighted area average weightedAreaAverage | weighted area average
weightedAreaIntegrate | weighted area integral weightedAreaIntegrate | weighted area integral
absWeightedSum | sum using absolute weighting weightedUniformity | weighted uniformity index
absWeightedAverage | average using absolute weighting absWeightedSum | sum using absolute weighting
absWeightedAreaAverage | area average using absolute weighting absWeightedAverage | average using absolute weighting
absWeightedAreaAverage | area average using absolute weighting
absWeightedAreaIntegrate | area integral using absolute weighting absWeightedAreaIntegrate | area integral using absolute weighting
absWeightedUniformity | uniformity index using absolute weighting
\endplaintable \endplaintable
Note Note
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment