partitioningModel.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::partitioningModel
26 
27 Description
28  Base class for wall heat flux partitioning models
29 
30 SourceFiles
31  partitioningModel.C
32  partitioningModelNew.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef partitioningModel_H
37 #define partitioningModel_H
38 
39 #include "volFields.H"
40 #include "dictionary.H"
41 #include "runTimeSelectionTables.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 namespace wallBoilingModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class partitioningModel Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 {
56 public:
57 
58  //- Runtime type information
59  TypeName("partitioningModel");
60 
61 
62  //- Declare runtime construction
64  (
65  autoPtr,
67  dictionary,
68  (const dictionary& dict),
69  (dict)
70  );
71 
72 
73  // Constructors
74 
75  //- Construct null
77 
78  //- Copy construct
80 
81  //- Construct and return a clone
82  virtual autoPtr<partitioningModel> clone() const = 0;
83 
84 
85  // Selectors
86 
87  //- Select null constructed
89 
90 
91  //- Destructor
92  virtual ~partitioningModel();
93 
94 
95  // Member Functions
96 
97  //- Return the wet fraction
99  (
100  const scalarField& alphaLiquid
101  ) const = 0;
102 
103  //- Return the wet fraction
105  (
106  const volScalarField& alphaLiquid
107  ) const = 0;
108 
109  //- Write to stream
110  virtual void write(Ostream& os) const;
111 
112 
113  // Member Operators
114 
115  //- Disallow default bitwise assignment
116  void operator=(const partitioningModel&) = delete;
117 };
118 
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 } // End namespace wallBoilingModels
123 } // End namespace Foam
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 #endif
128 
129 // ************************************************************************* //
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
A class for managing temporary objects.
Definition: tmp.H:55
Base class for wall heat flux partitioning models.
void operator=(const partitioningModel &)=delete
Disallow default bitwise assignment.
TypeName("partitioningModel")
Runtime type information.
virtual void write(Ostream &os) const
Write to stream.
static autoPtr< partitioningModel > New(const dictionary &dict)
Select null constructed.
declareRunTimeSelectionTable(autoPtr, partitioningModel, dictionary,(const dictionary &dict),(dict))
Declare runtime construction.
virtual autoPtr< partitioningModel > clone() const =0
Construct and return a clone.
virtual tmp< scalarField > wetFraction(const scalarField &alphaLiquid) const =0
Return the wet fraction.
Namespace for OpenFOAM.
Macros to ease declaration of run-time selection tables.
dictionary dict