initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / lagrangian / dieselSpray / spraySubModels / evaporationModel / standardEvaporationModel / standardEvaporationModel.H
blob24405d9c35c05325c63fb73f22304dd430185bbb
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::standardEvaporationModel
28 Description
29     standard evaporation model based on the logarithmic expression
30     of the ration of pressure differences.
32 \*---------------------------------------------------------------------------*/
34 #ifndef standardEvaporationModel_H
35 #define standardEvaporationModel_H
37 #include "evaporationModel.H"
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 namespace Foam
44 /*---------------------------------------------------------------------------*\
45                            Class standardEvaporationModel Declaration
46 \*---------------------------------------------------------------------------*/
48 class standardEvaporationModel
50     public evaporationModel
53 private:
55     // Private data
57         dictionary evapDict_;
58         scalar preReScFactor_;
59         scalar ReExponent_;
60         scalar ScExponent_;
61     
62         word evaporationScheme_;
63         label nEvapIter_;
66 public:
68     //- Runtime type information
69         TypeName("standardEvaporationModel");
72     // Constructors
74         //- Construct from dictionary
75         standardEvaporationModel
76         (
77             const dictionary& dict
78         );
81     // Destructor
83         ~standardEvaporationModel();
86     // Member Functions
88         bool evaporation() const;
90        //- Correlation for the Sherwood Number
91         scalar Sh
92         (
93             const scalar ReynoldsNumber,
94             const scalar SchmidtNumber
95         ) const;
97         //- Return the evaporation relaxation time
98         scalar relaxationTime
99         (
100             const scalar diameter,
101             const scalar liquidDensity,
102             const scalar rhoFuelVapor,
103             const scalar massDiffusionCoefficient,
104             const scalar ReynoldsNumber,
105             const scalar SchmidtNumber,
106             const scalar Xs,
107             const scalar Xf,
108             const scalar m0,
109             const scalar dm,
110             const scalar dt
111         ) const;
113         scalar boilingTime
114         (
115             const scalar liquidDensity,
116             const scalar cpFuel,
117             const scalar heatOfVapour,
118             const scalar kappa,
119             const scalar Nusselt,
120             const scalar deltaTemp,
121             const scalar diameter,
122             const scalar, 
123             const scalar, 
124             const scalar, 
125             const scalar, 
126             const scalar, 
127             const scalar, 
128             const scalar, 
129             const scalar, 
130             const scalar 
131         ) const;
133         inline label nEvapIter() const;
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 } // End namespace Foam
141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 #endif
145 // ************************************************************************* //