wallBoiling.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) 2018-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::diameterModels::nucleationModels::wallBoiling
26 
27 Description
28  Wall-boiling model which requires a velocityGroup (i.e. phase) to be
29  specified in which the nucleation occurs. This setting must be consistent
30  with the specifications in the alphatWallBoilingWallFunction. If the
31  departure-diameter lies outside the diameter-range given by the sizeGroups
32  of the corresponding velocityGroup, the solver will give a warning and the
33  nucleation rate will be set to zero.
34 
35 SourceFiles
36  wallBoiling.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef wallBoiling_H
41 #define wallBoiling_H
42 
43 #include "nucleationModel.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 namespace diameterModels
50 {
51 namespace nucleationModels
52 {
53 
54 /*---------------------------------------------------------------------------*\
55  Class wallBoiling Declaration
56 \*---------------------------------------------------------------------------*/
57 
58 class wallBoiling
59 :
60  public nucleationModel
61 {
62  // Private Data
63 
64  //- Velocity group in which the nucleation occurs
65  const velocityGroup& velGroup_;
66 
67 
68 public:
69 
70  //- Runtime type information
71  TypeName("wallBoiling");
72 
73  // Constructor
74 
76  (
78  const dictionary& dict
79  );
80 
81 
82  //- Destructor
83  virtual ~wallBoiling()
84  {}
85 
86 
87  // Member Functions
88 
89  //- Correct diameter independent expressions
90  virtual void correct();
91 
92  //- Add to nucleationRate
93  virtual void addToNucleationRate
94  (
95  volScalarField& nucleationRate,
96  const label i
97  );
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace nucleationModels
104 } // End namespace diameterModels
105 } // End namespace Foam
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
virtual void correct()
Correct diameter independent expressions.
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("wallBoiling")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
Class that solves the univariate population balance equation by means of a class method (also called ...
This diameterModel is intended for use with a populationBalanceModel in order to simulate polydispers...
const dictionary & dict() const
Return reference to model dictionary.
Base class for nucleation models.
virtual void addToNucleationRate(volScalarField &nucleationRate, const label i)
Add to nucleationRate.
Wall-boiling model which requires a velocityGroup (i.e. phase) to be specified in which the nucleatio...
Definition: wallBoiling.H:57
wallBoiling(const populationBalanceModel &popBal, const dictionary &dict)
const populationBalanceModel & popBal() const
Return reference to the populationBalanceModel.
Namespace for OpenFOAM.