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-2014 OpenFOAM Foundation
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::heatTransferModel
28 
29 Description
30 
31 SourceFiles
32  heatTransferModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef heatTransferModel_H
37 #define heatTransferModel_H
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 #include "volFields.H"
42 #include "dictionary.H"
43 #include "runTimeSelectionTables.H"
44 
45 namespace Foam
46 {
47 
48 class phasePair;
49 
50 /*---------------------------------------------------------------------------*\
51  Class heatTransferModel Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class heatTransferModel
55 {
56 protected:
57 
58  // Protected data
59 
60  //- Phase pair
61  const phasePair& pair_;
62 
63  //- Residual phase fraction
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("heatTransferModel");
71 
72 
73  // Declare runtime construction
74 
76  (
77  autoPtr,
79  dictionary,
80  (
81  const dictionary& dict,
82  const phasePair& pair
83  ),
84  (dict, pair)
85  );
86 
87 
88  // Static data members
89 
90  //- Coefficient dimensions
91  static const dimensionSet dimK;
92 
93 
94  // Constructors
95 
96  //- Construct froma dictionary and a phase pair
98  (
99  const dictionary& dict,
100  const phasePair& pair
101  );
102 
103 
104  //- Destructor
105  virtual ~heatTransferModel();
106 
107 
108  // Selectors
109 
110  static autoPtr<heatTransferModel> New
111  (
112  const dictionary& dict,
113  const phasePair& pair
114  );
115 
116 
117  // Member Functions
118 
119  //- The heat transfer function K used in the enthalpy equation
120  // ddt(alpha1*rho1*ha) + ... = ... K*(Ta - Tb)
121  // ddt(alpha2*rho2*hb) + ... = ... K*(Tb - Ta)
122  virtual tmp<volScalarField> K() const = 0;
123 };
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace Foam
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************************************************************* //
volFields.H
Foam::heatTransferModel::pair_
const phasePair & pair_
Phase pair.
Definition: heatTransferModel.H:60
Foam::heatTransferModel::dimK
static const dimensionSet dimK
Coefficient dimensions.
Definition: heatTransferModel.H:90
Foam::dimensionedScalar
dimensioned< scalar > dimensionedScalar
Dimensioned scalar obtained from generic dimensioned type.
Definition: dimensionedScalarFwd.H:43
Foam::heatTransferModel::New
static autoPtr< heatTransferModel > New(const dictionary &dict, const phasePair &pair)
Definition: newHeatTransferModel.C:35
Foam::heatTransferModel::heatTransferModel
heatTransferModel(const dictionary &dict, const phasePair &pair)
Construct froma dictionary and a phase pair.
Definition: heatTransferModel.C:48
dict
dictionary dict
Definition: searchingEngine.H:14
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::heatTransferModel::TypeName
TypeName("heatTransferModel")
Runtime type information.
Foam::heatTransferModel::declareRunTimeSelectionTable
declareRunTimeSelectionTable(autoPtr, heatTransferModel, dictionary,(const dictionary &dict, const phasePair &pair),(dict, pair))
Foam::heatTransferModel::~heatTransferModel
virtual ~heatTransferModel()
Destructor.
Definition: heatTransferModel.C:71
runTimeSelectionTables.H
Macros to ease declaration of run-time selection tables.
dictionary.H
Foam::heatTransferModel::residualAlpha_
const dimensionedScalar residualAlpha_
Residual phase fraction.
Definition: heatTransferModel.H:63
Foam::heatTransferModel::K
tmp< volScalarField > K() const
The heat transfer function K used in the enthalpy equation.
Definition: heatTransferModel.C:78