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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::radiation::noRadiation
28 
29 Group
30  grpRadiationModels
31 
32 Description
33  No radiation - does nothing to energy equation source terms
34  (returns zeros)
35 
36 SourceFiles
37  noRadiation.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef noRadiation_H
42 #define noRadiation_H
43 
44 #include "radiationModel.H"
45 
46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 
48 namespace Foam
49 {
50 namespace radiation
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class noRadiation Declaration
55 \*---------------------------------------------------------------------------*/
56 
57 class noRadiation
58 :
59  public radiationModel
60 {
61  // Private Member Functions
62 
63  //- No copy construct
64  noRadiation(const noRadiation&) = delete;
65 
66  //- No copy assignment
67  void operator=(const noRadiation&) = delete;
68 
69 
70 public:
71 
72  //- Runtime type information
73  TypeName("none");
74 
75 
76  // Constructors
77 
78  //- Construct from components
80 
81  //- Construct from components
82  noRadiation(const dictionary& dict, const volScalarField& T);
83 
84 
85  //- Destructor
86  virtual ~noRadiation();
87 
88 
89  // Member functions
90 
91  // Edit
92 
93  //- Solve radiation equation(s)
94  void calculate();
95 
96  //- Read radiationProperties dictionary
97  bool read();
98 
99  //- Source term component (for power of T^4)
100  tmp<volScalarField> Rp() const;
101 
102  //- Source term component (constant)
104 
105  //- Number of bands
106  label nBands() const
107  {
108  return 0;
109  }
110 };
111 
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 } // End namespace radiation
116 } // End namespace Foam
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 #endif
121 
122 // ************************************************************************* //
Foam::radiation::noRadiation::Ru
tmp< volScalarField::Internal > Ru() const
Source term component (constant)
Definition: noRadiation.C:105
Foam::radiation::noRadiation::Rp
tmp< volScalarField > Rp() const
Source term component (for power of T^4)
Definition: noRadiation.C:83
Foam::radiation::noRadiation::read
bool read()
Read radiationProperties dictionary.
Definition: noRadiation.C:73
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::radiation::noRadiation::nBands
label nBands() const
Number of bands.
Definition: noRadiation.H:105
Foam::T
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
Definition: FieldFieldFunctions.C:58
radiation
autoPtr< radiation::radiationModel > radiation(radiation::radiationModel::New(T))
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::radiation::noRadiation::TypeName
TypeName("none")
Runtime type information.
Foam::radiation::noRadiation
No radiation - does nothing to energy equation source terms (returns zeros)
Definition: noRadiation.H:56
Foam::radiation::radiationModel
Top level model for radiation modelling.
Definition: radiationModel.H:75
Foam::radiation::noRadiation::~noRadiation
virtual ~noRadiation()
Destructor.
Definition: noRadiation.C:67
Foam::GeometricField< scalar, fvPatchField, volMesh >
radiationModel.H
Foam::radiation::noRadiation::calculate
void calculate()
Solve radiation equation(s)
Definition: noRadiation.C:79