kineticTheoryViscosityModel.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) 2011-2023 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::kineticTheoryModels::viscosityModel
26 
27 Description
28 
29 SourceFiles
30  viscosityModel.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef kineticTheoryViscosityModel_H
35 #define kineticTheoryViscosityModel_H
36 
37 #include "dictionary.H"
38 #include "volFields.H"
39 #include "dimensionedTypes.H"
40 #include "runTimeSelectionTables.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace kineticTheoryModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class viscosityModel Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class viscosityModel
54 {
55 protected:
56 
57  // Protected data
58 
59  const dictionary& dict_;
60 
61 
62 public:
63 
64  //- Runtime type information
65  TypeName("viscosityModel");
66 
67  // Declare runtime constructor selection table
69  (
70  autoPtr,
72  dictionary,
73  (
74  const dictionary& dict
75  ),
76  (dict)
77  );
78 
79 
80  // Constructors
81 
82  //- Construct from components
84 
85  //- Disallow default bitwise copy construction
86  viscosityModel(const viscosityModel&) = delete;
87 
88 
89  // Selectors
90 
92  (
93  const dictionary& dict
94  );
95 
96 
97  //- Destructor
98  virtual ~viscosityModel();
99 
100 
101  // Member Functions
102 
103  virtual tmp<volScalarField> nu
104  (
105  const volScalarField& alpha1,
106  const volScalarField& Theta,
107  const volScalarField& g0,
108  const volScalarField& rho1,
109  const volScalarField& da,
110  const dimensionedScalar& e
111  ) const = 0;
112 
113  virtual bool read()
114  {
115  return true;
116  }
117 
118 
119  // Member Operators
120 
121  //- Disallow default bitwise assignment
122  void operator=(const viscosityModel&) = delete;
123 };
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace kineticTheoryModels
129 } // End namespace Foam
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************************************************************* //
Generic GeometricField class.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
virtual tmp< volScalarField > nu(const volScalarField &alpha1, const volScalarField &Theta, const volScalarField &g0, const volScalarField &rho1, const volScalarField &da, const dimensionedScalar &e) const =0
declareRunTimeSelectionTable(autoPtr, viscosityModel, dictionary,(const dictionary &dict),(dict))
static autoPtr< viscosityModel > New(const dictionary &dict)
viscosityModel(const dictionary &dict)
Construct from components.
void operator=(const viscosityModel &)=delete
Disallow default bitwise assignment.
TypeName("viscosityModel")
Runtime type information.
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.
const doubleScalar e
Definition: doubleScalar.H:106
Macros to ease declaration of run-time selection tables.
dictionary dict