filmViscosityModel.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) 2013 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::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 private:
61 
62  // Private Member Functions
63 
64  //- Disallow default bitwise copy construct
66 
67  //- Disallow default bitwise assignment
68  void operator=(const filmViscosityModel&);
69 
70 
71 protected:
72 
73  // Protected Member Data
74 
75  //- Reference to the viscosity field
77 
78 
79 public:
80 
81  //- Runtime type information
82  TypeName("filmViscosityModel");
83 
84 
85  // Declare runtime constructor selection table
86 
88  (
89  autoPtr,
91  dictionary,
92  (
94  const dictionary& dict,
96  ),
97  (owner, dict, mu)
98  );
99 
100  // Constructors
101 
102  //- Construct from type name, dictionary and surface film model
104  (
105  const word& modelType,
106  surfaceFilmModel& owner,
107  const dictionary& dict,
108  volScalarField& mu
109  );
110 
111 
112  // Selectors
113 
114  //- Return a reference to the selected phase change model
116  (
117  surfaceFilmModel& owner,
118  const dictionary& dict,
119  volScalarField& mu
120  );
121 
122 
123  //- Destructor
124  virtual ~filmViscosityModel();
125 
126 
127  // Member Functions
128 
129  // Evolution
130 
131  //- Correct
132  virtual void correct
133  (
134  const volScalarField& p,
135  const volScalarField& T
136  ) = 0;
137 
138 
139  // I-O
140 
141  //- Provide some feedback
142  virtual void info(Ostream& os) const;
143 };
144 
145 
146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
147 
148 } // End namespace surfaceFilmModels
149 } // End namespace regionModels
150 } // End namespace Foam
151 
152 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 
154 #endif
155 
156 // ************************************************************************* //
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
TypeName("filmViscosityModel")
Runtime type information.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
declareRunTimeSelectionTable(autoPtr, filmViscosityModel, dictionary,(surfaceFilmModel &owner, const dictionary &dict, volScalarField &mu),(owner, dict, mu))
const word & modelType() const
Return const access to the sub-model type.
Definition: subModelBase.C:122
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:53
volScalarField & mu_
Reference to the viscosity field.
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
const dimensionedScalar mu
Atomic mass unit.
static autoPtr< filmViscosityModel > New(surfaceFilmModel &owner, const dictionary &dict, volScalarField &mu)
Return a reference to the selected phase change model.
const surfaceFilmModel & owner() const
Return const access to the owner surface film model.
virtual void info(Ostream &os) const
Provide some feedback.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
Macros to ease declaration of run-time selection tables.
volScalarField & p
Namespace for OpenFOAM.