Merge /u/wyldckat/foam-extend32/ branch master into master
[foam-extend-3.2.git] / src / lagrangian / dieselSpray / spraySubModels / breakupModel / ETAB / ETAB.H
blob38d6a6a30b06822f801a13b14aab3cb3d52f2fdf
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::ETAB
27 Description
28     The Enhanced %TAB model.
30     Described in the papers below.
31     @verbatim
32     F.X. Tanner
33         "Liquid Jet Atomization and Droplet Breakup Modeling of
34         Non-Evaporating Diesel Fuel Sprays"
35         SAE 970050,
36         SAE Transactions: Journal of Engines, Vol 106, Sec 3 pp 127-140
38     F.X. Tanner and G. Weisser
39         "Simulation of Liquid Jet Atomization for
40         Fuel Sprays by Means of Cascade Drop Breakup Model"
41         SAE 980808
42         SAE Technical Paper Series
43     @endverbatim
45 See Also
46     The TAB model
48 SourceFiles
49     ETAB.C
51 \*---------------------------------------------------------------------------*/
53 #ifndef ETAB_H
54 #define ETAB_H
56 #include "breakupModel.H"
58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
60 namespace Foam
63 /*---------------------------------------------------------------------------*\
64                            Class ETAB Declaration
65 \*---------------------------------------------------------------------------*/
67 class ETAB
69     public breakupModel
71 private:
73     // Private data
75         dictionary coeffsDict_;
77         // model constants
79         // Cmu_ and Comega_ are the same as in the TAB model
80         scalar Cmu_;
81         scalar Comega_;
83         scalar k1_;
84         scalar k2_;
85         scalar WeCrit_;
86         scalar WeTransition_;
87         scalar AWe_;
89 public:
92     //- Runtime type information
93     TypeName("ETAB");
96     // Constructors
98         //- Construct from components
99         ETAB
100         (
101             const dictionary& dict,
102             spray& sm
103         );
106     // Destructor
108         ~ETAB();
111     // Member Functions
113         void breakupParcel
114         (
115             parcel& parcel,
116             const scalar deltaT,
117             const vector& Ug,
118             const liquidMixture& fuels
119         ) const;
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 } // End namespace Foam
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 #endif
132 // ************************************************************************* //