src/postProcessing/functionObjects/field/fieldAverage/fieldAverageItem/fieldAverageItem.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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 Class
  25     Foam::fieldAverageItem
  26
  27 Description
  28     Helper class to describe what form of averaging to apply. A set will be
  29     applied to each base field in Foam::fieldAverage, of the form:
  30
  31     \verbatim
  32         {
  33             mean            on;
  34             prime2Mean      on;
  35             base            time; // iteration
  36         }
  37     \endverbatim
  38
  39 SourceFiles
  40     fieldAverageItem.C
  41     fieldAverageItemIO.C
  42
  43 \*---------------------------------------------------------------------------*/
  44
  45 #ifndef fieldAverageItem_H
  46 #define fieldAverageItem_H
  47
  48 #include "NamedEnum.H"
  49 #include "Switch.H"
  50
  51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  52
  53 namespace Foam
  54 {
  55
  56 // Forward declaration of classes
  57 class Istream;
  58 class Ostream;
  59
  60 // Forward declaration of friend functions and operators
  61 class fieldAverageItem;
  62 Istream& operator>>(Istream&, fieldAverageItem&);
  63 Ostream& operator<<(Ostream&, const fieldAverageItem&);
  64
  65
  66 /*---------------------------------------------------------------------------*\
  67                       Class fieldAverageItem Declaration
  68 \*---------------------------------------------------------------------------*/
  69
  70 class fieldAverageItem
  71 {
  72 public:
  73
  74     // Public data
  75
  76         //- Enumeration defining the averaging base type
  77         enum baseType
  78         {
  79             ITER,
  80             TIME
  81         };
  82
  83
  84 private:
  85
  86     // Private data
  87
  88         //- Field name
  89         word fieldName_;
  90
  91         //- Compute mean flag
  92         Switch mean_;
  93
  94         //- Compute prime-squared mean flag
  95         Switch prime2Mean_;
  96
  97         //- Averaging base type names
  98         static const NamedEnum<baseType, 2> baseTypeNames_;
  99
 100         //- Averaging base type
 101         baseType base_;
 102
 103
 104 public:
 105
 106     // Constructors
 107
 108         //- Construct null
 109         fieldAverageItem();
 110
 111         //- Construct from Istream
 112         fieldAverageItem(Istream&);
 113
 114         //- Construct as copy
 115         fieldAverageItem(const fieldAverageItem&);
 116
 117
 118     //- Destructor
 119     ~fieldAverageItem();
 120
 121
 122     // Member Functions
 123
 124         // Access
 125
 126             //- Return const access to the field name
 127             const word& fieldName() const
 128             {
 129                 return fieldName_;
 130             }
 131
 132             //- Return const access to the mean flag
 133             const Switch& mean() const
 134             {
 135                 return mean_;
 136             }
 137
 138             //- Return const access to the prime-squared mean flag
 139             const Switch& prime2Mean() const
 140             {
 141                 return prime2Mean_;
 142             }
 143
 144             //- Return averaging base type name
 145             const word base() const
 146             {
 147                 return baseTypeNames_[base_];
 148             }
 149
 150             //- Return true if base is ITER
 151             Switch ITERBase() const
 152             {
 153                 return base_ == ITER;
 154             }
 155
 156             //- Return true if base is time
 157             Switch timeBase() const
 158             {
 159                 return base_ == TIME;
 160             }
 161
 162
 163     // Member Operators
 164
 165         void operator=(const fieldAverageItem&);
 166
 167
 168     // Friend Operators
 169
 170         friend bool operator==
 171         (
 172             const fieldAverageItem& a,
 173             const fieldAverageItem& b
 174         )
 175         {
 176             return
 177                 a.fieldName_ == b.fieldName_
 178              && a.mean_ == b.mean_
 179              && a.prime2Mean_ == b.prime2Mean_
 180              && a.base_ == b.base_;
 181         }
 182
 183         friend bool operator!=
 184         (
 185             const fieldAverageItem& a,
 186             const fieldAverageItem& b
 187         )
 188         {
 189             return !(a == b);
 190         }
 191
 192
 193     // IOstream Operators
 194
 195         friend Istream& operator>>(Istream&, fieldAverageItem&);
 196         friend Ostream& operator<<(Ostream&, const fieldAverageItem&);
 197 };
 198
 199
 200 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 201
 202 } // End namespace Foam
 203
 204 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 205
 206 #endif
 207
 208 // ************************************************************************* //