filmTurbulenceModel.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::filmTurbulenceModel
26 
27 Description
28  Base class for film turbulence models
29 
30 SourceFiles
31  filmTurbulenceModel.C
32  filmTurbulenceModelNew.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef filmTurbulenceModel_H
37 #define filmTurbulenceModel_H
38 
39 #include "filmSubModelBase.H"
40 #include "runTimeSelectionTables.H"
41 #include "fvMatricesFwd.H"
42 #include "volFieldsFwd.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 namespace regionModels
49 {
50 namespace surfaceFilmModels
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class filmTurbulenceModel Declaration
55 \*---------------------------------------------------------------------------*/
56 
58 :
59  public filmSubModelBase
60 {
61 public:
62 
63  //- Runtime type information
64  TypeName("filmTurbulenceModel");
65 
66 
67  // Declare runtime constructor selection table
68 
70  (
71  autoPtr,
73  dictionary,
74  (
76  const dictionary& dict
77  ),
78  (film, dict)
79  );
80 
81  // Constructors
82 
83  //- Construct null
85 
86  //- Construct from type name, dictionary and surface film model
88  (
89  const word& modelType,
91  const dictionary& dict
92  );
93 
94  //- Disallow default bitwise copy construction
96 
97 
98  // Selectors
99 
100  //- Return a reference to the selected injection model
102  (
104  const dictionary& dict
105  );
106 
107 
108  //- Destructor
109  virtual ~filmTurbulenceModel();
110 
111 
112  // Member Functions
113 
114  // Evolution
115 
116  //- Return the film surface velocity
117  virtual tmp<volVectorField> Us() const = 0;
118 
119  //- Return the film turbulence viscosity
120  virtual tmp<volScalarField> mut() const = 0;
121 
122  //- Correct/update the model
123  virtual void correct() = 0;
124 
125  //- Return the source for the film momentum equation
126  virtual tmp<fvVectorMatrix> Su(volVectorField& U) const = 0;
127 
128 
129  // Member Operators
130 
131  //- Disallow default bitwise assignment
132  void operator=(const filmTurbulenceModel&) = delete;
133 };
134 
135 
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 
138 } // End namespace surfaceFilmModels
139 } // End namespace regionModels
140 } // End namespace Foam
141 
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 
144 #endif
145 
146 // ************************************************************************* //
virtual tmp< fvVectorMatrix > Su(volVectorField &U) const =0
Return the source for the film momentum equation.
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
virtual tmp< volVectorField > Us() const =0
Return the film surface velocity.
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.
declareRunTimeSelectionTable(autoPtr, filmTurbulenceModel, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict),(film, dict))
virtual void correct()=0
Correct/update the model.
static autoPtr< filmTurbulenceModel > New(surfaceFilmRegionModel &film, const dictionary &dict)
Return a reference to the selected injection model.
A class for handling words, derived from string.
Definition: word.H:59
TypeName("filmTurbulenceModel")
Runtime type information.
void operator=(const filmTurbulenceModel &)=delete
Disallow default bitwise assignment.
const word & modelType() const
Return const access to the sub-model type.
Definition: subModelBase.C:122
virtual tmp< volScalarField > mut() const =0
Return the film turbulence viscosity.
Forward declarations of fvMatrix specializations.
U
Definition: pEqn.H:72
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.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.
filmTurbulenceModel(surfaceFilmRegionModel &film)
Construct null.