OpenFOAM
7
The OpenFOAM Foundation
CirculatorBase.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) 2012-2018 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
Class
25
Foam::CirculatorBase
26
27
Description
28
Base class for circulators
29
30
\*---------------------------------------------------------------------------*/
31
32
#ifndef CirculatorBase_H
33
#define CirculatorBase_H
34
35
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
36
37
namespace
Foam
38
{
39
40
41
/*---------------------------------------------------------------------------*\
42
Class CirculatorBase Declaration
43
\*---------------------------------------------------------------------------*/
44
45
class
CirculatorBase
46
{
47
public
:
48
49
// Public data
50
51
//- Direction type enumeration
52
enum class
direction
53
{
54
none
,
55
clockwise
,
56
anticlockwise
57
};
58
59
60
// Constructors
61
62
//- Construct null
63
CirculatorBase
()
64
{}
65
};
66
67
68
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
69
70
}
// End namespace Foam
71
72
73
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
74
75
#endif
76
77
// ************************************************************************* //
Foam::CirculatorBase::direction::none
Foam::CirculatorBase::direction
direction
Direction type enumeration.
Definition:
CirculatorBase.H:51
Foam::CirculatorBase::CirculatorBase
CirculatorBase()
Construct null.
Definition:
CirculatorBase.H:62
Foam::CirculatorBase::direction::anticlockwise
Foam::CirculatorBase
Base class for circulators.
Definition:
CirculatorBase.H:44
Foam::CirculatorBase::direction::clockwise
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.H:213
src
OpenFOAM
containers
Circulators
CirculatorBase
CirculatorBase.H
Generated by
1.8.13