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