speciePhaseChange.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) 2021 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::speciePhaseChange
26 
27 Description
28  Specie phase change model abstract base class
29 
30 SourceFiles
31  speciePhaseChange.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef speciePhaseChange_H
36 #define speciePhaseChange_H
37 
38 #include "phaseChangeModel.H"
39 #include "thermoSingleLayer.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace regionModels
46 {
47 namespace surfaceFilmModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class speciePhaseChange Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
56  public phaseChangeModel
57 {
58 
59 public:
60 
61  //- Runtime type information
62  TypeName("speciePhaseChange");
63 
64 
65  // Constructors
66 
67  //- Construct from surface film model
69  (
70  const word& modelType,
72  const dictionary& dict
73  );
74 
75  //- Disallow default bitwise copy construction
76  speciePhaseChange(const speciePhaseChange&) = delete;
77 
78 
79  //- Destructor
80  virtual ~speciePhaseChange();
81 
82 
83  // Member Functions
84 
85  label vapId() const;
86 
87  scalar Wvap() const;
88 
89 
90  // Member Operators
91 
92  //- Disallow default bitwise assignment
93  void operator=(const speciePhaseChange&) = delete;
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace surfaceFilmModels
100 } // End namespace regionModels
101 } // End namespace Foam
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 #endif
106 
107 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
TypeName("speciePhaseChange")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
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.
Base class for surface film phase change models.
A class for handling words, derived from string.
Definition: word.H:59
const word & modelType() const
Return const access to the sub-model type.
Definition: subModelBase.C:122
void operator=(const speciePhaseChange &)=delete
Disallow default bitwise assignment.
Specie phase change model abstract base class.
speciePhaseChange(const word &modelType, surfaceFilmRegionModel &film, const dictionary &dict)
Construct from surface film model.
Namespace for OpenFOAM.