heatTransferModel.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) 2011-2018 OpenFOAM Foundation
9 Copyright (C) 2020 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27Class
28 Foam::heatTransferModel
29
30Description
31
32SourceFiles
33 heatTransferModel.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef heatTransferModel_H
38#define heatTransferModel_H
39
40// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41
42#include "volFields.H"
43#include "dictionary.H"
45
46namespace Foam
47{
48
49// Forward Declarations
50class phasePair;
51
52/*---------------------------------------------------------------------------*\
53 Class heatTransferModel Declaration
54\*---------------------------------------------------------------------------*/
57{
58protected:
59
60 // Protected Data
61
62 //- Phase pair
63 const phasePair& pair_;
64
65 //- Residual phase fraction
67
68
69public:
70
71 //- Runtime type information
72 TypeName("heatTransferModel");
73
74
75 // Declare runtime construction
78 (
79 autoPtr,
82 (
83 const dictionary& dict,
84 const phasePair& pair
85 ),
86 (dict, pair)
87 );
88
89
90 // Static Data Members
91
92 //- Coefficient dimensions
93 static const dimensionSet dimK;
94
95
96 // Constructors
97
98 //- Construct froma dictionary and a phase pair
100 (
101 const dictionary& dict,
102 const phasePair& pair
103 );
104
105
106 //- Destructor
107 virtual ~heatTransferModel() = default;
108
109
110 // Selectors
111
113 (
114 const dictionary& dict,
115 const phasePair& pair
116 );
117
118
119 // Member Functions
120
121 //- The heat transfer function K used in the enthalpy equation
122 // ddt(alpha1*rho1*ha) + ... = ... K*(Ta - Tb)
123 // ddt(alpha2*rho2*hb) + ... = ... K*(Tb - Ta)
124 tmp<volScalarField> K() const;
125
126 //- The heat transfer function K used in the enthalpy equation
127 // ddt(alpha1*rho1*ha) + ... = ... K*(Ta - Tb)
128 // ddt(alpha2*rho2*hb) + ... = ... K*(Tb - Ta)
129 // with a specified residual volume fraction
130 virtual tmp<volScalarField> K(const scalar residualAlpha) const = 0;
131};
132
133
134// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135
136} // End namespace Foam
137
138// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139
140#endif
141
142// ************************************************************************* //
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Dimension set for the base types, which can be used to implement rigorous dimension checking for alge...
Definition: dimensionSet.H:109
declareRunTimeSelectionTable(autoPtr, heatTransferModel, dictionary,(const dictionary &dict, const phasePair &pair),(dict, pair))
static const dimensionSet dimK
Coefficient dimensions.
const phasePair & pair_
Phase pair.
const dimensionedScalar residualAlpha_
Residual phase fraction.
tmp< volScalarField > K() const
The heat transfer function K used in the enthalpy equation.
static autoPtr< heatTransferModel > New(const dictionary &dict, const phasePair &pair)
virtual ~heatTransferModel()=default
Destructor.
TypeName("heatTransferModel")
Runtime type information.
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition: phasePair.H:56
A class for managing temporary objects.
Definition: tmp.H:65
Namespace for OpenFOAM.
Macros to ease declaration of run-time selection tables.
#define declareRunTimeSelectionTable(ptrWrapper, baseType, argNames, argList, parList)
Declare a run-time selection (variables and adder classes)
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73