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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2018 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::kineticTheoryModels::viscosityModel
28 
29 Description
30 
31 SourceFiles
32  viscosityModel.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef viscosityModel_H
37 #define viscosityModel_H
38 
39 #include "dictionary.H"
40 #include "volFields.H"
41 #include "dimensionedTypes.H"
42 #include "runTimeSelectionTables.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 namespace kineticTheoryModels
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class viscosityModel Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class viscosityModel
56 {
57  // Private member functions
58 
59  //- Disallow default bitwise copy construct
61 
62  //- Disallow default bitwise assignment
63  void operator=(const viscosityModel&);
64 
65 
66 protected:
67 
68  // Protected data
69 
70  const dictionary& dict_;
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("viscosityModel");
77 
78  // Declare runtime constructor selection table
80  (
81  autoPtr,
83  dictionary,
84  (
85  const dictionary& dict
86  ),
87  (dict)
88  );
89 
90 
91  // Constructors
92 
93  //- Construct from components
95 
96 
97  // Selectors
98 
100  (
101  const dictionary& dict
102  );
103 
104 
105  //- Destructor
106  virtual ~viscosityModel();
107 
108 
109  // Member Functions
110 
111  virtual tmp<volScalarField> nu
112  (
113  const volScalarField& alpha1,
114  const volScalarField& Theta,
115  const volScalarField& g0,
116  const volScalarField& rho1,
117  const volScalarField& da,
118  const dimensionedScalar& e
119  ) const = 0;
120 
121  virtual bool read()
122  {
123  return true;
124  }
125 };
126 
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 } // End namespace kineticTheoryModels
131 } // End namespace Foam
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #endif
136 
137 // ************************************************************************* //
volFields.H
Foam::kineticTheoryModels::viscosityModel::read
virtual bool read()
Definition: viscosityModel.H:120
Foam::tmp< volScalarField >
Foam::kineticTheoryModels::viscosityModel::nu
virtual tmp< volScalarField > nu(const volScalarField &alpha1, const volScalarField &Theta, const volScalarField &g0, const volScalarField &rho1, const volScalarField &da, const dimensionedScalar &e) const =0
Foam::kineticTheoryModels::viscosityModel
Definition: viscosityModel.H:54
Foam::kineticTheoryModels::viscosityModel::~viscosityModel
virtual ~viscosityModel()
Destructor.
Definition: viscosityModel.C:55
alpha1
const volScalarField & alpha1
Definition: setRegionFluidFields.H:8
Foam::kineticTheoryModels::viscosityModel::TypeName
TypeName("viscosityModel")
Runtime type information.
Foam::kineticTheoryModels::viscosityModel::declareRunTimeSelectionTable
declareRunTimeSelectionTable(autoPtr, viscosityModel, dictionary,(const dictionary &dict),(dict))
rho1
volScalarField & rho1
Definition: setRegionFluidFields.H:27
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::dimensioned< scalar >
Foam::kineticTheoryModels::viscosityModel::dict_
const dictionary & dict_
Definition: viscosityModel.H:69
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
runTimeSelectionTables.H
Macros to ease declaration of run-time selection tables.
Foam::kineticTheoryModels::viscosityModel::New
static autoPtr< viscosityModel > New(const dictionary &dict)
Definition: newViscosityModel.C:35
Foam::constant::electromagnetic::e
const dimensionedScalar e
Elementary charge.
Definition: createFields.H:11
dictionary.H
dimensionedTypes.H
Foam::GeometricField< scalar, fvPatchField, volMesh >