departureFrequencyModel.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-2020 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::departureFrequencyModel
26 
27 Description
28  Base class for bubble departure frequency models
29 
30 SourceFiles
31  departureFrequencyModel.C
32  departureFrequencyModelNew.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef departureFrequencyModel_H
37 #define departureFrequencyModel_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 departureFrequencyModel Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 {
58 public:
59 
60  //- Runtime type information
61  TypeName("departureFrequencyModel");
62 
63 
64  //- Declare runtime construction
66  (
67  autoPtr,
69  dictionary,
70  (
71  const dictionary& dict
72  ),
73  (dict)
74  );
75 
76 
77  // Constructors
78 
79  //- Construct null
81 
82  //- Copy construct
84 
85  //- Construct and return a clone
86  virtual autoPtr<departureFrequencyModel> clone() const = 0;
87 
88 
89  // Selectors
90 
91  //- Select null constructed
93 
94 
95  //- Destructor
96  virtual ~departureFrequencyModel();
97 
98 
99  // Member Functions
100 
101  //- Calculate and return the bubble departure frequency
103  (
104  const phaseModel& liquid,
105  const phaseModel& vapor,
106  const label patchi,
107  const scalarField& Tl,
108  const scalarField& Tsatw,
109  const scalarField& L,
110  const scalarField& dDep
111  ) const = 0;
112 
113  virtual void write(Ostream& os) const;
114 
115 
116  // Member Operators
117 
118  //- Disallow default bitwise assignment
119  void operator=(const departureFrequencyModel&) = delete;
120 };
121 
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 } // End namespace wallBoilingModels
125 } // End namespace Foam
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 #endif
130 
131 // ************************************************************************* //
Generic thermophysical properties class for a liquid in which the functions and coefficients for each...
Definition: liquid.H:50
dictionary dict
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
declareRunTimeSelectionTable(autoPtr, departureFrequencyModel, dictionary,(const dictionary &dict),(dict))
Declare runtime construction.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
virtual void write(Ostream &os) const
virtual tmp< scalarField > fDeparture(const phaseModel &liquid, const phaseModel &vapor, const label patchi, const scalarField &Tl, const scalarField &Tsatw, const scalarField &L, const scalarField &dDep) const =0
Calculate and return the bubble departure frequency.
void operator=(const departureFrequencyModel &)=delete
Disallow default bitwise assignment.
Base class for bubble departure frequency models.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
virtual autoPtr< departureFrequencyModel > clone() const =0
Construct and return a clone.
label patchi
static autoPtr< departureFrequencyModel > New(const dictionary &dict)
Select null constructed.
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.
A class for managing temporary objects.
Definition: PtrList.H:53
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:53
TypeName("departureFrequencyModel")
Runtime type information.
Namespace for OpenFOAM.