bool.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 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 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 inline void writeEntry(Ostream& os, const bool value)
54 {
55  os << value;
56 }
57 
58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
59 
60 } // End namespace Foam
61 
62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
63 
64 #include "pTraits.H"
65 #include "direction.H"
66 
67 namespace Foam
68 {
69 
70 // template specialisation for pTraits<bool>
71 template<>
72 class pTraits<bool>
73 {
74  bool p_;
75 
76 public:
77 
78  //- Component type
79  typedef bool cmptType;
80 
81  // Member constants
82 
83  //- Dimensionality of space
84  static const direction dim = 3;
85 
86  //- Rank of bool is 0
87  static const direction rank = 0;
88 
89  //- Number of components in bool is 1
90  static const direction nComponents = 1;
91 
92 
93  // Static Data Members
94 
95  static const char* const typeName;
96  static const char* const componentNames[];
97  static const bool zero;
98  static const bool one;
99 
100 
101  // Constructors
102 
103  //- Construct from primitive
104  explicit pTraits(const bool&);
105 
106  //- Construct from Istream
107  pTraits(Istream&);
108 
109 
110  // Member Functions
111 
112  //- Access to the bool value
113  operator bool() const
114  {
115  return p_;
116  }
117 
118  //- Access to the bool value
119  operator bool&()
120  {
121  return p_;
122  }
123 };
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace Foam
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************************************************************* //
uint8_t direction
Definition: direction.H:45
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
Traits class for primitives.
Definition: pTraits.H:50
bool readBool(Istream &)
Definition: boolIO.C:60
static const bool one
Definition: bool.H:98
static const bool zero
Definition: bool.H:97
Istream & operator>>(Istream &, directionInfo &)
static const char *const typeName
Definition: bool.H:95
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
void writeEntry(Ostream &os, const HashTable< T, Key, Hash > &ht)
Definition: HashTableIO.C:96
Direction is an 8-bit unsigned integer type used to represent the Cartesian directions etc...
Ostream & operator<<(Ostream &, const ensightPart &)
pTraits(const PrimitiveType &p)
Construct from primitive.
Definition: pTraits.H:60
bool cmptType
Component type.
Definition: bool.H:79
Namespace for OpenFOAM.