ENH: autoLayerDriver: better layering information message
[OpenFOAM-2.0.x.git] / src / regionModels / surfaceFilmModels / submodels / thermo / phaseChangeModel / standardPhaseChange / standardPhaseChange.H
blob1fff3384ff87c90ad93f9b0f9ac08db0b26f753f
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::standardPhaseChange
27 Description
28     Standard phase change model with modification for boiling
30 SourceFiles
31     standardPhaseChange.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef standardPhaseChange_H
36 #define standardPhaseChange_H
38 #include "phaseChangeModel.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
44 namespace regionModels
46 namespace surfaceFilmModels
49 /*---------------------------------------------------------------------------*\
50                     Class standardPhaseChange Declaration
51 \*---------------------------------------------------------------------------*/
53 class standardPhaseChange
55     public phaseChangeModel
57 private:
59     // Private member functions
61         //- Disallow default bitwise copy construct
62         standardPhaseChange(const standardPhaseChange&);
64         //- Disallow default bitwise assignment
65         void operator=(const standardPhaseChange&);
68 protected:
70     // Protected data
72         //- Boiling temperature / [K]
73         const scalar Tb_;
75         //- Minimum film height for model to be active
76         const scalar deltaMin_;
78         //- Length scale / [m]
79         const scalar L_;
81         //- Boiling temperature factor / []
82         //  Used to set max limit on temperature to Tb*TbFactor
83         const scalar TbFactor_;
86     // Protected member functions
88         //- Return Sherwood number as a function of Reynolds and Schmidt numbers
89         scalar Sh(const scalar Re, const scalar Sc) const;
92 public:
94     //- Runtime type information
95     TypeName("standardPhaseChange");
98     // Constructors
100         //- Construct from surface film model
101         standardPhaseChange
102         (
103             const surfaceFilmModel& owner,
104             const dictionary& dict
105         );
108     //- Destructor
109     virtual ~standardPhaseChange();
112     // Member Functions
114         // Evolution
116             //- Correct
117             virtual void correctModel
118             (
119                 const scalar dt,
120                 scalarField& availableMass,
121                 scalarField& dMass,
122                 scalarField& dEnergy
123             );
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 } // End namespace surfaceFilmModels
130 } // End namespace regionModels
131 } // End namespace Foam
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 #endif
137 // ************************************************************************* //