BinaryCollisionModel.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 | Copyright (C) 2011-2015 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::BinaryCollisionModel
26 
27 Description
28  Templated DSMC particle collision class
29 
30 SourceFiles
31  BinaryCollisionModel.C
32  BinaryCollisionModelNew.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef BinaryCollisionModel_H
37 #define BinaryCollisionModel_H
38 
39 #include "IOdictionary.H"
40 #include "autoPtr.H"
41 #include "runTimeSelectionTables.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class BinaryCollisionModel Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 template<class CloudType>
53 class BinaryCollisionModel
54 {
55  // Private data
56 
57  //- The cloud dictionary
58  const dictionary& dict_;
59 
60  // reference to the owner cloud class
61  CloudType& owner_;
62 
63  //- The coefficients dictionary
64  const dictionary coeffDict_;
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("BinaryCollisionModel");
71 
72  //- Declare runtime constructor selection table
74  (
75  autoPtr,
77  dictionary,
78  (
79  const dictionary& dict,
81  ),
82  (dict, owner)
83  );
84 
85 
86  // Constructors
87 
88  //- Construct null from owner
90 
91  //- Construct from components
93  (
94  const dictionary& dict,
95  CloudType& owner,
96  const word& type
97  );
98 
99 
100  //- Destructor
101  virtual ~BinaryCollisionModel();
102 
103 
104  //- Selector
105  static autoPtr<BinaryCollisionModel<CloudType> > New
106  (
107  const dictionary& dict,
108  CloudType& owner
109  );
110 
111 
112  // Access
113 
114  //- Return the owner cloud object
115  const CloudType& owner() const;
116 
117  //- Return non-const access to the owner cloud object
118  CloudType& owner();
119 
120  //- Return the dictionary
121  const dictionary& dict() const;
122 
123  //- Return the coefficients dictionary
124  const dictionary& coeffDict() const;
125 
126 
127  // Member Functions
128 
129  //- Flag to indicate whether model activates collision model
130  virtual bool active() const = 0;
131 
132  //- Return the collision cross section * relative velocity product
133  virtual scalar sigmaTcR
134  (
135  const typename CloudType::parcelType& pP,
136  const typename CloudType::parcelType& pQ
137  ) const = 0;
138 
139  //- Apply collision
140  virtual void collide
141  (
142  typename CloudType::parcelType& pP,
143  typename CloudType::parcelType& pQ
144  ) = 0;
145 };
146 
147 
148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
149 
150 } // End namespace Foam
151 
152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
154 #define makeBinaryCollisionModel(CloudType) \
155  \
156  defineNamedTemplateTypeNameAndDebug \
157  ( \
158  BinaryCollisionModel<CloudType>, \
159  0 \
160  ); \
161  \
162  defineTemplateRunTimeSelectionTable \
163  ( \
164  BinaryCollisionModel<CloudType>, \
165  dictionary \
166  );
167 
169 #define makeBinaryCollisionModelType(SS, CloudType) \
170  \
171  defineNamedTemplateTypeNameAndDebug(SS<CloudType>, 0); \
172  \
173  BinaryCollisionModel<CloudType>:: \
174  adddictionaryConstructorToTable<SS<CloudType> > \
175  add##SS##CloudType##ConstructorToTable_;
176 
177 
178 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
179 
180 #ifdef NoRepository
181 # include "BinaryCollisionModel.C"
182 #endif
183 
184 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
185 
186 #endif
187 
188 // ************************************************************************* //
virtual scalar sigmaTcR(const typename CloudType::parcelType &pP, const typename CloudType::parcelType &pQ) const =0
Return the collision cross section * relative velocity product.
virtual bool active() const =0
Flag to indicate whether model activates collision model.
virtual void collide(typename CloudType::parcelType &pP, typename CloudType::parcelType &pQ)=0
Apply collision.
declareRunTimeSelectionTable(autoPtr, BinaryCollisionModel, dictionary,( const dictionary &dict, CloudType &owner ),(dict, owner))
Declare runtime constructor selection table.
Macros to ease declaration of run-time selection tables.
virtual ~BinaryCollisionModel()
Destructor.
const dictionary & dict() const
Return the dictionary.
DSMCCloud< dsmcParcel > CloudType
Namespace for OpenFOAM.
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:217
const dictionary & coeffDict() const
Return the coefficients dictionary.
static autoPtr< BinaryCollisionModel< CloudType > > New(const dictionary &dict, CloudType &owner)
Selector.
fileName::Type type(const fileName &)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:589
const CloudType & owner() const
Return the owner cloud object.
BinaryCollisionModel(CloudType &owner)
Construct null from owner.
TypeName("BinaryCollisionModel")
Runtime type information.