wallBoilingProperties.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) 2022-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::functionObjects::wallBoilingProperties
26 
27 Description
28  This function looks up wall boiling wall functions and collects and writes
29  out out the following data:
30 
31  - Bubble departure diameter
32  - Bubble departure frequency
33  - Nucleation site density
34  - Effective liquid fraction at the wall
35  - Quenching heat flux
36  - Evaporative heat flux
37 
38  Example of function object specification:
39  \verbatim
40  writeWallBoilingProperties
41  {
42  type wallBoilingProperties;
43  libs ( "libmultiphaseEulerFunctionObjects.so" );
44  writeControl writeTime;
45  phase liquid;
46  }
47  \endverbatim
48 
49 Usage
50  \table
51  Property | Description | Required | Default value
52  type | type name: wallBoilingProperties | yes |
53  phase | phase name | yes | none
54  \endtable
55 
56 SourceFiles
57  wallBoilingProperties.C
58 
59 \*---------------------------------------------------------------------------*/
60 
61 #ifndef wallBoilingProperties_H
62 #define wallBoilingProperties_H
63 
64 #include "fvMeshFunctionObject.H"
65 #include "phaseSystem.H"
66 
67 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
68 
69 namespace Foam
70 {
71 namespace functionObjects
72 {
73 
74 /*---------------------------------------------------------------------------*\
75  Class wallBoilingProperties Declaration
76 \*---------------------------------------------------------------------------*/
77 
78 class wallBoilingProperties
79 :
80  public fvMeshFunctionObject
81 {
82  // Private data
83 
84  //- Phase model
85  const phaseModel& phase_;
86 
87  //- Constant access to phaseSystem
88  const phaseSystem& fluid_;
89 
90 
91 public:
92 
93  //- Runtime type information
94  TypeName("wallBoilingProperties");
95 
96 
97  // Constructors
98 
99  //- Construct from Time and dictionary
101  (
102  const word& name,
103  const Time& runTime,
104  const dictionary& dict
105  );
106 
107  //- Disallow default bitwise copy construction
109 
110 
111  //- Destructor
112  virtual ~wallBoilingProperties();
113 
114 
115  // Member Functions
116 
117  //- Read the wallBoilingProperties data
118  virtual bool read(const dictionary&);
119 
120  //- Return the list of fields required
121  virtual wordList fields() const
122  {
123  return wordList::null();
124  }
125 
126  //- Calculate the wallBoilingProperties field
127  virtual bool execute();
128 
129  //- Write the wallBoilingProperties field
130  virtual bool write();
131 
132 
133  // Member Operators
134 
135  //- Disallow default bitwise assignment
136  void operator=(const wallBoilingProperties&) = delete;
137 };
138 
139 
140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
141 
142 } // End namespace functionObjects
143 } // End namespace Foam
144 
145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
146 
147 #endif
148 
149 // ************************************************************************* //
static const List< word > & null()
Return a null List.
Definition: ListI.H:118
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:76
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
const word & name() const
Return the name of this functionObject.
This function looks up wall boiling wall functions and collects and writes out out the following data...
virtual wordList fields() const
Return the list of fields required.
void operator=(const wallBoilingProperties &)=delete
Disallow default bitwise assignment.
TypeName("wallBoilingProperties")
Runtime type information.
wallBoilingProperties(const word &name, const Time &runTime, const dictionary &dict)
Construct from Time and dictionary.
virtual bool execute()
Calculate the wallBoilingProperties field.
virtual bool write()
Write the wallBoilingProperties field.
virtual bool read(const dictionary &)
Read the wallBoilingProperties data.
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
dictionary dict