src/foam/primitives/bools/bool/bool.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     |
   5     \\  /    A nd           | For copyright notice see file Copyright
   6      \\/     M anipulation  |
   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 Primitive
  25     bool
  26
  27 Description
  28     System bool
  29
  30 SourceFiles
  31     boolIO.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef bool_H
  36 #define bool_H
  37
  38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  39
  40 namespace Foam
  41 {
  42
  43 class Istream;
  44 class Ostream;
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 Istream& operator>>(Istream&, bool&);
  49 Ostream& operator<<(Ostream&, const bool);
  50
  51 bool readBool(Istream&);
  52
  53 } // End namespace Foam
  54
  55
  56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  57
  58 #include "pTraits.H"
  59
  60 namespace Foam
  61 {
  62
  63 // template specialisation for pTraits<bool>
  64 template<>
  65 class pTraits<bool>
  66 {
  67     bool p_;
  68
  69 public:
  70
  71     //- Component type
  72     typedef bool cmptType;
  73
  74     // Member constants
  75
  76         enum
  77         {
  78             dim = 3,         // Dimensionality of space
  79             rank = 0,        // Rank of bool is 0
  80             nComponents = 1  // Number of components in bool is 1
  81         };
  82
  83
  84     // Static data members
  85
  86         static const char* const typeName;
  87         static const char* componentNames[];
  88         static const bool zero;
  89         static const bool one;
  90
  91
  92     // Constructors
  93
  94         //- Construct from bool
  95         pTraits(const bool b)
  96         {
  97             p_ = b;
  98         }
  99
 100         //- Construct from Istream
 101         pTraits(Istream&);
 102
 103
 104     // Member Functions
 105
 106         operator bool() const
 107         {
 108             return p_;
 109         }
 110
 111         operator bool&()
 112         {
 113             return p_;
 114         }
 115 };
 116
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 } // End namespace Foam
 121
 122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 123
 124 #endif
 125
 126 // ************************************************************************* //