laminar.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::laminar
26 
27 Description
28  Film laminar turbulence model.
29 
30 SourceFiles
31  laminar.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef laminar_H
36 #define laminar_H
37 
38 #include "filmTurbulenceModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace regionModels
45 {
46 namespace surfaceFilmModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class laminar Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class laminar
54 :
55  public filmTurbulenceModel
56 {
57  // Private Data
58 
59  //- Surface roughness coefficient
60  scalar Cf_;
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("laminar");
67 
68 
69  // Constructors
70 
71  //- Construct from surface film model
73 
74  //- Disallow default bitwise copy construction
75  laminar(const laminar&) = delete;
76 
77 
78  //- Destructor
79  virtual ~laminar();
80 
81 
82  // Member Functions
83 
84  // Evolution
85 
86  //- Return the film surface velocity
87  virtual tmp<volVectorField> Us() const;
88 
89  //- Return the film turbulence viscosity
90  virtual tmp<volScalarField> mut() const;
91 
92  //- Correct/update the model
93  virtual void correct();
94 
95  //- Return the source for the film momentum equation
96  virtual tmp<fvVectorMatrix> Su(volVectorField& U) const;
97 
98 
99  // Member Operators
100 
101  //- Disallow default bitwise assignment
102  void operator=(const laminar&) = delete;
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace surfaceFilmModels
109 } // End namespace regionModels
110 } // End namespace Foam
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 #endif
115 
116 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
laminar(surfaceFilmRegionModel &film, const dictionary &dict)
Construct from surface film model.
Definition: laminar.C:53
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.
Film laminar turbulence model.
Definition: laminar.H:52
virtual tmp< fvVectorMatrix > Su(volVectorField &U) const
Return the source for the film momentum equation.
Definition: laminar.C:110
void operator=(const laminar &)=delete
Disallow default bitwise assignment.
virtual tmp< volVectorField > Us() const
Return the film surface velocity.
Definition: laminar.C:71
U
Definition: pEqn.H:72
virtual tmp< volScalarField > mut() const
Return the film turbulence viscosity.
Definition: laminar.C:92
virtual void correct()
Correct/update the model.
Definition: laminar.C:106
TypeName("laminar")
Runtime type information.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.