wallLubricationModel.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 "wallLubricationModel.H"
30 #include "phasePair.H"
31 #include "fvcFlux.H"
32 #include "surfaceInterpolate.H"
33 #include "wallFvPatch.H"
34 #include "BlendedInterfacialModel.H"
35 
36 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
37 
38 namespace Foam
39 {
40  defineTypeNameAndDebug(wallLubricationModel, 0);
41  defineBlendedInterfacialModelTypeNameAndDebug(wallLubricationModel, 0);
42  defineRunTimeSelectionTable(wallLubricationModel, dictionary);
43 }
44 
46 
47 
48 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
49 
51 (
53 ) const
54 {
55  volVectorField& Fi = tFi.ref();
56  const fvPatchList& patches = Fi.mesh().boundary();
57 
58  volVectorField::Boundary& FiBf = Fi.boundaryFieldRef();
59 
60  forAll(patches, patchi)
61  {
62  if (isA<wallFvPatch>(patches[patchi]))
63  {
64  fvPatchVectorField& Fiw = FiBf[patchi];
65  Fiw = Fiw.patchInternalField();
66  }
67  }
68 
69  return tFi;
70 }
71 
72 
73 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
74 
76 (
77  const dictionary& dict,
78  const phasePair& pair
79 )
80 :
81  wallDependentModel(pair.phase1().mesh()),
82  pair_(pair)
83 {}
84 
85 
86 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
87 
90 (
91  const dictionary& dict,
92  const phasePair& pair
93 )
94 {
95  const word modelType(dict.get<word>("type"));
96 
97  Info<< "Selecting wallLubricationModel for "
98  << pair << ": " << modelType << endl;
99 
100  auto* ctorPtr = dictionaryConstructorTable(modelType);
101 
102  if (!ctorPtr)
103  {
105  (
106  dict,
107  "wallLubricationModel",
108  modelType,
109  *dictionaryConstructorTablePtr_
110  ) << abort(FatalIOError);
111  }
113  return ctorPtr(dict, pair);
114 }
115 
116 
117 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
120 {
121  return pair_.dispersed()*Fi();
122 }
123 
124 
126 {
127  return fvc::interpolate(pair_.dispersed())*fvc::flux(Fi());
128 }
129 
130 
131 // ************************************************************************* //
dictionary dict
defineBlendedInterfacialModelTypeNameAndDebug(massTransferModel, 0)
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
tmp< surfaceScalarField > flux(const volVectorField &vvf)
Return the face-flux field obtained from the given volVectorField.
T & ref() const
Return non-const reference to the contents of a non-null managed pointer.
Definition: tmpI.H:235
static autoPtr< wallLubricationModel > New(const dictionary &dict, const phasePair &pair)
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:531
virtual tmp< volVectorField > F() const
Return wall lubrication force.
T get(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Find and return a T. FatalIOError if not found, or if the number of tokens is incorrect.
#define forAll(list, i)
Loop across all elements in list.
Definition: stdFoam.H:421
Dimension set for the base types, which can be used to implement rigorous dimension checking for alge...
Definition: dimensionSet.H:105
dynamicFvMesh & mesh
A class for handling words, derived from Foam::string.
Definition: word.H:63
Calculate the face-flux of the given field.
virtual tmp< surfaceScalarField > Ff() const
Return face wall lubrication force.
virtual tmp< volVectorField > Fi() const =0
Return phase-intensive wall lubrication force.
errorManip< error > abort(error &err)
Definition: errorManip.H:139
phaseModel & phase1
virtual tmp< Field< Type > > patchInternalField() const
Return internal field next to patch.
Definition: fvPatchField.C:221
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
defineTypeNameAndDebug(combustionModel, 0)
tmp< volVectorField > zeroGradWalls(tmp< volVectorField >) const
Zero-gradient wall-lubrication force at walls.
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.
static const dimensionSet dimF
Coefficient dimensions.
wallLubricationModel(const dictionary &dict, const phasePair &pair)
Construct from components.
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers...
Definition: List.H:55
const polyBoundaryMesh & patches
messageStream Info
Information stream (stdout output on master, null elsewhere)
A class for managing temporary objects.
Definition: HashPtrTable.H:50
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:635
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition: phasePair.H:49
A class which provides on-demand creation and caching of wall distance and wall normal fields for use...
Namespace for OpenFOAM.
IOerror FatalIOError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL IO ERROR&#39; header text and ...