virtualMassModel.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) 2014-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 "virtualMassModel.H"
30 #include "phasePair.H"
31 #include "surfaceInterpolate.H"
32 #include "BlendedInterfacialModel.H"
33 
34 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
35 
36 namespace Foam
37 {
38  defineTypeNameAndDebug(virtualMassModel, 0);
40  defineRunTimeSelectionTable(virtualMassModel, dictionary);
41 }
42 
44 
45 
46 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
47 
49 (
50  const dictionary& dict,
51  const phasePair& pair,
52  const bool registerObject
53 )
54 :
56  (
57  IOobject
58  (
59  IOobject::groupName(typeName, pair.name()),
60  pair.phase1().mesh().time().timeName(),
61  pair.phase1().mesh(),
62  IOobject::NO_READ,
63  IOobject::NO_WRITE,
64  registerObject
65  )
66  ),
67  pair_(pair)
68 {}
69 
70 
71 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
72 
75 (
76  const dictionary& dict,
77  const phasePair& pair
78 )
79 {
80  const word modelType(dict.get<word>("type"));
81 
82  Info<< "Selecting virtualMassModel for "
83  << pair << ": " << modelType << endl;
84 
85  auto* ctorPtr = dictionaryConstructorTable(modelType);
86 
87  if (!ctorPtr)
88  {
90  (
91  dict,
92  "virtualMassModel",
93  modelType,
94  *dictionaryConstructorTablePtr_
95  ) << abort(FatalIOError);
96  }
97 
98  return ctorPtr(dict, pair, true);
99 }
100 
101 
102 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
103 
105 {
106  return Cvm()*pair_.continuous().rho();
107 }
108 
109 
111 {
112  return pair_.dispersed()*Ki();
113 }
114 
115 
117 {
118  return
119  fvc::interpolate(pair_.dispersed())*fvc::interpolate(Ki());
120 }
121 
122 
124 {
125  return os.good();
126 }
127 
128 
129 // ************************************************************************* //
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:169
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::dimDensity
const dimensionSet dimDensity
Foam::virtualMassModel::virtualMassModel
virtualMassModel(const dictionary &dict, const phasePair &pair, const bool registerObject)
Construct from a dictionary and a phase pair.
Definition: virtualMassModel.C:49
Foam::defineRunTimeSelectionTable
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
Foam::virtualMassModel::writeData
bool writeData(Ostream &os) const
Pure virtual writeData function.
Definition: virtualMassModel.C:123
virtualMassModel.H
Foam::FatalIOError
IOerror FatalIOError
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::dimensionSet
Dimension set for the base types, which can be used to implement rigorous dimension checking for alge...
Definition: dimensionSet.H:108
Foam::IOstream::good
bool good() const noexcept
True if next operation might succeed.
Definition: IOstream.H:233
Foam::virtualMassModel::K
virtual tmp< volScalarField > K() const
Return the virtual mass coefficient K.
Definition: virtualMassModel.C:110
Foam::virtualMassModel::Ki
virtual tmp< volScalarField > Ki() const
Return the phase-intensive virtual mass coefficient Ki.
Definition: virtualMassModel.C:104
Foam::defineBlendedInterfacialModelTypeNameAndDebug
defineBlendedInterfacialModelTypeNameAndDebug(massTransferModel, 0)
Foam::virtualMassModel::New
static autoPtr< virtualMassModel > New(const dictionary &dict, const phasePair &pair)
Definition: virtualMassModel.C:75
FatalIOErrorInLookup
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:478
Foam::virtualMassModel::pair_
const phasePair & pair_
Phase pair.
Definition: virtualMassModel.H:64
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
Foam::virtualMassModel::Cvm
virtual tmp< volScalarField > Cvm() const =0
Return the virtual mass coefficient.
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
os
OBJstream os(runTime.globalPath()/outputName)
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::abort
errorManip< error > abort(error &err)
Definition: errorManip.H:144
Foam::fvc::interpolate
static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > interpolate(const GeometricField< Type, fvPatchField, volMesh > &tvf, const surfaceScalarField &faceFlux, Istream &schemeData)
Interpolate field onto faces using scheme given by Istream.
Foam::virtualMassModel::Kf
virtual tmp< surfaceScalarField > Kf() const
Return the virtual mass coefficient Kf.
Definition: virtualMassModel.C:116
Foam::autoPtr< Foam::virtualMassModel >
Foam::regIOobject
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:73
Foam::phasePair::name
virtual word name() const
Pair name.
Definition: phasePair.C:69
Foam::phaseModel::rho
const dimensionedScalar & rho() const
Definition: phaseModel.H:167
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::phasePair::phase1
const phaseModel & phase1() const
Definition: phasePairI.H:30
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
Foam::phasePair::continuous
virtual const phaseModel & continuous() const
Continuous phase.
Definition: phasePair.C:82
Foam::virtualMassModel::dimK
static const dimensionSet dimK
Coefficient dimensions.
Definition: virtualMassModel.H:92