FreeFOAM The Cross-Platform CFD Toolkit
dispersionModel.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::dispersionModel
26 
27 Description
28  Foam::dispersionModel
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef dispersionModel_H
33 #define dispersionModel_H
34 
35 #include <OpenFOAM/IOdictionary.H>
36 #include <dieselSpray/spray.H>
37 #include <OpenFOAM/autoPtr.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class dispersionModel Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 {
51 
52 protected:
53 
54  // Protected data
55 
56  const dictionary& dict_;
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("dispersionModel");
64 
65 
66  // Declare runtime constructor selection table
67 
69  (
70  autoPtr,
72  dictionary,
73  (
74  const dictionary& dict,
75  spray& sm
76  ),
77  (dict, sm)
78  );
79 
80 
81  // Constructors
82 
83  //- Construct from components
85  (
86  const dictionary& dict,
87  spray& sm
88  );
89 
90 
91  // Destructor
92 
93  virtual ~dispersionModel();
94 
95 
96  // Selector
97 
99  (
100  const dictionary& dict,
101  spray& sm
102  );
103 
104 
105  // Member Functions
106 
107  virtual void disperseParcels() const = 0;
108 };
109 
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #endif
118 
119 // ************************ vim: set sw=4 sts=4 et: ************************ //