fieldAverageItem.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 #include "fieldAverageItem.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32  const word fieldAverageItem::EXT_MEAN = "Mean";
33  const word fieldAverageItem::EXT_PRIME2MEAN = "Prime2Mean";
34 
35  template<>
36  const char* Foam::NamedEnum
37  <
39  2
40  >::names[] =
41  {
42  "iteration",
43  "time"
44  };
45 }
46 
47 
50 
51 
52 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
53 
55 :
56  active_(false),
57  fieldName_("unknown"),
58  mean_(0),
59  meanFieldName_("unknown"),
60  prime2Mean_(0),
61  prime2MeanFieldName_("unknown"),
62  base_(ITER),
63  window_(-1.0),
64  windowName_("")
65 {}
66 
67 
69 :
70  active_(faItem.active_),
71  fieldName_(faItem.fieldName_),
72  mean_(faItem.mean_),
73  meanFieldName_(faItem.meanFieldName_),
74  prime2Mean_(faItem.prime2Mean_),
75  prime2MeanFieldName_(faItem.prime2MeanFieldName_),
76  base_(faItem.base_),
77  window_(faItem.window_),
78  windowName_(faItem.windowName_)
79 {}
80 
81 
82 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
83 
85 {}
86 
87 
88 // * * * * * * * * * * * * * * * Member Operators * * * * * * * * * * * * * //
89 
91 {
92  // Check for assignment to self
93  if (this == &rhs)
94  {
96  << "Attempted assignment to self" << nl
97  << abort(FatalError);
98  }
99 
100  // Set updated values
101  active_ = rhs.active_;
102  fieldName_ = rhs.fieldName_;
103  mean_ = rhs.mean_;
104  meanFieldName_ = rhs.meanFieldName_;
105  prime2Mean_ = rhs.prime2Mean_;
106  prime2MeanFieldName_ = rhs.prime2MeanFieldName_;
107  base_ = rhs.base_;
108  window_ = rhs.window_;
109  windowName_ = rhs.windowName_;
110 }
111 
112 
113 // ************************************************************************* //
Foam::fieldAverageItem
Helper class to describe what form of averaging to apply. A set will be applied to each base field in...
Definition: fieldAverageItem.H:74
Foam::fieldAverageItem::EXT_MEAN
static const word EXT_MEAN
Mean average.
Definition: fieldAverageItem.H:83
Foam::fieldAverageItem::fieldAverageItem
fieldAverageItem()
Construct null.
Definition: fieldAverageItem.C:54
Foam::fieldAverageItem::~fieldAverageItem
~fieldAverageItem()
Destructor.
Definition: fieldAverageItem.C:84
Foam::fieldAverageItem::window_
scalar window_
Averaging window - defaults to -1 for 'all iters/time'.
Definition: fieldAverageItem.H:125
Foam::fieldAverageItem::mean_
Switch mean_
Compute mean flag.
Definition: fieldAverageItem.H:107
Foam::nl
static const char nl
Definition: Ostream.H:260
fieldAverageItem.H
Foam::fieldAverageItem::base_
baseType base_
Averaging base type.
Definition: fieldAverageItem.H:122
Foam::FatalError
error FatalError
Foam::fieldAverageItem::windowName_
word windowName_
Averaging window name - defaults to 'window'.
Definition: fieldAverageItem.H:128
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:131
Foam::fieldAverageItem::prime2Mean_
Switch prime2Mean_
Compute prime-squared mean flag.
Definition: fieldAverageItem.H:113
Foam::fieldAverageItem::active_
Switch active_
Active flag.
Definition: fieldAverageItem.H:101
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:318
Foam::fieldAverageItem::fieldName_
word fieldName_
Field name.
Definition: fieldAverageItem.H:104
Foam::fieldAverageItem::baseType
baseType
Enumeration defining the averaging base type.
Definition: fieldAverageItem.H:89
Foam::fieldAverageItem::EXT_PRIME2MEAN
static const word EXT_PRIME2MEAN
Prime-squared average.
Definition: fieldAverageItem.H:86
Foam::fieldAverageItem::operator=
void operator=(const fieldAverageItem &)
Definition: fieldAverageItem.C:90
Foam::fieldAverageItem::baseTypeNames_
static const NamedEnum< baseType, 2 > baseTypeNames_
Averaging base type names.
Definition: fieldAverageItem.H:119
Foam::fieldAverageItem::prime2MeanFieldName_
word prime2MeanFieldName_
Name of prime-squared mean field.
Definition: fieldAverageItem.H:116
Foam::NamedEnum
Initialise the NamedEnum HashTable from the static list of names.
Definition: NamedEnum.H:52
Foam::fieldAverageItem::meanFieldName_
word meanFieldName_
Name of mean field.
Definition: fieldAverageItem.H:110