heatTransferModel.C
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) 2019-2021 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 \*---------------------------------------------------------------------------*/
28 
29 #include "heatTransferModel.H"
30 #include "phasePair.H"
31 #include "BlendedInterfacialModel.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37  defineTypeNameAndDebug(heatTransferModel, 0);
39  defineRunTimeSelectionTable(heatTransferModel, dictionary);
40 }
41 
43 
44 
45 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
46 
48 (
49  const dictionary& dict,
50  const phasePair& pair
51 )
52 :
53  pair_(pair),
54  residualAlpha_
55  (
56  "residualAlpha",
57  dimless,
58  dict.getOrDefault<scalar>
59  (
60  "residualAlpha",
61  pair_.ordered()
62  ? pair_.dispersed().residualAlpha().value()
63  : pair_.phase1().residualAlpha().value()
64  )
65  )
66 {}
67 
68 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
69 
72 (
73  const dictionary& dict,
74  const phasePair& pair
75 )
76 {
77  const word modelType(dict.get<word>("type"));
78 
79  Info<< "Selecting heatTransferModel for "
80  << pair << ": " << modelType << endl;
81 
82  auto* ctorPtr = dictionaryConstructorTable(modelType);
83 
84  if (!ctorPtr)
85  {
87  (
88  dict,
89  "heatTransferModel",
90  modelType,
91  *dictionaryConstructorTablePtr_
92  ) << abort(FatalIOError);
93  }
94 
95  return ctorPtr(dict, pair);
96 }
97 
98 
99 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
100 
103 {
104  return K(residualAlpha_.value());
105 }
106 
107 
108 // ************************************************************************* //
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::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::defineRunTimeSelectionTable
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
heatTransferModel.H
Foam::FatalIOError
IOerror FatalIOError
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::dimensioned::value
const Type & value() const
Return const reference to value.
Definition: dimensionedType.C:434
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::defineBlendedInterfacialModelTypeNameAndDebug
defineBlendedInterfacialModelTypeNameAndDebug(massTransferModel, 0)
FatalIOErrorInLookup
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:478
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
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
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:144
Foam::autoPtr< Foam::heatTransferModel >
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::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
Foam::heatTransferModel::New
static autoPtr< heatTransferModel > New(const dictionary &dict, const volScalarField &alpha1, const phaseModel &phase1, const phaseModel &phase2)
Definition: heatTransferModel.C:60
Foam::dimless
const dimensionSet dimless
Dimensionless.
Definition: dimensionSets.C:189