noWallLubrication.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2014-2022 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::wallLubricationModels::noWallLubrication
26 
27 Description
28 
29 SourceFiles
30  noWallLubrication.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef noWallLubrication_H
35 #define noWallLubrication_H
36 
37 #include "wallLubricationModel.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 namespace wallLubricationModels
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class noWallLubrication Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
53 {
54 protected:
55 
56  // Protected data
57 
58  //- Interface
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("none");
66 
67 
68  // Constructors
69 
70  //- Construct from a dictionary and an interface
72  (
73  const dictionary& dict,
74  const phaseInterface& interface
75  );
76 
77 
78  //- Destructor
79  virtual ~noWallLubrication();
80 
81 
82  // Member Functions
83 
84  //- Return wall lubrication force
85  virtual tmp<volVectorField> F() const;
86 
87  //- Return face wall lubrication force
88  virtual tmp<surfaceScalarField> Ff() const;
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace wallLubricationModels
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************************************************************* //
noWallLubrication(const dictionary &dict, const phaseInterface &interface)
Construct from a dictionary and an interface.
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
const phaseInterface interface_
Interface.
Class to represent an interface between phases. Derivations can further specify the configuration of ...
TypeName("none")
Runtime type information.
Model for the wall lubrication force between two phases.
virtual tmp< surfaceScalarField > Ff() const
Return face wall lubrication force.
virtual tmp< volVectorField > F() const
Return wall lubrication force.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.