particleMacros.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-2016 OpenFOAM Foundation
9  Copyright (C) 2016-2019 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 InClass
28  Foam::particle
29 
30 Description
31  Macros for adding to particle property lists
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef particleMacros_H
36 #define particleMacros_H
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 //- Define a static 'propertyList' for particle properties
46 // The property list is space-delimited with brackets for vector groupings
47 // \sa AddToPropertyList
48 #define DefinePropertyList(str) \
49  \
50  static string propertyList_; \
51  \
52  static string propertyList() \
53  { \
54  return str; \
55  }
56 
57 
58 //- Add to existing static 'propertyList' for particle properties
59 // The property list is space-delimited with brackets for vector groupings
60 // \sa DefinePropertyList
61 #define AddToPropertyList(ParcelType, str) \
62  \
63  static string propertyList_; \
64  \
65  static string propertyList() \
66  { \
67  return ParcelType::propertyList() + str; \
68  }
69 
70 
71 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
72 
73 } // End namespace Foam
74 
75 #endif
76 
77 // ************************************************************************* //
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
DefinePropertyList
#define DefinePropertyList(str)
Define a static 'propertyList' for particle properties.
Definition: particleMacros.H:48
AddToPropertyList
#define AddToPropertyList(ParcelType, str)
Add to existing static 'propertyList' for particle properties.
Definition: particleMacros.H:61