viscosityModel.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) 2011-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::viscosityModel
26 
27 Description
28 
29 SourceFiles
30  viscosityModel.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef viscosityModel_H
35 #define viscosityModel_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  // Private member functions
56 
57  //- Disallow default bitwise copy construct
59 
60  //- Disallow default bitwise assignment
61  void operator=(const viscosityModel&);
62 
63 
64 protected:
65 
66  // Protected data
67 
68  const dictionary& dict_;
69 
70 
71 public:
72 
73  //- Runtime type information
74  TypeName("viscosityModel");
75 
76  // Declare runtime constructor selection table
78  (
79  autoPtr,
81  dictionary,
82  (
83  const dictionary& dict
84  ),
85  (dict)
86  );
87 
88 
89  // Constructors
90 
91  //- Construct from components
92  viscosityModel(const dictionary& dict);
93 
94 
95  // Selectors
96 
98  (
99  const dictionary& dict
100  );
101 
102 
103  //- Destructor
104  virtual ~viscosityModel();
105 
106 
107  // Member Functions
108 
109  virtual tmp<volScalarField> nu
110  (
111  const volScalarField& alpha1,
112  const volScalarField& Theta,
113  const volScalarField& g0,
114  const volScalarField& rho1,
115  const volScalarField& da,
116  const dimensionedScalar& e
117  ) const = 0;
119  virtual bool read()
120  {
121  return true;
122  }
123 };
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace kineticTheoryModels
129 } // End namespace Foam
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************************************************************* //
TypeName("viscosityModel")
Runtime type information.
virtual tmp< volScalarField > nu(const volScalarField &alpha1, const volScalarField &Theta, const volScalarField &g0, const volScalarField &rho1, const volScalarField &da, const dimensionedScalar &e) const =0
Macros to ease declaration of run-time selection tables.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
declareRunTimeSelectionTable(autoPtr, viscosityModel, dictionary,( const dictionary &dict ),(dict))
dictionary dict
static autoPtr< viscosityModel > New(const dictionary &dict)
const double e
Elementary charge.
Definition: doubleFloat.H:78
rho1
Definition: pEqn.H:124
volScalarField & alpha1
Definition: createFields.H:15
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