noRadiation.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-2017 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::noRadiation
26 
27 Description
28  Dummy radiation model for 'none' option
29 
30 SourceFiles
31  noRadiation.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef noRadiation_H
36 #define noRadiation_H
37 
38 #include "filmRadiationModel.H"
39 #include "volFieldsFwd.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace regionModels
46 {
47 namespace surfaceFilmModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class noRadiation Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class noRadiation
55 :
56  public filmRadiationModel
57 {
58 private:
59 
60  // Private member functions
61 
62  //- Disallow default bitwise copy construct
63  noRadiation(const noRadiation&);
64 
65  //- Disallow default bitwise assignment
66  void operator=(const noRadiation&);
67 
68 
69 public:
70 
71  //- Runtime type information
72  TypeName("none");
73 
74 
75  // Constructors
76 
77  //- Construct from surface film model and dictionary
79  (
81  const dictionary& dict
82  );
83 
84 
85  //- Destructor
86  virtual ~noRadiation();
87 
88 
89  // Member Functions
90 
91  // Evolution
92 
93  //- Correct
94  virtual void correct();
95 
96  //- Return the radiation sensible enthalpy source
97  virtual tmp<volScalarField> Shs();
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace surfaceFilmModels
104 } // End namespace regionModels
105 } // End namespace Foam
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
const surfaceFilmModel & film() const
Return const access to the film surface film model.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const dictionary & dict() const
Return const access to the cloud dictionary.
Definition: subModelBase.C:110
virtual tmp< volScalarField > Shs()
Return the radiation sensible enthalpy source.
Definition: noRadiation.C:74
TypeName("none")
Runtime type information.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.