filmRadiationModel.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) 2011-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::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 private:
60 
61  // Private Member Functions
62 
63  //- Disallow default bitwise copy construct
65 
66  //- Disallow default bitwise assignment
67  void operator=(const filmRadiationModel&);
68 
69 
70 public:
71 
72  //- Runtime type information
73  TypeName("radiationModel");
74 
75 
76  // Declare runtime constructor selection table
77 
79  (
80  autoPtr,
82  dictionary,
83  (
85  const dictionary& dict
86  ),
87  (owner, dict)
88  );
89 
90  // Constructors
91 
92  //- Construct null
94 
95  //- Construct from type name, dictionary and surface film model
97  (
98  const word& modelType,
99  surfaceFilmModel& owner,
100  const dictionary& dict
101  );
102 
103 
104  // Selectors
105 
106  //- Return a reference to the selected phase change model
108  (
109  surfaceFilmModel& owner,
110  const dictionary& dict
111  );
112 
113 
114  //- Destructor
115  virtual ~filmRadiationModel();
116 
117 
118  // Member Functions
119 
120  // Evolution
121 
122  //- Correct
123  virtual void correct() = 0;
124 
125  //- Return the radiation sensible enthalpy source
126  virtual tmp<volScalarField> Shs() = 0;
127 };
128 
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 } // End namespace surfaceFilmModels
133 } // End namespace regionModels
134 } // End namespace Foam
135 
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
137 
138 #endif
139 
140 // ************************************************************************* //
virtual tmp< volScalarField > Shs()=0
Return the radiation sensible enthalpy source.
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
declareRunTimeSelectionTable(autoPtr, filmRadiationModel, dictionary,(surfaceFilmModel &owner, const dictionary &dict),(owner, dict))
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
static autoPtr< filmRadiationModel > New(surfaceFilmModel &owner, const dictionary &dict)
Return a reference to the selected phase change model.
const surfaceFilmModel & owner() const
Return const access to the owner surface film model.
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.
TypeName("radiationModel")
Runtime type information.
A class for managing temporary objects.
Definition: PtrList.H:54
Namespace for OpenFOAM.