File size: 11,206 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2025 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::functionObjects::fieldAverage
Description
Calculates average quantities for a user-specified selection of volumetric
and surface fields.
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
- \c prime2Mean: prime-squared mean
- \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, \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 "<functionObject
name>Properties" dictionary, located in \<time\>/uniform
When restarting form a previous calculation, the averaging is continuous or
may be restarted using the \c restartOnRestart option.
The averaging process may be restarted after each calculation output time
using the \c restartOnOutput option or restarted periodically using the \c
periodicRestart option and setting \c restartPeriod to the required
averaging period.
Example of function object specification:
\verbatim
fieldAverage1
{
type fieldAverage;
libs ("libfieldFunctionObjects.so");
writeControl writeTime;
restartOnRestart false;
restartOnOutput false;
periodicRestart false;
restartPeriod 0.002;
base time;
window 10.0;
windowName w1;
mean yes;
prime2Mean yes;
fields (U p);
}
\endverbatim
Usage
\table
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
Note:
To employ the \c prime2Mean option, the \c mean option must be selected.
See also
Foam::functionObjects::fvMeshFunctionObject
Foam::functionObject
SourceFiles
fieldAverage.C
fieldAverageTemplates.C
fieldAverageItem.C
\*---------------------------------------------------------------------------*/
#ifndef fieldAverage_functionObject_H
#define fieldAverage_functionObject_H
#include "fvMeshFunctionObject.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
// Forward declaration of classes
class fieldAverageItem;
/*---------------------------------------------------------------------------*\
Class fieldAverage Declaration
\*---------------------------------------------------------------------------*/
class fieldAverage
:
public fvMeshFunctionObject
{
public:
//- Enumeration defining the averaging base type
enum class baseType
{
iter,
time
};
protected:
// Protected data
//- Time at last call, prevents repeated averaging
label prevTimeIndex_;
//- Restart the averaging process on restart
Switch restartOnRestart_;
//- Restart the averaging process on output
Switch restartOnOutput_;
//- Periodically restart the averaging process
Switch periodicRestart_;
//- Restart period
scalar restartPeriod_;
//- Averaging base type names
static const NamedEnum<baseType, 2> baseTypeNames_;
//- Averaging base type
baseType base_;
//- Averaging window - defaults to -1 for 'all iters/time'
scalar window_;
//- Averaging window name - defaults to 'window'
word windowName_;
//- Compute mean flag
Switch mean_;
//- Compute prime-squared mean flag
Switch prime2Mean_;
//- List of field average items, describing what averages to be
// calculated and output
PtrList<fieldAverageItem> faItems_;
//- Iteration steps counter
List<label> totalIter_;
//- Total time counter
List<scalar> totalTime_;
// Protected Member Functions
// Initialisation routines
//- Reset lists (clear existing values) and initialise averaging.
// Check requested field averages are valid, populate field lists
void initialise();
//- Restart averaging for restartOnOutput
void restart();
//- Read the mean average field
template<class Type>
void readMeanFieldType(const label fieldi);
//- Read the mean average field
template<class Type>
void readMeanField(const label fieldi);
//- Initialise the mean average field
template<class Type>
void initialiseMeanFieldType(const label fieldi);
//- Initialise the mean average field
template<class Type>
void initialiseMeanField(const label fieldi);
//- Read the prime-squared average field
template<class Type1, class Type2>
void readPrime2MeanFieldType(const label fieldi);
//- Read the prime-squared average field
template<class Type1, class Type2>
void readPrime2MeanField(const label fieldi);
//- Initialise the prime-squared average field
template<class Type1, class Type2>
void initialisePrime2MeanFieldType(const label fieldi);
//- Initialise the prime-squared average field
template<class Type1, class Type2>
void initialisePrime2MeanField(const label fieldi);
// Calculation functions
//- Main calculation routine
virtual void calcAverages();
//- Calculate mean average fields
template<class Type>
void calculateMeanFieldType(const label fieldi) const;
//- Calculate mean average fields
template<class Type>
void calculateMeanFields() const;
//- Calculate prime-squared average fields
template<class Type1, class Type2>
void calculatePrime2MeanFieldType(const label fieldi) const;
//- Calculate prime-squared average fields
template<class Type1, class Type2>
void calculatePrime2MeanFields() const;
//- Add mean-squared field value to prime-squared mean field
template<class Type1, class Type2>
void addMeanSqrToPrime2MeanType(const label fieldi) const;
//- Add mean-squared field value to prime-squared mean field
template<class Type1, class Type2>
void addMeanSqrToPrime2Mean() const;
// I-O
//- Write averages
virtual void writeAverages() const;
//- Write fields
template<class Type>
void writeFieldType(const word& fieldName) const;
//- Write fields
template<class Type>
void writeFields() const;
//- Read
void read(const dictionary& dict, const bool construct);
public:
friend class fieldAverageItem;
//- Runtime type information
TypeName("fieldAverage");
// Constructors
//- Construct from Time and dictionary
fieldAverage
(
const word& name,
const Time& runTime,
const dictionary&
);
//- Disallow default bitwise copy construction
fieldAverage(const fieldAverage&) = delete;
//- Destructor
virtual ~fieldAverage();
// Member Functions
// Access
//- Return averaging base type name
const word base() const
{
return baseTypeNames_[base_];
}
//- Return true if base is iter
Switch iterBase() const
{
return base_ == baseType::iter;
}
//- Return true if base is time
Switch timeBase() const
{
return base_ == baseType::time;
}
scalar window() const
{
return window_;
}
const word& windowName() const
{
return windowName_;
}
//- Read the field average data
virtual bool read(const dictionary&);
//- Return the list of fields required
virtual wordList fields() const;
//- Do not average at the start of the run
virtual bool executeAtStart() const
{
return false;
}
//- Calculate the field averages
virtual bool execute();
//- Write the field averages
virtual bool write();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const fieldAverage&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "fieldAverageTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|