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