src/OpenFOAM/primitives/bool/bool.H

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