ENH: autoLayerDriver: better layering information message
[OpenFOAM-2.0.x.git] / src / lagrangian / dieselSpray / spraySubModels / breakupModel / TAB / TAB.H
blob807cdf4d1e9e92ecc9928d8417ad248c4264cfd4
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
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
13     the Free Software Foundation, either version 3 of the License, or
14     (at your 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, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::TAB
27 Description
28     The TAB Method for Numerical Calculation of Spray Droplet Breakup.
30     \verbatim
31         O'Rourke, P.J. and Amsden, A.A.,
32         "The TAB Method for Numerical Calculation of Spray Droplet Breakup,"
33         1987 SAE International Fuels and Lubricants Meeting and Exposition,
34         Toronto, Ontario, November 2-5, 1987,
35         Los Alamos National Laboratory document LA-UR-87-2105;
36         SAE Technical Paper Series, Paper 872089.
37     \endverbatim
39     This implementation follows the kiva version.
41 See Also
42     The Enhanced %TAB model - ETAB
44 SourceFiles
45     TABI.H
46     TAB.C
47     TABIO.C
49 \*---------------------------------------------------------------------------*/
51 #ifndef TAB_H
52 #define TAB_H
54 #include "breakupModel.H"
56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
58 namespace Foam
61 /*---------------------------------------------------------------------------*\
62                            Class TAB Declaration
63 \*---------------------------------------------------------------------------*/
65 class TAB
67     public breakupModel
69 private:
71     // Private data
73         dictionary coeffsDict_;
75         // inverse function approximation
76         // of the Rossin-Rammler Distribution
77         // used when calculating the droplet size after breakup
78         scalar rrd_[100];
80         // model constants
82         scalar Cmu_;
83         scalar Comega_;
84         scalar WeCrit_;
87 public:
90     //- Runtime type information
91     TypeName("TAB");
94     // Constructors
96         //- Construct from components
97         TAB(const dictionary& dict, spray& sm);
100     //- Destructor
101     virtual ~TAB();
104     // Member Functions
106         void breakupParcel
107         (
108             parcel& parcel,
109             const scalar deltaT,
110             const vector& Ug,
111             const liquidMixtureProperties& fuels
112         ) const;
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 } // End namespace Foam
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 #endif
124 // ************************************************************************* //