src/foam/primitives/BlockCoeff/blockCoeffBase.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     blockCoeffBase
  26
  27 Description
  28     Base block coefficient for templated block coefficient types.
  29     Holds enumerations
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef blockCoeffBase_H
  37 #define blockCoeffBase_H
  38
  39 #include "NamedEnum.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                           Class blockCoeffBase Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class blockCoeffBase
  51 {
  52 public:
  53
  54     // Public data types
  55
  56         //- Enumeration defining the active level
  57         enum activeLevel
  58         {
  59             UNALLOCATED,
  60             SCALAR,
  61             LINEAR,
  62             SQUARE
  63         };
  64
  65     // Static member functions
  66
  67         //- Direction names
  68         static const NamedEnum<activeLevel, 4> activeLevelNames_;
  69 };
  70
  71
  72 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  73
  74 } // End namespace Foam
  75
  76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  77
  78 #endif
  79
  80 // ************************************************************************* //