All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
function1Viscosity.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) 2017-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::function1Viscosity
26 
27 Description
28  The Foam::Function1 temperature-dependent viscosity model multiplies the
29  viscosity of a base model by a Function1 temperature function.
30 
31 SourceFiles
32  function1Viscosity.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef function1Viscosity_H
37 #define function1Viscosity_H
38 
39 #include "filmViscosityModel.H"
40 #include "Function1.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace regionModels
47 {
48 namespace surfaceFilmModels
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class function1Viscosity Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
57  public filmViscosityModel
58 {
59  // Private Member Functions
60 
61  //- Disallow default bitwise copy construction
62  function1Viscosity(const function1Viscosity&) = delete;
63 
64  //- Disallow default bitwise assignment
65  void operator=(const function1Viscosity&) = delete;
66 
67 
68 protected:
69 
70  // Protected data
71 
72  //- Base viscosity model
74 
75  //- Viscosity factor as a function of temperature
77 
78 
79 public:
80 
81  //- Runtime type information
82  TypeName("function1");
83 
84 
85  // Constructors
86 
87  //- Construct from surface film model
89  (
91  const dictionary& dict,
93  );
94 
95 
96  //- Destructor
97  virtual ~function1Viscosity();
98 
99 
100  // Member Functions
101 
102  //- Correct
103  virtual void correct
104  (
105  const volScalarField& p,
106  const volScalarField& T
107  );
108 };
109 
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 } // End namespace surfaceFilmModels
114 } // End namespace regionModels
115 } // End namespace Foam
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #endif
120 
121 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
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.
Base class for surface film viscosity models.
The Foam::Function1 temperature-dependent viscosity model multiplies the viscosity of a base model by...
virtual void correct(const volScalarField &p, const volScalarField &T)
Correct.
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
autoPtr< Function1< scalar > > function_
Viscosity factor as a function of temperature.
autoPtr< filmViscosityModel > viscosity_
Base viscosity model.
const dimensionedScalar & mu
Atomic mass unit.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
TypeName("function1")
Runtime type information.
volScalarField & p
Namespace for OpenFOAM.