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-2016 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::radiation::noRadiation
26 
27 Description
28  No radiation - does nothing to energy equation source terms
29  (returns zeros)
30 
31 SourceFiles
32  noRadiation.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef noRadiation_H
37 #define noRadiation_H
38 
39 #include "radiationModel.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace radiation
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class noRadiation Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class noRadiation
53 :
54  public radiationModel
55 {
56  // Private Member Functions
57 
58  //- Disallow default bitwise copy construct
59  noRadiation(const noRadiation&);
60 
61  //- Disallow default bitwise assignment
62  void operator=(const noRadiation&);
63 
64 
65 public:
66 
67  //- Runtime type information
68  TypeName("none");
69 
70 
71  // Constructors
72 
73  //- Construct from components
75 
76  //- Construct from components
77  noRadiation(const dictionary& dict, const volScalarField& T);
78 
79 
80  //- Destructor
81  virtual ~noRadiation();
82 
83 
84  // Member functions
85 
86  // Edit
87 
88  //- Solve radiation equation(s)
89  void calculate();
90 
91  //- Read radiationProperties dictionary
92  bool read();
93 
94  //- Source term component (for power of T^4)
95  tmp<volScalarField> Rp() const;
96 
97  //- Source term component (constant)
99 };
100 
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 } // End namespace radiation
105 } // End namespace Foam
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
bool read()
Read radiationProperties dictionary.
Definition: noRadiation.C:71
void calculate()
Solve radiation equation(s)
Definition: noRadiation.C:77
virtual ~noRadiation()
Destructor.
Definition: noRadiation.C:65
Top level model for radiation modelling.
No radiation - does nothing to energy equation source terms (returns zeros)
Definition: noRadiation.H:51
tmp< volScalarField > Rp() const
Source term component (for power of T^4)
Definition: noRadiation.C:81
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
tmp< volScalarField::Internal > Ru() const
Source term component (constant)
Definition: noRadiation.C:108
A class for managing temporary objects.
Definition: PtrList.H:53
autoPtr< radiation::radiationModel > radiation(radiation::radiationModel::New(T))
Namespace for OpenFOAM.
TypeName("none")
Runtime type information.