From 853ec2bf64150f8cd07c9f72988e8b7a6ae5b295 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@esi-group.com>
Date: Thu, 14 Jun 2018 16:14:31 +0200
Subject: [PATCH] STYLE: doxygen fixes for surfaceFieldValue
---
.../surfaceFieldValue/surfaceFieldValue.H | 52 ++++++++++---------
1 file changed, 27 insertions(+), 25 deletions(-)
diff --git a/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H b/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H
index 1ba07521199..cde1165d567 100644
--- a/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H
+++ b/src/functionObjects/field/fieldValues/surfaceFieldValue/surfaceFieldValue.H
@@ -47,7 +47,7 @@ Usage
log true;
writeControl writeTime;
- writeFields true;
+ writeFields false;
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
--
GitLab