From 0211b0a43bbd4e50bb7b9dbef3aa9e0f4896993a Mon Sep 17 00:00:00 2001 From: Mark Olesen Date: Wed, 21 Dec 2016 12:15:03 +0100 Subject: [PATCH] STYLE: correct the documented input names in header files (fixes #360) --- .../utilities/mesh/manipulation/topoSet/topoSetDict | 2 +- .../derived/mappedField/mappedFieldFvPatchField.H | 6 +++--- .../derived/mappedField/mappedPatchFieldBase.H | 4 ++-- .../mappedFixedInternalValueFvPatchField.H | 4 ++-- .../mappedFixedPushedInternalValueFvPatchField.H | 4 ++-- .../derived/mappedFixedValue/mappedFixedValueFvPatchField.H | 4 ++-- src/functionObjects/field/fieldAverage/fieldAverage.H | 4 ++-- src/functionObjects/field/valueAverage/valueAverage.H | 6 ++++-- .../radialActuationDiskSource/radialActuationDiskSource.H | 2 +- 9 files changed, 19 insertions(+), 17 deletions(-) diff --git a/applications/utilities/mesh/manipulation/topoSet/topoSetDict b/applications/utilities/mesh/manipulation/topoSet/topoSetDict index d4ea1bd2a3..1a32f03d37 100644 --- a/applications/utilities/mesh/manipulation/topoSet/topoSetDict +++ b/applications/utilities/mesh/manipulation/topoSet/topoSetDict @@ -161,7 +161,7 @@ FoamFile // source fieldToCell; // sourceInfo // { -// fieldName U; // Note: uses mag(U) since volVectorField +// field U; // Note: uses mag(U) since volVectorField // min 0.1; // max 0.5; // } diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H index 59af6f564c..5935fa8344 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H @@ -30,12 +30,12 @@ Group Description This boundary condition provides a self-contained version of the \c mapped condition. It does not use information on the patch; instead it holds - thr data locally. + the data locally. Usage \table Property | Description | Required | Default value - fieldName | name of field to be mapped | no | this field name + field | name of field to be mapped | no | this field name setAverage | flag to activate setting of average value | yes | average | average value to apply if \c setAverage = yes | yes | \endtable @@ -45,7 +45,7 @@ Usage { type mappedField; - fieldName T; // optional field name + field T; // optional field name setAverage no; // apply an average value average 0; // average to apply if setAverage value uniform 0; // place holder diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedPatchFieldBase.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedPatchFieldBase.H index a02e92197b..9b01540315 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedPatchFieldBase.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedPatchFieldBase.H @@ -32,7 +32,7 @@ Description Example usage: { - fieldName T; // default is same as fvPatchField + field T; // default is same as fvPatchField setAverage false; average 1.0; // only if setAverage=true interpolationScheme cellPoint; // default is cell @@ -58,7 +58,7 @@ class mappedPatchBase; template class interpolation; /*---------------------------------------------------------------------------*\ - Class mappedPatchFieldBase Declaration + Class mappedPatchFieldBase Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H index 44c233b1c4..1f03082b36 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H @@ -34,7 +34,7 @@ Description Usage \table Property | Description | Required | Default value - fieldName | name of field to be mapped | no | this field name + field | name of field to be mapped | no | this field name setAverage | flag to activate setting of average value | yes | average | average value to apply if \c setAverage = yes | yes | \endtable @@ -43,7 +43,7 @@ Usage { type mappedFixedInternalValue; - fieldName T; + field T; setAverage no; average 0; value uniform 0; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H index 81ce8a5148..5518aed14b 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H @@ -34,7 +34,7 @@ Description Usage \table Property | Description | Required | Default value - fieldName | name of field to be mapped | no | this field name + field | name of field to be mapped | no | this field name setAverage | flag to activate setting of average value | yes | average | average value to apply if \c setAverage = yes | yes | \endtable @@ -44,7 +44,7 @@ Usage { type mappedFixedPushedInternalValue; - fieldName T; + field T; setAverage no; average 0; value uniform 0; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H index 15257430f2..56201907d8 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H @@ -37,7 +37,7 @@ Description Usage \table Property | Description | Required | Default value - fieldName | name of field to be mapped | no | this field name + field | name of field to be mapped | no | this field name setAverage | flag to activate setting of average value | yes | average | average value to apply if \c setAverage = yes | yes | interpolationScheme | type of interpolation scheme | no | @@ -48,7 +48,7 @@ Usage { type mapped; - fieldName T; + field T; setAverage no; average 0; interpolationScheme cell; diff --git a/src/functionObjects/field/fieldAverage/fieldAverage.H b/src/functionObjects/field/fieldAverage/fieldAverage.H index 74c4768d37..66c7799f63 100644 --- a/src/functionObjects/field/fieldAverage/fieldAverage.H +++ b/src/functionObjects/field/fieldAverage/fieldAverage.H @@ -103,8 +103,8 @@ Usage \table Property | Description | Required | Default value type | type name: fieldAverage | yes | - restartOnRestart| Restart the averaging on restart | no | no - restartOnOutput | Restart the averaging on output | no | no + restartOnRestart | Restart the averaging on restart | no | no + restartOnOutput | Restart the averaging on output | no | no periodicRestart | Periodically restart the averaging | no | no restartPeriod | Periodic restart period | conditional | restartTime | One-shot reset of the averaging | no | great diff --git a/src/functionObjects/field/valueAverage/valueAverage.H b/src/functionObjects/field/valueAverage/valueAverage.H index 83cf3ed170..6c25c8a56f 100644 --- a/src/functionObjects/field/valueAverage/valueAverage.H +++ b/src/functionObjects/field/valueAverage/valueAverage.H @@ -41,7 +41,7 @@ Usage ... writeToFile yes; log yes; - functionObjectName forceCoeffs1; + functionObject forceCoeffs1; fields (Cm Cd Cl); window 0.5; } @@ -54,6 +54,8 @@ Usage writeToFile | write average data to file | no | yes log | write average data to standard output | no | yes fields | list of fields to process | yes | + functionObject | Name of function object to retrieve data from | yes | + resetOnRestart | Reset the averaging on restart | yes | \endtable Output data is written to the file \/valueAverage.dat @@ -107,7 +109,7 @@ protected: //- Average time per field List totalTime_; - //- Reset the averaging process on restart flag + //- Reset the averaging process on restart bool resetOnRestart_; diff --git a/src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H b/src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H index 0acd37053d..8dc38312d6 100644 --- a/src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H +++ b/src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H @@ -58,7 +58,7 @@ Usage \verbatim actuationDiskSourceCoeffs { - fieldName U; // name of field to apply source + fields (U); // names of fields to apply source diskDir (-1 0 0); // disk direction Cp 0.1; // power coefficient Ct 0.5; // thrust coefficient