initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / lagrangian / dieselSpray / spraySubModels / breakupModel / ETAB / ETAB.H
blob6998220c827915e589080326a4883e81f74ade46
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::ETAB
28 Description
29     The Enhanced %TAB model.
31     Described in the papers below.
32     @verbatim
33     F.X. Tanner
34         "Liquid Jet Atomization and Droplet Breakup Modeling of
35         Non-Evaporating Diesel Fuel Sprays"
36         SAE 970050,
37         SAE Transactions: Journal of Engines, Vol 106, Sec 3 pp 127-140
39     F.X. Tanner and G. Weisser
40         "Simulation of Liquid Jet Atomization for
41         Fuel Sprays by Means of Cascade Drop Breakup Model"
42         SAE 980808
43         SAE Technical Paper Series
44     @endverbatim
46 See Also
47     The TAB model
49 SourceFiles
50     ETAB.C
52 \*---------------------------------------------------------------------------*/
54 #ifndef ETAB_H
55 #define ETAB_H
57 #include "breakupModel.H"
59 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
61 namespace Foam
64 /*---------------------------------------------------------------------------*\
65                            Class ETAB Declaration
66 \*---------------------------------------------------------------------------*/
68 class ETAB
70     public breakupModel
72 private:
74     // Private data
76         dictionary coeffsDict_;
78         // model constants
80         // Cmu_ and Comega_ are the same as in the TAB model
81         scalar Cmu_;
82         scalar Comega_;
84         scalar k1_;
85         scalar k2_;
86         scalar WeCrit_;
87         scalar WeTransition_;
88         scalar AWe_;
90 public:
93     //- Runtime type information
94     TypeName("ETAB");
97     // Constructors
99         //- Construct from components
100         ETAB
101         (
102             const dictionary& dict,
103             spray& sm
104         );
107     // Destructor
109         ~ETAB();
112     // Member Functions
114         void breakupParcel
115         (
116             parcel& parcel,
117             const scalar deltaT,
118             const vector& Ug,
119             const liquidMixture& fuels
120         ) const;
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 } // End namespace Foam
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 #endif
133 // ************************************************************************* //