FreeFOAM The Cross-Platform CFD Toolkit
breakupModel.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::breakupModel
26 
27 Description
28  Base class for selecting a breakup model
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef breakupModel_H
33 #define breakupModel_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 breakupModel Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 {
51 
52 protected:
53 
54  // Protected data
55 
56  const dictionary& dict_;
57 
60 
62 
64  scalar y0_;
65  scalar yDot0_;
66  scalar TABComega_;
67  scalar TABCmu_;
68  scalar TABWeCrit_;
69 
70 
71 public:
72 
73  //- Runtime type information
74  TypeName("breakupModel");
75 
76  // Declare runtime constructor selection table
77 
79  (
80  autoPtr,
82  dictionary,
83  (
84  const dictionary& dict,
85  spray& sm
86  ),
87  (dict, sm)
88  );
89 
90 
91  // Constructors
92 
93  //- Construct from components
95  (
96  const dictionary& dict,
97  spray& sm
98  );
99 
100 
101  // Destructor
102 
103  virtual ~breakupModel();
104 
105 
106  // Selector
107 
109  (
110  const dictionary& dict,
111  spray& sm
112  );
113 
114 
115  // Member Functions
116 
117  //- Return the initial deviation from sphericity
118  inline scalar y0() const
119  {
120  return y0_;
121  }
122 
123  //- Return the initial rate of deviation from sphericity
124  inline scalar yDot0() const
125  {
126  return yDot0_;
127  }
128 
130  (
131  parcel& p,
132  const scalar deltaT,
133  const vector& Ug,
134  const liquidMixture& fuels
135  ) const;
136 
137  virtual void breakupParcel
138  (
139  parcel& parcel,
140  const scalar deltaT,
141  const vector& vel,
142  const liquidMixture& fuels
143  ) const = 0;
144 
145 };
146 
147 
148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
149 
150 } // End namespace Foam
151 
152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 
154 #endif
155 
156 // ************************ vim: set sw=4 sts=4 et: ************************ //
157