OpenFOAM: API Guide
v2012
The open source CFD toolbox
direction.H
Go to the documentation of this file.
1
/*---------------------------------------------------------------------------*\
2
========= |
3
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4
\\ / O peration |
5
\\ / A nd | www.openfoam.com
6
\\/ M anipulation |
7
-------------------------------------------------------------------------------
8
Copyright (C) 2011-2016 OpenFOAM Foundation
9
Copyright (C) 2020 OpenCFD Ltd.
10
-------------------------------------------------------------------------------
11
License
12
This file is part of OpenFOAM.
13
14
OpenFOAM is free software: you can redistribute it and/or modify it
15
under the terms of the GNU General Public License as published by
16
the Free Software Foundation, either version 3 of the License, or
17
(at your option) any later version.
18
19
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22
for more details.
23
24
You should have received a copy of the GNU General Public License
25
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27
Primitive
28
direction
29
30
Description
31
Direction is an 8-bit unsigned integer type used to represent
32
Cartesian directions, components etc.
33
34
Note
35
If a different typedef is used, "uint8.H" must be modified accordingly.
36
37
\*---------------------------------------------------------------------------*/
38
39
#ifndef primitives_direction_H
40
#define primitives_direction_H
41
42
#include <cstdint>
43
#include <iostream>
44
45
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46
47
namespace
Foam
48
{
49
50
// Forward Declarations
51
class
Istream;
52
class
Ostream
;
53
54
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
55
56
typedef
uint8_t
direction
;
57
58
//- Read direction (uint8_t) from stream.
59
direction
readDirection
(
Istream
& is);
60
61
Istream
&
operator>>
(
Istream
& is,
direction
& val);
62
Ostream
&
operator<<
(
Ostream
& os,
const
direction
val);
63
64
std::ostream&
operator<<
(std::ostream& os,
const
direction
val);
65
66
67
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
68
69
}
// End namespace Foam
70
71
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
72
73
#endif
74
75
// ************************************************************************* //
Foam::operator>>
Istream & operator>>(Istream &, directionInfo &)
Definition:
directionInfo.C:230
Foam::operator<<
Ostream & operator<<(Ostream &, const boundaryPatch &p)
Write boundaryPatch as dictionary entries (without surrounding braces)
Definition:
boundaryPatch.C:83
Foam::Istream
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition:
Istream.H:61
Foam::readDirection
direction readDirection(Istream &is)
Read direction (uint8_t) from stream.
Definition:
directionIO.C:34
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
Foam::direction
uint8_t direction
Definition:
direction.H:52
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition:
Ostream.H:56
src
OpenFOAM
primitives
direction
direction.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.