From 1e2bba05720e2303ec59aaa6872d51fe0c5b8476 Mon Sep 17 00:00:00 2001 From: Henry Weller Date: Wed, 15 Jun 2016 09:05:35 +0100 Subject: [PATCH] functionObjects::surfaceRegion,volRegion: Improved documentation --- .../field/fieldValues/surfaceRegion/surfaceRegion.H | 2 +- src/functionObjects/field/fieldValues/volRegion/volRegion.H | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H b/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H index 5e3d60962..3d314a24d 100644 --- a/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H +++ b/src/functionObjects/field/fieldValues/surfaceRegion/surfaceRegion.H @@ -65,7 +65,7 @@ Description Property | Description | Required | Default value type | type name: surfaceRegion | yes | log | write data to standard output | no | no - writeFields | write the output values | yes | + writeFields | Write the region field values | yes | writeArea | Write the area of the surfaceRegion | no | surfaceFormat | output value format | no | regionType | face regionType: see below | yes | diff --git a/src/functionObjects/field/fieldValues/volRegion/volRegion.H b/src/functionObjects/field/fieldValues/volRegion/volRegion.H index bca4cac25..9f9d54a0f 100644 --- a/src/functionObjects/field/fieldValues/volRegion/volRegion.H +++ b/src/functionObjects/field/fieldValues/volRegion/volRegion.H @@ -60,7 +60,7 @@ Description Property | Description | Required | Default value type | Type name: volRegion | yes | log | Write data to standard output | no | no - writeFields | Write the raw output values | yes | + writeFields | Write the region field values | yes | writeVolume | Write the volume of the volRegion | no | regionType | cell regionType: see below | yes | name | name of cell regionType if required | no |