PDRobstacleTypes.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) 2019 OpenCFD Ltd.
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 Namespace
27  Foam::PDRobstacles
28 
29 Description
30  Reader classes for concrete PDRsetFields obstacle types.
31 
32 SourceFiles
33  PDRobstacleTypes.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef PDRobstacleTypes_H
38 #define PDRobstacleTypes_H
39 
40 #include "PDRobstacle.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace PDRobstacles
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class cylinder Declaration
51 \*---------------------------------------------------------------------------*/
52 
77 struct cylinder : public PDRobstacle
78 {
79  static constexpr int enumTypeId = legacyTypes::CYLINDER;
80  static void read(PDRobstacle& obs, const dictionary& dict);
81 };
82 
83 
84 
85 /*---------------------------------------------------------------------------*\
86  Class diagbeam Declaration
87 \*---------------------------------------------------------------------------*/
88 
119 struct diagbeam : public PDRobstacle
120 {
121  static constexpr int enumTypeId = legacyTypes::DIAG_BEAM;
122  static void read(PDRobstacle& obs, const dictionary& dict);
123 };
124 
125 
126 /*---------------------------------------------------------------------------*\
127  Class cuboid Declaration
128 \*---------------------------------------------------------------------------*/
129 
150 struct cuboid : public PDRobstacle
151 {
152  static constexpr int enumTypeId = legacyTypes::CUBOID;
153  static void read(PDRobstacle& obs, const dictionary& dict);
154 };
155 
156 
157 
158 /*---------------------------------------------------------------------------*\
159  Class wallbeam Declaration
160 \*---------------------------------------------------------------------------*/
161 
183 struct wallbeam : public PDRobstacle
184 {
185  static constexpr int enumTypeId = legacyTypes::WALL_BEAM;
186  static void read(PDRobstacle& obs, const dictionary& dict);
187 };
188 
189 
190 /*---------------------------------------------------------------------------*\
191  Class grating Declaration
192 \*---------------------------------------------------------------------------*/
193 
217 struct grating : public PDRobstacle
218 {
219  static constexpr int enumTypeId = legacyTypes::GRATING;
220  static void read(PDRobstacle& obs, const dictionary& dict);
221 };
222 
223 
224 /*---------------------------------------------------------------------------*\
225  Class louver Declaration
226 \*---------------------------------------------------------------------------*/
227 
251 struct louver : public PDRobstacle
252 {
253  static constexpr int enumTypeId = legacyTypes::LOUVER_BLOWOFF;
254  static void read(PDRobstacle& obs, const dictionary& dict);
255 };
256 
257 
258 /*---------------------------------------------------------------------------*\
259  Class patch Declaration
260 \*---------------------------------------------------------------------------*/
261 
284 struct patch : public PDRobstacle
285 {
286  static constexpr int enumTypeId = legacyTypes::RECT_PATCH;
287  static void read(PDRobstacle& obs, const dictionary& dict);
288 };
289 
290 
291 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
292 
293 } // End namespace PDRobstacles
294 } // End namespace Foam
295 
296 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
297 
298 #endif
299 
300 // ************************************************************************* //
Foam::PDRobstacles::wallbeam::enumTypeId
static constexpr int enumTypeId
Definition: PDRobstacleTypes.H:276
Foam::PDRobstacles::louver::enumTypeId
static constexpr int enumTypeId
Definition: PDRobstacleTypes.H:394
Foam::PDRobstacles::grating
A grating, selectable as grate or grating.
Definition: PDRobstacleTypes.H:328
PDRobstacle.H
Foam::PDRobstacles::cuboid::enumTypeId
static constexpr int enumTypeId
Definition: PDRobstacleTypes.H:228
Foam::PDRobstacle::PDRobstacle
PDRobstacle()
Foam::PDRobstacles::diagbeam::read
static void read(PDRobstacle &obs, const dictionary &dict)
Foam::PDRobstacles::patch
Rectangular patch, selectable as patch.
Definition: PDRobstacleTypes.H:450
Foam::PDRobstacles::louver
Louver blowoff, selectable as louver or louvre.
Definition: PDRobstacleTypes.H:392
Foam::PDRobstacles::cuboid
A cuboid, selectable as box.
Definition: PDRobstacleTypes.H:226
cuboid
Specialization of rigidBody to construct a cuboid given the mass and lengths of the sides.
Foam::PDRobstacles::cylinder::enumTypeId
static constexpr int enumTypeId
Definition: PDRobstacleTypes.H:100
Foam::PDRobstacles::diagbeam
A diagonal beam, which is cylinder-like, selectable as diag or diagbeam.
Definition: PDRobstacleTypes.H:170
Foam::PDRobstacles::wallbeam
A wallbeam, selectable as wallbeam which is currently identical to a box (PDRobstacles::cuboid)
Definition: PDRobstacleTypes.H:274
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::PDRobstacles::louver::read
static void read(PDRobstacle &obs, const dictionary &dict)
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:119
Foam
Definition: atmBoundaryLayer.C:26
Foam::PDRobstacles::patch::read
static void read(PDRobstacle &obs, const dictionary &dict)
Foam::PDRobstacles::wallbeam::read
static void read(PDRobstacle &obs, const dictionary &dict)
Foam::PDRobstacles::grating::enumTypeId
static constexpr int enumTypeId
Definition: PDRobstacleTypes.H:330
Foam::PDRobstacles::cylinder
A cylinder, selectable as cyl or cylinder.
Definition: PDRobstacleTypes.H:98
Foam::PDRobstacle
Obstacle definitions for PDR.
Definition: PDRobstacle.H:70
Foam::PDRobstacles::cylinder::read
static void read(PDRobstacle &obs, const dictionary &dict)
Foam::PDRobstacles::diagbeam::enumTypeId
static constexpr int enumTypeId
Definition: PDRobstacleTypes.H:172
Foam::PDRobstacles::grating::read
static void read(PDRobstacle &obs, const dictionary &dict)
Foam::PDRobstacles::cuboid::read
static void read(PDRobstacle &obs, const dictionary &dict)
Foam::PDRobstacles::patch::enumTypeId
static constexpr int enumTypeId
Definition: PDRobstacleTypes.H:452