All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
filmViscosityModel.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) 2013-2019 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::regionModels::surfaceFilmModels::filmViscosityModel
26 
27 Description
28  Base class for surface film viscosity models
29 
30 SourceFiles
31  filmViscosityModel.C
32  filmViscosityModelNew.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef filmViscosityModel_H
37 #define filmViscosityModel_H
38 
39 #include "filmSubModelBase.H"
40 #include "runTimeSelectionTables.H"
41 #include "scalarField.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 namespace regionModels
48 {
49 namespace surfaceFilmModels
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class filmViscosityModel Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 :
58  public filmSubModelBase
59 {
60 protected:
61 
62  // Protected Member Data
63 
64  //- Reference to the viscosity field
66 
67 
68 public:
69 
70  //- Runtime type information
71  TypeName("filmViscosityModel");
72 
73 
74  // Declare runtime constructor selection table
75 
77  (
78  autoPtr,
80  dictionary,
81  (
83  const dictionary& dict,
85  ),
86  (film, dict, mu)
87  );
88 
89  // Constructors
90 
91  //- Construct from type name, dictionary and surface film model
93  (
94  const word& modelType,
96  const dictionary& dict,
97  volScalarField& mu
98  );
99 
100  //- Disallow default bitwise copy construction
101  filmViscosityModel(const filmViscosityModel&) = delete;
102 
103 
104  // Selectors
105 
106  //- Return a reference to the selected phase change model
108  (
110  const dictionary& dict,
111  volScalarField& mu
112  );
113 
114 
115  //- Destructor
116  virtual ~filmViscosityModel();
117 
118 
119  // Member Functions
120 
121  // Evolution
122 
123  //- Correct
124  virtual void correct
125  (
126  const volScalarField& p,
127  const volScalarField& T
128  ) = 0;
129 
130 
131  // I-O
132 
133  //- Provide some feedback
134  virtual void info(Ostream& os) const;
135 
136 
137  // Member Operators
138 
139  //- Disallow default bitwise assignment
140  void operator=(const filmViscosityModel&) = delete;
141 };
142 
143 
144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
145 
146 } // End namespace surfaceFilmModels
147 } // End namespace regionModels
148 } // End namespace Foam
149 
150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
151 
152 #endif
153 
154 // ************************************************************************* //
TypeName("filmViscosityModel")
Runtime type information.
Base class for surface film sub-models.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
void operator=(const filmViscosityModel &)=delete
Disallow default bitwise assignment.
static autoPtr< filmViscosityModel > New(surfaceFilmRegionModel &film, const dictionary &dict, volScalarField &mu)
Return a reference to the selected phase change model.
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
const surfaceFilmRegionModel & film() const
Return const access to the film surface film model.
filmViscosityModel(const word &modelType, surfaceFilmRegionModel &film, const dictionary &dict, volScalarField &mu)
Construct from type name, dictionary and surface film model.
Base class for surface film viscosity models.
A class for handling words, derived from string.
Definition: word.H:59
virtual void correct(const volScalarField &p, const volScalarField &T)=0
Correct.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
const word & modelType() const
Return const access to the sub-model type.
Definition: subModelBase.C:122
volScalarField & mu_
Reference to the viscosity field.
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
const dimensionedScalar & mu
Atomic mass unit.
declareRunTimeSelectionTable(autoPtr, filmViscosityModel, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict, volScalarField &mu),(film, dict, mu))
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Macros to ease declaration of run-time selection tables.
volScalarField & p
virtual void info(Ostream &os) const
Provide some feedback.
Namespace for OpenFOAM.