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-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 "wallLubricationModel.H"
30 #include "phasePair.H"
31 #include "fvcFlux.H"
32 #include "surfaceInterpolate.H"
33 
34 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
35 
36 namespace Foam
37 {
38  defineTypeNameAndDebug(wallLubricationModel, 0);
39  defineRunTimeSelectionTable(wallLubricationModel, dictionary);
40 }
41 
43 
44 
45 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
46 
48 (
49  const dictionary& dict,
50  const phasePair& pair
51 )
52 :
53  wallDependentModel(pair.phase1().mesh()),
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 wallLubricationModel for "
70  << pair << ": " << modelType << endl;
71 
72  auto* ctorPtr = dictionaryConstructorTable(modelType);
73 
74  if (!ctorPtr)
75  {
77  (
78  dict,
79  "wallLubricationModel",
80  modelType,
81  *dictionaryConstructorTablePtr_
82  ) << exit(FatalIOError);
83  }
84 
85  return ctorPtr(dict, pair);
86 }
87 
88 
89 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
90 
92 {
93  return pair_.dispersed()*Fi();
94 }
95 
96 
98 {
99  return fvc::interpolate(pair_.dispersed())*fvc::flux(Fi());
100 }
101 
102 
103 // ************************************************************************* //
dictionary dict
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:125
tmp< surfaceScalarField > flux(const volVectorField &vvf)
Return the face-flux field obtained from the given volVectorField.
static autoPtr< wallLubricationModel > New(const dictionary &dict, const phasePair &pair)
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:487
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.
Dimension set for the base types, which can be used to implement rigorous dimension checking for alge...
Definition: dimensionSet.H:105
dynamicFvMesh & mesh
Calculate the face-flux of the given field.
virtual tmp< surfaceScalarField > Ff() const
Return face wall lubrication force.
phaseModel & phase1
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
defineTypeNameAndDebug(combustionModel, 0)
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.
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:615
Namespace for OpenFOAM.
IOerror FatalIOError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL IO ERROR&#39; header text and ...