Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
Development
openfoam
Commits
853ec2bf
Commit
853ec2bf
authored
Jun 14, 2018
by
Mark OLESEN
Browse files
STYLE: doxygen fixes for surfaceFieldValue
parent
3b6027d1
Changes
1
Hide whitespace changes
Inline
Side-by-side
src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H
View file @
853ec2bf
...
...
@@ -47,7 +47,7 @@ Usage
log true;
writeControl writeTime;
writeFields
tru
e;
writeFields
fals
e;
regionType patch;
name movingWall;
...
...
@@ -77,27 +77,27 @@ Usage
Where the entries comprise:
\table
Property | Description | Required | Default
value
type | type name: surfaceFieldValue | yes |
log | write data to standard output | no | no
writeFields | Write the region field values | yes |
writeArea | Write the area of the surfaceFieldValue | no |
surfaceFormat | output value format | no |
regionType | face regionType: see below | yes |
name | name of face regionType if required | no |
operation | operation to perform | yes |
postOperation | post-operation to perform | no | none
|
weightField | name of field to apply weighting | no |
scaleFactor | scale factor | no | 1
fields | list of fields to operate on | yes |
Property | Description
| Required | Default
type | type name: surfaceFieldValue
| yes |
log | write data to standard output
| no
| no
writeFields | Write the region field values
| yes
|
writeArea | Write the area of the surfaceFieldValue | no
|
surfaceFormat | output value format
| no |
regionType | face regionType: see below
| yes |
name | name of face regionType if required | no
|
operation | operation to perform
| yes |
postOperation | post-operation to perform
| no
| none
weightField | name of field to apply weighting | no
|
scaleFactor | scale factor
| no | 1
fields | list of fields to operate on
| yes
|
\endtable
Where \c regionType is defined by
\plaintable
faceZone | requires a
'
name
'
entry to specify the faceZone
patch | requires a
'
name
'
entry to specify the patch
surface | requires a
'
name
'
entry to specify the surfMesh
sampledSurface | requires a
'
sampledSurfaceDict
'
sub-dictionary
faceZone | requires a
\b
name entry to specify the faceZone
patch | requires a
\b
name entry to specify the patch
surface | requires a
\b
name entry to specify the surfMesh
sampledSurface | requires a
\b
sampledSurfaceDict sub-dictionary
\endplaintable
The \c operation is one of:
...
...
@@ -113,17 +113,19 @@ Usage
areaAverage | area-weighted average
areaIntegrate | area integral
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
uniformity | uniformity index
weightedSum | weighted sum
weightedAverage | weighted average
weightedAreaAverage | weighted area average
weightedSum
| weighted sum
weightedAverage
| weighted average
weightedAreaAverage
| weighted area average
weightedAreaIntegrate | weighted area integral
absWeightedSum | sum using absolute weighting
absWeightedAverage | average using absolute weighting
absWeightedAreaAverage | area average using absolute weighting
weightedUniformity | weighted uniformity index
absWeightedSum | sum using absolute weighting
absWeightedAverage | average using absolute weighting
absWeightedAreaAverage | area average using absolute weighting
absWeightedAreaIntegrate | area integral using absolute weighting
absWeightedUniformity | uniformity index using absolute weighting
\endplaintable
Note
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment