FreeFOAM The Cross-Platform CFD Toolkit
collisionModel.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) 1991-2010 OpenCFD Ltd.
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::collisionModel
26 
27 Description
28  Base case for selecting a collision model
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef collisionModel_H
33 #define collisionModel_H
34 
35 #include <OpenFOAM/IOdictionary.H>
36 #include <dieselSpray/spray.H>
37 #include <OpenFOAM/Random.H>
38 #include <OpenFOAM/Switch.H>
39 #include <OpenFOAM/autoPtr.H>
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class collisionModel Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 {
53 
54 protected:
55 
56  // Protected data
57  const dictionary& dict_;
60 
61  //dictionary coeffsDict_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("collisionModel");
68 
69  // Declare runtime constructor selection table
70 
72  (
73  autoPtr,
75  dictionary,
76  (
77  const dictionary& dict,
78  spray& sm,
79  Random& rndGen
80  ),
81  (dict, sm, rndGen)
82  );
83 
84 
85  // Constructors
86 
87  //- Construct from components
89  (
90  const dictionary& dict,
91  spray& sm,
92  Random& rndGen
93  );
94 
95 
96  // Destructor
97 
98  virtual ~collisionModel();
99 
100 
101  // Selector
102 
104  (
105  const dictionary& dict,
106  spray& sm,
107  Random& rndGen
108  );
109 
110 
111  // Member Functions
112 
113  virtual void collideParcels(const scalar dt) const = 0;
114 };
115 
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 } // End namespace Foam
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************ vim: set sw=4 sts=4 et: ************************ //