All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
filmRadiationModel.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) 2011-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::filmRadiationModel
26 
27 Description
28  Base class for film radiation models
29 
30 SourceFiles
31  filmRadiationModel.C
32  filmRadiationModelNew.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef filmRadiationModel_H
37 #define filmRadiationModel_H
38 
39 #include "filmSubModelBase.H"
40 #include "runTimeSelectionTables.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace regionModels
47 {
48 namespace surfaceFilmModels
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class filmRadiationModel Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 :
57  public filmSubModelBase
58 {
59 public:
60 
61  //- Runtime type information
62  TypeName("radiationModel");
63 
64 
65  // Declare runtime constructor selection table
66 
68  (
69  autoPtr,
71  dictionary,
72  (
74  const dictionary& dict
75  ),
76  (film, dict)
77  );
78 
79  // Constructors
80 
81  //- Construct null
83 
84  //- Construct from type name, dictionary and surface film model
86  (
87  const word& modelType,
89  const dictionary& dict
90  );
91 
92  //- Disallow default bitwise copy construction
93  filmRadiationModel(const filmRadiationModel&) = delete;
94 
95 
96  // Selectors
97 
98  //- Return a reference to the selected phase change model
100  (
102  const dictionary& dict
103  );
104 
105 
106  //- Destructor
107  virtual ~filmRadiationModel();
108 
109 
110  // Member Functions
111 
112  // Evolution
113 
114  //- Correct
115  virtual void correct() = 0;
116 
117  //- Return the radiation sensible enthalpy source
118  virtual tmp<volScalarField::Internal> Shs() = 0;
119 
120 
121  // Member Operators
122 
123  //- Disallow default bitwise assignment
124  void operator=(const filmRadiationModel&) = delete;
125 };
126 
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 } // End namespace surfaceFilmModels
131 } // End namespace regionModels
132 } // End namespace Foam
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 #endif
137 
138 // ************************************************************************* //
Base class for surface film sub-models.
static autoPtr< filmRadiationModel > New(surfaceFilmRegionModel &film, const dictionary &dict)
Return a reference to the selected phase change model.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
void operator=(const filmRadiationModel &)=delete
Disallow default bitwise assignment.
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.
A class for handling words, derived from string.
Definition: word.H:59
declareRunTimeSelectionTable(autoPtr, filmRadiationModel, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict),(film, dict))
const word & modelType() const
Return const access to the sub-model type.
Definition: subModelBase.C:122
filmRadiationModel(surfaceFilmRegionModel &film)
Construct null.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
virtual tmp< volScalarField::Internal > Shs()=0
Return the radiation sensible enthalpy source.
Macros to ease declaration of run-time selection tables.
TypeName("radiationModel")
Runtime type information.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.