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

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_;