liftModel.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-2020 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 "liftModel.H"
30 #include "phasePair.H"
31 #include "fvcCurl.H"
32 #include "fvcFlux.H"
33 #include "surfaceInterpolate.H"
34 #include "BlendedInterfacialModel.H"
35 
36 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
37 
38 namespace Foam
39 {
40  defineTypeNameAndDebug(liftModel, 0);
42  defineRunTimeSelectionTable(liftModel, dictionary);
43 }
44 
45 const Foam::dimensionSet Foam::liftModel::dimF(1, -2, -2, 0, 0);
46 
47 
48 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
49 
51 (
52  const dictionary& dict,
53  const phasePair& pair
54 )
55 :
56  pair_(pair)
57 {}
58 
59 
60 // * * * * * * * * * * * * * * * * Selector * * * * * * * * * * * * * * * * //
61 
64 (
65  const dictionary& dict,
66  const phasePair& pair
67 )
68 {
69  const word modelType(dict.get<word>("type"));
70 
71  Info<< "Selecting liftModel for "
72  << pair << ": " << modelType << endl;
73 
74  auto cstrIter = dictionaryConstructorTablePtr_->cfind(modelType);
75 
76  if (!cstrIter.found())
77  {
79  (
80  dict,
81  "liftModel",
82  modelType,
83  *dictionaryConstructorTablePtr_
84  ) << abort(FatalIOError);
85  }
86 
87  return cstrIter()(dict, pair);
88 }
89 
90 
91 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
92 
94 {
95  return
96  Cl()
97  *pair_.continuous().rho()
98  *(
100  );
101 }
102 
103 
105 {
106  return pair_.dispersed()*Fi();
107 }
108 
109 
111 {
112  return fvc::interpolate(pair_.dispersed())*fvc::flux(Fi());
113 }
114 
115 
116 // ************************************************************************* //
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::fvc::flux
tmp< surfaceScalarField > flux(const volVectorField &vvf)
Return the face-flux field obtained from the given volVectorField.
Foam::fvc::curl
tmp< GeometricField< Type, fvPatchField, volMesh > > curl(const GeometricField< Type, fvPatchField, volMesh > &vf)
Definition: fvcCurl.C:47
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::liftModel::New
static autoPtr< liftModel > New(const dictionary &dict, const phasePair &pair)
Definition: liftModel.C:64
Foam::phasePair::Ur
tmp< volVectorField > Ur() const
Relative velocity.
Definition: phasePair.C:120
Foam::defineRunTimeSelectionTable
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
Foam::liftModel::dimF
static const dimensionSet dimF
Force dimensions.
Definition: liftModel.H:89
Foam::FatalIOError
IOerror FatalIOError
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:350
Foam::dimensionSet
Dimension set for the base types.
Definition: dimensionSet.H:65
Foam::liftModel::Cl
virtual tmp< volScalarField > Cl() const =0
Return lift coefficient.
fvcCurl.H
Calculate the curl of the given volField by constructing the Hodge-dual of the symmetric part of the ...
Foam::defineBlendedInterfacialModelTypeNameAndDebug
defineBlendedInterfacialModelTypeNameAndDebug(massTransferModel, 0)
FatalIOErrorInLookup
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:406
Foam::Info
messageStream Info
Information stream (uses stdout - output is on the master only)
Foam::liftModel::liftModel
liftModel(const dictionary &dict, const phasePair &pair)
Construct from a dictionary and a phase pair.
Definition: liftModel.C:51
Foam::liftModel::F
virtual tmp< volVectorField > F() const
Return lift force.
Definition: liftModel.C:104
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:121
Foam::liftModel::Fi
virtual tmp< volVectorField > Fi() const
Return phase-intensive lift force.
Definition: liftModel.C:93
Foam::liftModel::Ff
virtual tmp< surfaceScalarField > Ff() const
Return face lift force.
Definition: liftModel.C:110
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::autoPtr< Foam::liftModel >
Foam::phaseModel::U
const volVectorField & U() const
Definition: phaseModel.H:172
fvcFlux.H
Calculate the face-flux of the given field.
liftModel.H
Foam::phaseModel::rho
const dimensionedScalar & rho() const
Definition: phaseModel.H:167
Foam::liftModel::pair_
const phasePair & pair_
Phase pair.
Definition: liftModel.H:62
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)
Foam::phasePair::continuous
virtual const phaseModel & continuous() const
Continuous phase.
Definition: phasePair.C:82