All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
filmThermoModel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2013-2019 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
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.
15 
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.
20 
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/>.
23 
24 Class
25  Foam::regionModels::surfaceFilmModels::filmThermoModel
26 
27 Description
28  Base class for film thermo models
29 
30 SourceFiles
31  filmThermoModel.C
32  filmThermoModelNew.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef filmThermoModel_H
37 #define filmThermoModel_H
38 
39 #include "filmSubModelBase.H"
40 #include "runTimeSelectionTables.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace regionModels
47 {
48 namespace surfaceFilmModels
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class filmThermoModel Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class filmThermoModel
56 :
57  public filmSubModelBase
58 {
59 public:
60 
61  //- Runtime type information
62  TypeName("filmThermoModel");
63 
64 
65  // Declare runtime constructor selection table
66 
68  (
69  autoPtr,
71  dictionary,
72  (
74  const dictionary& dict
75  ),
76  (film, dict)
77  );
78 
79  // Constructors
80 
81  //- Construct null
83 
84  //- Construct from type name, dictionary and surface film model
86  (
87  const word& modelType,
89  const dictionary& dict
90  );
91 
92  //- Disallow default bitwise copy construction
93  filmThermoModel(const filmThermoModel&) = delete;
94 
95 
96  // Selectors
97 
98  //- Return a reference to the selected phase change model
100  (
102  const dictionary& dict
103  );
104 
105 
106  //- Destructor
107  virtual ~filmThermoModel();
108 
109 
110  // Member Functions
111 
112  //- Return the specie name
113  virtual const word& name() const = 0;
114 
115 
116  // Elemental access
117 
118  //- Return density [kg/m^3]
119  virtual scalar rho(const scalar p, const scalar T) const = 0;
120 
121  //- Return dynamic viscosity [Pa.s]
122  virtual scalar mu(const scalar p, const scalar T) const = 0;
123 
124  //- Return surface tension [kg/s^2]
125  virtual scalar sigma(const scalar p, const scalar T) const = 0;
126 
127  //- Return specific heat capacity [J/kg/K]
128  virtual scalar Cp(const scalar p, const scalar T) const = 0;
129 
130  //- Return thermal conductivity [W/m/K]
131  virtual scalar kappa(const scalar p, const scalar T) const = 0;
132 
133  //- Return diffusivity [m^2/s]
134  virtual scalar D(const scalar p, const scalar T) const = 0;
135 
136  //- Return latent heat [J/kg]
137  virtual scalar hl(const scalar p, const scalar T) const = 0;
138 
139  //- Return vapour pressure [Pa]
140  virtual scalar pv(const scalar p, const scalar T) const = 0;
141 
142  //- Return molecular weight [kg/kmol]
143  virtual scalar W() const = 0;
144 
145  //- Return boiling temperature [K]
146  virtual scalar Tb(const scalar p) const = 0;
147 
148 
149  // Field access
150 
151  //- Return density [kg/m^3]
152  virtual tmp<volScalarField> rho() const = 0;
153 
154  //- Return dynamic viscosity [Pa.s]
155  virtual tmp<volScalarField> mu() const = 0;
156 
157  //- Return surface tension [kg/s^2]
158  virtual tmp<volScalarField> sigma() const = 0;
159 
160  //- Return specific heat capacity [J/kg/K]
161  virtual tmp<volScalarField> Cp() const = 0;
162 
163  //- Return thermal conductivity [W/m/K]
164  virtual tmp<volScalarField> kappa() const = 0;
165 
166 
167  // Member Operators
168 
169  //- Disallow default bitwise assignment
170  void operator=(const filmThermoModel&) = delete;
171 };
172 
173 
174 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
175 
176 } // End namespace surfaceFilmModels
177 } // End namespace regionModels
178 } // End namespace Foam
179 
180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
181 
182 #endif
183 
184 // ************************************************************************* //
virtual tmp< volScalarField > mu() const =0
Return dynamic viscosity [Pa.s].
virtual const word & name() const =0
Return the specie name.
virtual tmp< volScalarField > kappa() const =0
Return thermal conductivity [W/m/K].
Base class for surface film sub-models.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual scalar hl(const scalar p, const scalar T) const =0
Return latent heat [J/kg].
declareRunTimeSelectionTable(autoPtr, filmThermoModel, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict),(film, dict))
static autoPtr< filmThermoModel > New(surfaceFilmRegionModel &film, const dictionary &dict)
Return a reference to the selected phase change model.
TypeName("filmThermoModel")
Runtime type information.
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
const surfaceFilmRegionModel & film() const
Return const access to the film surface film model.
virtual tmp< volScalarField > rho() const =0
Return density [kg/m^3].
A class for handling words, derived from string.
Definition: word.H:59
virtual tmp< volScalarField > Cp() const =0
Return specific heat capacity [J/kg/K].
filmThermoModel(surfaceFilmRegionModel &film)
Construct null.
virtual scalar D(const scalar p, const scalar T) const =0
Return diffusivity [m^2/s].
virtual scalar Tb(const scalar p) const =0
Return boiling temperature [K].
const word & modelType() const
Return const access to the sub-model type.
Definition: subModelBase.C:122
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
virtual scalar W() const =0
Return molecular weight [kg/kmol].
virtual tmp< volScalarField > sigma() const =0
Return surface tension [kg/s^2].
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Macros to ease declaration of run-time selection tables.
volScalarField & p
A class for managing temporary objects.
Definition: PtrList.H:53
virtual scalar pv(const scalar p, const scalar T) const =0
Return vapour pressure [Pa].
void operator=(const filmThermoModel &)=delete
Disallow default bitwise assignment.
Namespace for OpenFOAM.