wallLubricationModel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2014-2015 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::wallLubricationModel
26 
27 Description
28 
29 SourceFiles
30  wallLubricationModel.C
31  newWallLubricationModel.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef wallLubricationModel_H
36 #define wallLubricationModel_H
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 #include "wallDependentModel.H"
41 #include "volFields.H"
42 #include "dictionary.H"
43 #include "runTimeSelectionTables.H"
44 
45 namespace Foam
46 {
47 
48 class phasePair;
49 
50 /*---------------------------------------------------------------------------*\
51  Class wallLubricationModel Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
56  public wallDependentModel
57 {
58 protected:
59 
60  // Protected data
61 
62  //- Phase pair
63  const phasePair& pair_;
64 
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("wallLubricationModel");
70 
71 
72  // Declare runtime construction
73 
75  (
76  autoPtr,
78  dictionary,
79  (
80  const dictionary& dict,
81  const phasePair& pair
82  ),
83  (dict, pair)
84  );
85 
86 
87  // Static data members
88 
89  //- Coefficient dimensions
90  static const dimensionSet dimF;
91 
92 
93  // Constructors
94 
95  //- Construct from components
97  (
98  const dictionary& dict,
99  const phasePair& pair
100  );
101 
102 
103  //- Destructor
104  virtual ~wallLubricationModel();
105 
106 
107  // Selectors
108 
110  (
111  const dictionary& dict,
112  const phasePair& pair
113  );
114 
115 
116  // Member Functions
117 
118  //- Return phase-intensive wall lubrication force
119  virtual tmp<volVectorField> Fi() const = 0;
120 
121  //- Return wall lubrication force
122  virtual tmp<volVectorField> F() const;
123 
124  //- Return face wall lubrication force
125  virtual tmp<surfaceScalarField> Ff() const;
126 };
127 
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 } // End namespace Foam
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #endif
136 
137 // ************************************************************************* //
virtual ~wallLubricationModel()
Destructor.
Macros to ease declaration of run-time selection tables.
TypeName("wallLubricationModel")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
const phasePair & pair_
Phase pair.
dictionary dict
A class which provides on-demand creation and caching of wall distance and wall normal fields for use...
static autoPtr< wallLubricationModel > New(const dictionary &dict, const phasePair &pair)
Dimension set for the base types.
Definition: dimensionSet.H:116
virtual tmp< surfaceScalarField > Ff() const
Return face wall lubrication force.
virtual tmp< volVectorField > Fi() const =0
Return phase-intensive wall lubrication force.
declareRunTimeSelectionTable(autoPtr, wallLubricationModel, dictionary,( const dictionary &dict, const phasePair &pair ),(dict, pair))
static const dimensionSet dimF
Coefficient dimensions.
wallLubricationModel(const dictionary &dict, const phasePair &pair)
Construct from components.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
A class for managing temporary objects.
Definition: PtrList.H:118
virtual tmp< volVectorField > F() const
Return wall lubrication force.