radiation.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) 2017-2019 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::fv::radiation
26 
27 Description
28  Calculates and applies the radiation source to the energy equation.
29 
30 Usage
31  Example usage:
32  \verbatim
33  radiationCoeffs
34  {
35  fields (h); // Name of energy field
36  }
37  \endverbatim
38 
39 SourceFiles
40  radiation.C
41 
42 \*---------------------------------------------------------------------------*/
43 
44 #ifndef radiation_H
45 #define radiation_H
46 
47 #include "fvOption.H"
49 #include "radiationModel.H"
50 
51 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
52 
53 namespace Foam
54 {
55 namespace fv
56 {
57 
58 /*---------------------------------------------------------------------------*\
59  Class radiation Declaration
60 \*---------------------------------------------------------------------------*/
61 
62 class radiation
63 :
64  public option
65 {
66  // Private Data
67 
68  //- The radiation model pointer
69  autoPtr<radiationModel> radiation_;
70 
71 
72 public:
73 
74  //- Runtime type information
75  TypeName("radiation");
76 
77 
78  // Constructors
79 
80  //- Construct from explicit source name and mesh
81  radiation
82  (
83  const word& sourceName,
84  const word& modelType,
85  const dictionary& dict,
86  const fvMesh& mesh
87  );
88 
89  //- Disallow default bitwise copy construction
90  radiation(const radiation&) = delete;
91 
92 
93  // Member Functions
94 
95  // Evaluate
96 
97  //- Add explicit contribution to compressible momentum equation
98  virtual void addSup
99  (
100  const volScalarField& rho,
101  fvMatrix<scalar>& eqn,
102  const label fieldi
103  );
104 
105 
106  // IO
107 
108  //- Read source dictionary
109  virtual bool read(const dictionary& dict);
110 
111 
112  // Member Operators
113 
114  //- Disallow default bitwise assignment
115  void operator=(const radiation&) = delete;
116 };
117 
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 } // End namespace fv
122 } // End namespace Foam
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #endif
127 
128 // ************************************************************************* //
dictionary dict
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
const fvMesh & mesh() const
Return const access to the mesh database.
Definition: fvOptionI.H:34
A class for handling words, derived from string.
Definition: word.H:59
labelList fv(nPoints)
void operator=(const radiation &)=delete
Disallow default bitwise assignment.
Calculates and applies the radiation source to the energy equation.
Definition: radiation.H:61
A special matrix type and solver, designed for finite volume solutions of scalar equations. Face addressing is used to make all matrix assembly and solution loops vectorise.
Definition: fvPatchField.H:72
radiation(const word &sourceName, const word &modelType, const dictionary &dict, const fvMesh &mesh)
Construct from explicit source name and mesh.
Definition: radiation.C:52
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
virtual bool read(const dictionary &dict)
Read source dictionary.
Definition: radiation.C:74
virtual void addSup(const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
Add explicit contribution to compressible momentum equation.
Definition: radiation.C:81
Namespace for OpenFOAM.
TypeName("radiation")
Runtime type information.
Finite volume options abstract base class. Provides a base set of controls, e.g.: ...
Definition: fvOption.H:66