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-2016 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 "liftModel.H"
30 #include "phasePair.H"
31 #include "fvcCurl.H"
32 #include "fvcFlux.H"
33 #include "surfaceInterpolate.H"
34 
35 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
36 
37 namespace Foam
38 {
39  defineTypeNameAndDebug(liftModel, 0);
40  defineRunTimeSelectionTable(liftModel, dictionary);
41 }
42 
43 const Foam::dimensionSet Foam::liftModel::dimF(1, -2, -2, 0, 0);
44 
45 
46 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
47 
49 (
50  const dictionary& dict,
51  const phasePair& pair
52 )
53 :
54  pair_(pair)
55 {}
56 
57 
58 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
59 
62 (
63  const dictionary& dict,
64  const phasePair& pair
65 )
66 {
67  const word modelType(dict.get<word>("type"));
68 
69  Info<< "Selecting liftModel for "
70  << pair << ": " << modelType << endl;
71 
72  auto* ctorPtr = dictionaryConstructorTable(modelType);
73 
74  if (!ctorPtr)
75  {
77  (
78  dict,
79  "liftModel",
80  modelType,
81  *dictionaryConstructorTablePtr_
82  ) << exit(FatalIOError);
83  }
84 
85  return ctorPtr(dict, pair);
86 }
87 
88 
89 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
90 
92 {
93  return
94  Cl()
95  *pair_.continuous().rho()
96  *(
97  pair_.Ur() ^ fvc::curl(pair_.continuous().U())
98  );
99 }
100 
101 
103 {
104  return pair_.dispersed()*Fi();
105 }
106 
107 
109 {
110  return fvc::interpolate(pair_.dispersed())*fvc::flux(Fi());
111 }
112 
113 
114 // ************************************************************************* //
Foam::fvc::curl
tmp< GeometricField< Type, fvPatchField, volMesh > > curl(const GeometricField< Type, fvPatchField, volMesh > &vf)
Definition: fvcCurl.C:40
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:57
Foam::liftModel::New
static autoPtr< liftModel > New(const dictionary &dict, const phasePair &pair)
Definition: liftModel.C:57
Foam::defineRunTimeSelectionTable
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
liftModel.H
Foam::liftModel::dimF
static const dimensionSet dimF
Definition: liftModel.H:85
Foam::FatalIOError
IOerror FatalIOError
Foam::endl
Ostream & endl(Ostream &os)
Definition: Ostream.H:381
Foam::dictionary::get
T get(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Definition: dictionaryTemplates.C:100
Foam::dimensionSet
Dimension set for the base types, which can be used to implement rigorous dimension checking for alge...
Definition: dimensionSet.H:104
fvcCurl.H
Calculate the curl of the given volField by constructing the Hodge-dual of the symmetric part of the ...
FatalIOErrorInLookup
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Definition: error.H:502
Foam::Info
messageStream Info
Foam::liftModel::liftModel
liftModel(const dictionary &dict, const phasePair &pair)
Definition: liftModel.C:44
Foam::liftModel::F
virtual tmp< volVectorField > F() const
Definition: liftModel.C:97
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::liftModel::Fi
virtual tmp< volVectorField > Fi() const
Definition: liftModel.C:86
Foam::liftModel::Ff
virtual tmp< surfaceScalarField > Ff() const
Definition: liftModel.C:103
Foam
Definition: atmBoundaryLayer.C:26
Foam::fvc::interpolate
static tmp< GeometricField< Type, fvsPatchField, surfaceMesh > > interpolate(const GeometricField< Type, fvPatchField, volMesh > &tvf, const surfaceScalarField &faceFlux, Istream &schemeData)
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:125
Foam::autoPtr< Foam::liftModel >
fvcFlux.H
Calculate the face-flux of the given field.
Foam::fvc::flux
tmp< surfaceScalarField > flux(const volVectorField &vvf)
Definition: fvcFlux.C:27
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)