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-------------------------------------------------------------------------------
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
30#include "phasePair.H"
31#include "fvcFlux.H"
32#include "surfaceInterpolate.H"
33
34// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
35
36namespace 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// ************************************************************************* //
phaseModel & phase1
static autoPtr< Time > New()
Construct (dummy) Time - no functionObjects or libraries.
Definition: Time.C:717
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
T get(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Dimension set for the base types, which can be used to implement rigorous dimension checking for alge...
Definition: dimensionSet.H:109
A class for managing temporary objects.
Definition: tmp.H:65
virtual tmp< surfaceScalarField > Ff() const
Return face wall lubrication force.
virtual tmp< volVectorField > F() const
Return wall lubrication force.
static const dimensionSet dimF
Coefficient dimensions.
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition: className.H:121
dynamicFvMesh & mesh
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:478
Calculate the face-flux of the given field.
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.
tmp< surfaceScalarField > flux(const volVectorField &vvf)
Return the face-flux field obtained from the given volVectorField.
Definition: fvcFlux.C:34
Namespace for OpenFOAM.
messageStream Info
Information stream (stdout output on master, null elsewhere)
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:372
IOerror FatalIOError
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
#define defineRunTimeSelectionTable(baseType, argNames)
Define run-time selection table.
dictionary dict