nucleationSiteModel.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) 2016-2023 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::wallBoilingModels::nucleationSiteModel
26 
27 Description
28  Base class for nucleation site density models
29 
30 SourceFiles
31  nucleationSiteModel.C
32  nucleationSiteModelNew.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef nucleationSiteModel_H
37 #define nucleationSiteModel_H
38 
39 #include "volFields.H"
40 #include "dictionary.H"
41 #include "runTimeSelectionTables.H"
42 
43 #include "phaseModel.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 namespace wallBoilingModels
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class nucleationSiteModel Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 {
58 public:
59 
60  //- Runtime type information
61  TypeName("nucleationSiteModel");
62 
63 
64  //- Declare runtime construction
66  (
67  autoPtr,
69  dictionary,
70  (const dictionary& dict),
71  (dict)
72  );
73 
74 
75  // Constructors
76 
77  //- Construct null
79 
80  //- Copy construct
82 
83  //- Construct and return a clone
84  virtual autoPtr<nucleationSiteModel> clone() const = 0;
85 
86 
87  // Selectors
88 
89  //- Select null constructed
91 
92 
93  //- Destructor
94  virtual ~nucleationSiteModel();
95 
96 
97  // Member Functions
98 
99  //- Calculate and return the nucleation-site density
101  (
102  const phaseModel& liquid,
103  const phaseModel& vapour,
104  const label patchi,
105  const scalarField& Tl,
106  const scalarField& Tsatw,
107  const scalarField& L,
108  const scalarField& dDep,
109  const scalarField& fDep
110  ) const = 0;
111 
112  //- Calculate and return the nucleation-site density
114  (
115  const phaseModel& liquid,
116  const phaseModel& vapor,
117  const phaseModel& solid,
118  const volScalarField& Tf,
119  const volScalarField& Tsatw,
120  const volScalarField& L,
121  const volScalarField& dDep,
122  const volScalarField& fDep
123  ) const = 0;
124 
125  //- Write to stream
126  virtual void write(Ostream& os) const;
127 
128 
129  // Member Operators
130 
131  //- Disallow default bitwise assignment
132  void operator=(const nucleationSiteModel&) = delete;
133 };
134 
135 
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 
138 } // End namespace wallBoilingModels
139 } // End namespace Foam
140 
141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142 
143 #endif
144 
145 // ************************************************************************* //
Generic GeometricField class.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:57
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Generic thermophysical properties class for a liquid in which the functions and coefficients for each...
Definition: liquid.H:53
A class for managing temporary objects.
Definition: tmp.H:55
Base class for nucleation site density models.
TypeName("nucleationSiteModel")
Runtime type information.
declareRunTimeSelectionTable(autoPtr, nucleationSiteModel, dictionary,(const dictionary &dict),(dict))
Declare runtime construction.
static autoPtr< nucleationSiteModel > New(const dictionary &dict)
Select null constructed.
virtual void write(Ostream &os) const
Write to stream.
virtual autoPtr< nucleationSiteModel > clone() const =0
Construct and return a clone.
virtual tmp< scalarField > nucleationSiteDensity(const phaseModel &liquid, const phaseModel &vapour, const label patchi, const scalarField &Tl, const scalarField &Tsatw, const scalarField &L, const scalarField &dDep, const scalarField &fDep) const =0
Calculate and return the nucleation-site density.
void operator=(const nucleationSiteModel &)=delete
Disallow default bitwise assignment.
label patchi
Namespace for OpenFOAM.
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
Macros to ease declaration of run-time selection tables.
dictionary dict