zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

STYLE: correct the documented input names in header files (fixes #360)

Browse Source
This commit is contained in:
Mark Olesen
2016-12-21 12:15:03 +01:00
parent 33811401d6
commit 0211b0a43b
9 changed files with 19 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
applications/utilities/mesh/manipulation/topoSet/topoSetDict
View File

@ -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;
// }

6
src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.H
View File

@ -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
<patchName>
{
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

4
src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedPatchFieldBase.H
View File

@ -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> class interpolation;
/*---------------------------------------------------------------------------*\
Class mappedPatchFieldBase Declaration
Class mappedPatchFieldBase Declaration
\*---------------------------------------------------------------------------*/
template<class Type>

4
src/finiteVolume/fields/fvPatchFields/derived/mappedFixedInternalValue/mappedFixedInternalValueFvPatchField.H
View File

@ -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
<patchName>
{
type mappedFixedInternalValue;
fieldName T;
field T;
setAverage no;
average 0;
value uniform 0;

4
src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H
View File

@ -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
<patchName>
{
type mappedFixedPushedInternalValue;
fieldName T;
field T;
setAverage no;
average 0;
value uniform 0;

4
src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.H
View File

@ -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
<patchName>
{
type mapped;
fieldName T;
field T;
setAverage no;
average 0;
interpolationScheme cell;

4
src/functionObjects/field/fieldAverage/fieldAverage.H
View File

@ -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

6
src/functionObjects/field/valueAverage/valueAverage.H
View File

@ -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 \<timeDir\>/valueAverage.dat
@ -107,7 +109,7 @@ protected:
//- Average time per field
List<scalar> totalTime_;
//- Reset the averaging process on restart flag
//- Reset the averaging process on restart
bool resetOnRestart_;

2
src/fvOptions/sources/derived/radialActuationDiskSource/radialActuationDiskSource.H
View File

@ -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