phaseTransferModel.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2018-2022 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 \*---------------------------------------------------------------------------*/
25 
26 #include "phaseTransferModel.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32  defineTypeNameAndDebug(phaseTransferModel, 0);
33  defineBlendedInterfacialModelTypeNameAndDebug(phaseTransferModel, 0);
34  defineRunTimeSelectionTable(phaseTransferModel, dictionary);
35 }
36 
37 const Foam::dimensionSet Foam::phaseTransferModel::dimDmdt =
39 
40 const Foam::hashedWordList Foam::phaseTransferModel::noSpecies_ =
42 
43 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
44 
46 (
47  const dictionary& dict,
48  const phaseInterface& interface
49 )
50 :
51  regIOobject
52  (
53  IOobject
54  (
55  IOobject::groupName(typeName, interface.name()),
56  interface.mesh().time().timeName(),
57  interface.mesh()
58  )
59  )
60 {}
61 
62 
63 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
64 
66 {}
67 
68 
69 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
70 
72 {
73  return false;
74 }
75 
76 
78 {
79  return tmp<volScalarField>(nullptr);
80 }
81 
82 
84 {
85  return noSpecies_;
86 }
87 
88 
91 {
92  return HashPtrTable<volScalarField>();
93 }
94 
95 
96 bool Foam::phaseTransferModel::writeData(Ostream& os) const
97 {
98  return os.good();
99 }
100 
101 
103 {
105 }
106 
107 
110 {
111  return
112  evaluate
113  (
115  "dmdtf",
117  true
118  );
119 }
120 
121 
123 {
125 }
126 
127 
130 {
131  return
132  evaluate
133  (
135  "dmidtf",
137  true
138  );
139 }
140 
141 
142 // ************************************************************************* //
dictionary dict
virtual const hashedWordList & species() const
The list of individual species that are transferred.
static const dimensionSet dimDmdt
Mass transfer rate dimensions.
void evaluate(GeometricField< Type, PatchField, GeoMesh > &result, const Function1< Type > &func, const GeometricField< Type, PatchField, GeoMesh > &x)
static const hashedWordList noSpecies_
Empty species list.
virtual ~phaseTransferModel()
Destructor.
A HashTable specialisation for hashing pointers.
Definition: HashPtrTable.H:50
fvMesh & mesh
HashPtrTable< volScalarField > dmidtf() const
The mass transfer rate for individual species.
const dimensionSet dimTime
Dimension set for the base types.
Definition: dimensionSet.H:121
const dimensionSet dimDensity
virtual bool mixture() const
Whether or not there is a mass transfer rate for the mixture.
hashedWordList species() const
The list of individual species that are transferred.
word timeName
Definition: getTimeIndex.H:3
bool mixture() const
Whether or not there is a mass transfer rate for the mixture.
phaseTransferModel(const dictionary &dict, const phaseInterface &interface)
Construct from a dictionary and an interface.
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
defineTypeNameAndDebug(combustionModel, 0)
virtual tmp< volScalarField > dmdtf() const
The mass transfer rate for the mixture.
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
bool writeData(Ostream &os) const
Dummy write for regIOobject.
A wordList with hashed indices for faster lookup by name.
tmp< volScalarField > dmdtf() const
The mass transfer rate for the mixture.
#define defineBlendedInterfacialModelTypeNameAndDebug(ModelType, DebugSwitch)
A class for managing temporary objects.
Definition: PtrList.H:53
virtual HashPtrTable< volScalarField > dmidtf() const
The mass transfer rate for individual species.
Namespace for OpenFOAM.