filmBoilingModel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2018 OpenCFD Ltd
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::filmBoilingModels::filmBoilingModel
28 
29 Description
30  Base class for nucleation site density models
31 
32 SourceFiles
33  filmBoilingModel.C
34  newfilmBoilingModel.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef filmBoilingModel_H
39 #define filmBoilingModel_H
40 
41 #include "volFields.H"
42 #include "dictionary.H"
43 #include "runTimeSelectionTables.H"
44 
45 #include "phaseModel.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 namespace wallBoilingModels
52 {
53 
54 /*---------------------------------------------------------------------------*\
55  Class filmBoilingModel Declaration
56 \*---------------------------------------------------------------------------*/
57 
58 class filmBoilingModel
59 {
60  // Private Member Functions
61 
62  //- Disallow default bitwise copy construct
64 
65  //- Disallow default bitwise assignment
66  void operator=(const filmBoilingModel&);
67 
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("filmBoilingModel");
73 
74 
75  //- Declare runtime construction
77  (
78  autoPtr,
80  dictionary,
81  (
82  const dictionary& dict
83  ),
84  (dict)
85  );
86 
87 
88  // Constructors
89 
90  //- Construct null
92 
93 
94  // Selectors
95 
96  //- Select null constructed
98 
99 
100  //- Destructor
101  virtual ~filmBoilingModel();
102 
103 
104  // Member Functions
105 
106  //- Calculate temperature
108  (
109  const phaseModel& liquid,
110  const phaseModel& vapor,
111  const label patchi,
112  const scalarField& Tl,
113  const scalarField& Tsatw,
114  const scalarField& L
115  ) const = 0;
116 
117  virtual void write(Ostream& os) const;
118 };
119 
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 } // End namespace wallBoilingModels
123 } // End namespace Foam
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 #endif
128 
129 // ************************************************************************* //
volFields.H
Foam::phaseModel
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:57
L
const vector L(dict.get< vector >("L"))
Foam::wallBoilingModels::filmBoilingModel::filmBoilingModel
filmBoilingModel()
Construct null.
Definition: filmBoilingModel.C:44
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:59
Foam::wallBoilingModels::filmBoilingModel
Definition: filmBoilingModel.H:57
wallBoilingModels
Critical heat flux (CHF) correlation.
Foam::wallBoilingModels::filmBoilingModel::TypeName
TypeName("filmBoilingModel")
Runtime type information.
Foam::label
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:62
Foam::Field< scalar >
Foam::wallBoilingModels::filmBoilingModel::htcFilmBoil
virtual tmp< scalarField > htcFilmBoil(const phaseModel &liquid, const phaseModel &vapor, const label patchi, const scalarField &Tl, const scalarField &Tsatw, const scalarField &L) const =0
Calculate temperature.
Foam::wallBoilingModels::filmBoilingModel::New
static autoPtr< filmBoilingModel > New(const dictionary &dict)
Select null constructed.
Definition: newfilmBoilingModel.C:34
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::wallBoilingModels::filmBoilingModel::~filmBoilingModel
virtual ~filmBoilingModel()
Destructor.
Definition: filmBoilingModel.C:50
Foam::wallBoilingModels::filmBoilingModel::declareRunTimeSelectionTable
declareRunTimeSelectionTable(autoPtr, filmBoilingModel, dictionary,(const dictionary &dict),(dict))
Declare runtime construction.
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::wallBoilingModels::filmBoilingModel::write
virtual void write(Ostream &os) const
Definition: filmBoilingModel.C:56
runTimeSelectionTables.H
Macros to ease declaration of run-time selection tables.
dictionary.H
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56