songtianlun/openfoam
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

functionObjects:functionObjects:: Corrected documentation

Browse Source
This commit is contained in:
Henry Weller 2017-03-31 20:46:03 +01:00
parent 1f5b9dbbcf
commit 2b31d91a78
1 changed files with 14 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -34,27 +34,20 @@ Description
Fields are entered as a list of sub-dictionaries, which indicate the type of Fields are entered as a list of sub-dictionaries, which indicate the type of
averages to perform, and can be updated during the calculation. The current averages to perform, and can be updated during the calculation. The current
options include: options include:
- \c mean: arithmetic mean: - \c mean: arithmetic mean
\f[
\overline{x} = \frac{1}{N}\displaystyle\sum\limits_{i=0}^N x_i
\f]
- \c prime2Mean: prime-squared mean - \c prime2Mean: prime-squared mean
\f[ - \c base: average over 'time', or 'iteration'
\overline{x'}^2 = \frac{1}{N}\displaystyle\sum\limits_{i=0}^N - \c window: optional averaging window, specified in 'base' units
(x_i - \overline{x})^2
\f]
- base: average over 'time', or 'iteration' (\f$N\f$ in the above)
- window: optional averaging window, specified in 'base' units
Average field names are constructed by concatenating the base field with Average field names are constructed by concatenating the base field with
the averaging type, e.g. when averaging field 'U', the resultant fields the averaging type, e.g. when averaging field 'U', the resultant fields
are: are:
- arithmetic mean field, UMean - arithmetic mean field, \c UMean
- prime-squared field, UPrime2Mean - prime-squared field, \c UPrime2Mean
Information regarding the number of averaging steps, and total averaging Information regarding the number of averaging steps, and total averaging
time are written on a per-field basis to the time are written on a per-field basis to the \c "<functionObject
\c "<functionObject name>Properties" dictionary, located in \<time\>/uniform name>Properties" dictionary, located in \<time\>/uniform
When restarting form a previous calculation, the averaging is continuous or When restarting form a previous calculation, the averaging is continuous or
may be restarted using the \c restartOnRestart option. may be restarted using the \c restartOnRestart option.
@ -100,7 +93,7 @@ Description
Usage Usage
\table \table
Property | Description | Required | Default value Property | Description | Required | Default
type | type name: fieldAverage | yes | type | type name: fieldAverage | yes |
restartOnRestart | Restart the averaging on restart | no | no restartOnRestart | Restart the averaging on restart | no | no
restartOnOutput | Restart the averaging on output | no | no restartOnOutput | Restart the averaging on output | no | no