Loading...
Searching...
No Matches
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-------------------------------------------------------------------------------
11License
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"
34// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
35
36namespace Foam
37{
42
44
45
46// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
47
49(
50 const dictionary& dict,
51 const phasePair& pair,
52 const bool registerObject
53)
54:
56 (
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 }
98 return ctorPtr(dict, pair, true);
99}
100
101
102// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
105{
106 return Cvm()*pair_.continuous().rho();
107}
108
111{
112 return pair_.dispersed()*Ki();
113}
114
115
120}
121
122
124{
125 return os.good();
126}
127
128
129// ************************************************************************* //
phaseModel & phase1
bool registerObject() const noexcept
Should objects created with this IOobject be registered?
@ NO_READ
Nothing to be read.
@ NO_WRITE
Ignore writing from objectRegistry::writeObject().
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition IOobject.H:191
const Time & time() const noexcept
Return Time associated with the objectRegistry.
Definition IOobject.C:456
const word & name() const noexcept
Return the object name.
Definition IOobjectI.H:205
static word groupName(StringType base, const word &group)
Create dot-delimited name.group string.
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition Ostream.H:59
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition autoPtr.H:65
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition dictionary.H:133
Dimension set for the base types, which can be used to implement rigorous dimension checking for alge...
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition phasePair.H:52
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition regIOobject.H:71
regIOobject(const IOobject &io, const bool isTimeObject=false)
Construct from IOobject. The optional flag adds special handling if the object is the top-level regIO...
Definition regIOobject.C:43
A class for managing temporary objects.
Definition tmp.H:75
virtual tmp< surfaceScalarField > Kf() const
Return the virtual mass coefficient Kf.
static const dimensionSet dimK
Coefficient dimensions.
bool writeData(Ostream &os) const
Pure virtual writeData function.
static autoPtr< virtualMassModel > New(const dictionary &dict, const phasePair &pair)
const phasePair & pair_
Phase pair.
virtual tmp< volScalarField > Ki() const
Return the phase-intensive virtual mass coefficient Ki.
virtual tmp< volScalarField > Cvm() const =0
Return the virtual mass coefficient.
virtual tmp< volScalarField > K() const
Return the virtual mass coefficient K.
virtualMassModel(const dictionary &dict, const phasePair &pair, const bool registerObject)
Construct from a dictionary and a phase pair.
A class for handling words, derived from Foam::string.
Definition word.H:66
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition className.H:142
dynamicFvMesh & mesh
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition error.H:637
OBJstream os(runTime.globalPath()/outputName)
word timeName
Definition getTimeIndex.H:3
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.
Namespace for OpenFOAM.
messageStream Info
Information stream (stdout output on master, null elsewhere).
const word GlobalIOList< Tuple2< scalar, vector > >::typeName("scalarVectorTable")
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition Ostream.H:519
errorManip< error > abort(error &err)
Definition errorManip.H:139
IOerror FatalIOError
Error stream (stdout output on all processes), with additional 'FOAM FATAL IO ERROR' header text and ...
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID.
Definition exprTraits.C:127
const dimensionSet dimDensity
#define defineBlendedInterfacialModelTypeNameAndDebug(ModelType, DebugSwitch)
#define defineRunTimeSelectionTable(baseType, argNames)
Define run-time selection table.
dictionary dict