primaryRadiation.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) 2012-2018 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::primaryRadiation
26 
27 Description
28  Radiation model whereby the radiative heat flux is mapped from the primary
29  region
30 
31 SourceFiles
32  primaryRadiation.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef primaryRadiation_H
37 #define primaryRadiation_H
38 
39 #include "filmRadiationModel.H"
40 #include "volFieldsFwd.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace regionModels
47 {
48 namespace surfaceFilmModels
49 {
50 
51 /*---------------------------------------------------------------------------*\
52  Class primaryRadiation Declaration
53 \*---------------------------------------------------------------------------*/
54 
55 class primaryRadiation
56 :
57  public filmRadiationModel
58 {
59 private:
60 
61  // Private data
62 
63  //- Incident radiative flux mapped from the primary region / [kg/s3]
64  volScalarField qinPrimary_;
65 
66 
67  // Private member functions
68 
69  //- Disallow default bitwise copy construct
71 
72  //- Disallow default bitwise assignment
73  void operator=(const primaryRadiation&);
74 
75 
76 public:
77 
78  //- Runtime type information
79  TypeName("primaryRadiation");
80 
81 
82  // Constructors
83 
84  //- Construct from surface film model and dictionary
86  (
88  const dictionary& dict
89  );
90 
91 
92  //- Destructor
93  virtual ~primaryRadiation();
94 
95 
96  // Member Functions
97 
98  // Evolution
99 
100  //- Correct
101  virtual void correct();
102 
103  //- Return the radiation sensible enthalpy source
104  // Also updates qrNet
105  virtual tmp<volScalarField> Shs();
106 };
107 
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 } // End namespace surfaceFilmModels
112 } // End namespace regionModels
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #endif
118 
119 // ************************************************************************* //
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
const surfaceFilmRegionModel & film() const
Return const access to the film surface film model.
virtual tmp< volScalarField > Shs()
Return the radiation sensible enthalpy source.
TypeName("primaryRadiation")
Runtime type information.
Radiation model whereby the radiative heat flux is mapped from the primary region.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.