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 -------------------------------------------------------------------------------
11 License
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 
27 Class
28  Foam::heatTransferModel
29 
30 Description
31 
32 SourceFiles
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"
44 #include "runTimeSelectionTables.H"
45 
46 namespace Foam
47 {
48 
49 // Forward Declarations
50 class phasePair;
51 
52 /*---------------------------------------------------------------------------*\
53  Class heatTransferModel Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 class heatTransferModel
57 {
58 protected:
59 
60  // Protected Data
61 
62  //- Phase pair
63  const phasePair& pair_;
64 
65  //- Residual phase fraction
67 
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("heatTransferModel");
73 
74 
75  // Declare runtime construction
76 
78  (
79  autoPtr,
81  dictionary,
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 // ************************************************************************* //
volFields.H
Foam::phasePair
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition: phasePair.H:53
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::heatTransferModel::declareRunTimeSelectionTable
declareRunTimeSelectionTable(autoPtr, heatTransferModel, dictionary,(const dictionary &dict, const volScalarField &alpha1, const phaseModel &phase1, const phaseModel &phase2),(dict, alpha1, phase1, phase2))
Foam::heatTransferModel::pair_
const phasePair & pair_
Phase pair.
Definition: heatTransferModel.H:62
Foam::dimensionSet
Dimension set for the base types, which can be used to implement rigorous dimension checking for alge...
Definition: dimensionSet.H:108
Foam::heatTransferModel::dimK
static const dimensionSet dimK
Coefficient dimensions.
Definition: heatTransferModel.H:92
Foam::heatTransferModel::heatTransferModel
heatTransferModel(const dictionary &dict, const volScalarField &alpha1, const phaseModel &phase1, const phaseModel &phase2)
Definition: heatTransferModel.C:43
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:123
Foam::dimensioned< scalar >
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::heatTransferModel::TypeName
TypeName("heatTransferModel")
Runtime type information.
runTimeSelectionTables.H
Macros to ease declaration of run-time selection tables.
dictionary.H
Foam::heatTransferModel
Definition: heatTransferModel.H:53
Foam::heatTransferModel::~heatTransferModel
virtual ~heatTransferModel()=default
Destructor.
Foam::heatTransferModel::residualAlpha_
const dimensionedScalar residualAlpha_
Residual phase fraction.
Definition: heatTransferModel.H:65
Foam::heatTransferModel::K
tmp< volScalarField > K() const
The heat transfer function K used in the enthalpy equation.
Definition: heatTransferModel.C:102
Foam::heatTransferModel::New
static autoPtr< heatTransferModel > New(const dictionary &dict, const volScalarField &alpha1, const phaseModel &phase1, const phaseModel &phase2)
Definition: heatTransferModel.C:60