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-2020 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 #include "phasePair.H"
29 
30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
31 
32 namespace Foam
33 {
34  defineTypeNameAndDebug(phaseTransferModel, 0);
35  defineBlendedInterfacialModelTypeNameAndDebug(phaseTransferModel, 0);
36  defineRunTimeSelectionTable(phaseTransferModel, dictionary);
37 }
38 
39 const Foam::dimensionSet Foam::phaseTransferModel::dimDmdt =
41 
42 const Foam::hashedWordList Foam::phaseTransferModel::noSpecies_ =
44 
45 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
46 
48 (
49  const dictionary& dict,
50  const phasePair& pair
51 )
52 :
53  regIOobject
54  (
55  IOobject
56  (
57  IOobject::groupName(typeName, pair.name()),
58  pair.phase1().mesh().time().timeName(),
59  pair.phase1().mesh()
60  )
61  ),
62  pair_(pair)
63 {}
64 
65 
66 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
67 
69 {}
70 
71 
72 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
73 
75 {
76  return false;
77 }
78 
79 
81 {
82  return tmp<volScalarField>(nullptr);
83 }
84 
85 
87 {
88  return noSpecies_;
89 }
90 
91 
94 {
95  return HashPtrTable<volScalarField>();
96 }
97 
98 
99 bool Foam::phaseTransferModel::writeData(Ostream& os) const
100 {
101  return os.good();
102 }
103 
104 
105 // ************************************************************************* //
phaseTransferModel(const dictionary &dict, const phasePair &pair)
Construct from a dictionary and a phase pair.
dictionary dict
virtual const hashedWordList & species() const
The list of individual species that are transferred.
static const hashedWordList noSpecies_
Empty species list.
virtual ~phaseTransferModel()
Destructor.
A HashTable specialization for hashing pointers.
Definition: HashPtrTable.H:50
Dimension set for the base types.
Definition: dimensionSet.H:120
dynamicFvMesh & mesh
virtual bool mixture() const
Whether or not there is a mass transfer rate for the mixture.
word timeName
Definition: getTimeIndex.H:3
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.
const dimensionSet dimDensity
A wordList with hashed indices for faster lookup by name.
const dimensionSet dimTime(0, 0, 1, 0, 0, 0, 0)
Definition: dimensionSets.H:51
#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.