diff --git a/src/functionObjects/field/fieldAverage/fieldAverage.H b/src/functionObjects/field/fieldAverage/fieldAverage.H index 850f6f72a8..7d874a62b3 100644 --- a/src/functionObjects/field/fieldAverage/fieldAverage.H +++ b/src/functionObjects/field/fieldAverage/fieldAverage.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | - \\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -34,27 +34,20 @@ Description 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 options include: - - \c mean: arithmetic mean: - \f[ - \overline{x} = \frac{1}{N}\displaystyle\sum\limits_{i=0}^N x_i - \f] + - \c mean: arithmetic mean - \c prime2Mean: prime-squared mean - \f[ - \overline{x'}^2 = \frac{1}{N}\displaystyle\sum\limits_{i=0}^N - (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 + - \c base: average over 'time', or 'iteration' + - \c window: optional averaging window, specified in 'base' units Average field names are constructed by concatenating the base field with the averaging type, e.g. when averaging field 'U', the resultant fields are: - - arithmetic mean field, UMean - - prime-squared field, UPrime2Mean + - arithmetic mean field, \c UMean + - prime-squared field, \c UPrime2Mean Information regarding the number of averaging steps, and total averaging - time are written on a per-field basis to the - \c "Properties" dictionary, located in \/uniform + time are written on a per-field basis to the \c "Properties" dictionary, located in \/uniform When restarting form a previous calculation, the averaging is continuous or may be restarted using the \c restartOnRestart option. @@ -100,12 +93,12 @@ Description 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 - periodicRestart | Periodically restart the averaging | no | no - restartPeriod | Periodic restart period | conditional | + Property | Description | Required | Default + type | type name: fieldAverage | yes | + 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 | fields | list of fields and averaging options | yes | \endtable