CirculatorBase.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) 2012 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::CirculatorBase
28 
29 Description
30  Base class for circulators
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef CirculatorBase_H
35 #define CirculatorBase_H
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 
42 
43 /*---------------------------------------------------------------------------*\
44  Class CirculatorBase Declaration
45 \*---------------------------------------------------------------------------*/
46 
47 class CirculatorBase
48 {
49 public:
50 
51  // Public data
52 
53  //- Direction type enumeration
54  enum direction
55  {
56  NONE,
57  CLOCKWISE,
58  ANTICLOCKWISE
59  };
60 
61 
62  // Constructors
63 
64  //- Construct null
65  CirculatorBase()
66  {}
67 
68 };
69 
70 
71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
72 
73 } // End namespace Foam
74 
75 
76 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
77 
78 #endif
79 
80 // ************************************************************************* //
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::CirculatorBase::direction
direction
Direction type enumeration.
Definition: CirculatorBase.H:53
Foam::CirculatorBase::CLOCKWISE
Definition: CirculatorBase.H:56
Foam::CirculatorBase::CirculatorBase
CirculatorBase()
Construct null.
Definition: CirculatorBase.H:64
Foam::CirculatorBase::NONE
Definition: CirculatorBase.H:55
Foam::CirculatorBase
Base class for circulators.
Definition: CirculatorBase.H:46
Foam::CirculatorBase::ANTICLOCKWISE
Definition: CirculatorBase.H:57