cloudAbsorptionEmission.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) 2011-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::radiation::cloudAbsorptionEmission
26 
27 Description
28  Retrieves absorption/emission data from a cloud object
29 
30 SourceFiles
31  cloudAbsorptionEmission.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cloudAbsorptionEmission_H
36 #define cloudAbsorptionEmission_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace radiation
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class cloudAbsorptionEmission Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
54 {
55  // Private data
56 
57  //- Coefficients dictionary
58  dictionary coeffsDict_;
59 
60  //- Cloud name(s)
61  const wordList cloudNames_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("cloudAbsorptionEmission");
68 
69 
70  // Constructors
71 
72  //- Construct from components
74 
75 
76  //- Destructor
77  virtual ~cloudAbsorptionEmission();
78 
79 
80  // Member Operators
81 
82  // Access
83 
84  // Absorption coefficient
85 
86  //- Absorption coefficient for dispersed phase
87  virtual tmp<volScalarField> aDisp(const label bandI = 0) const;
88 
89 
90  // Emission coefficient
91 
92  //- Emission coefficient for dispersed phase
93  virtual tmp<volScalarField> eDisp(const label bandI = 0) const;
94 
95 
96  // Emission contribution
97 
98  //- Return emission contribution for dispersed phase
99  virtual tmp<volScalarField> EDisp(const label bandI = 0) const;
100 };
101 
102 
103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 
105 } // End namespace radiation
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #endif
111 
112 // ************************************************************************* //
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
virtual tmp< volScalarField > eDisp(const label bandI=0) const
Emission coefficient for dispersed phase.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual tmp< volScalarField > EDisp(const label bandI=0) const
Return emission contribution for dispersed phase.
const fvMesh & mesh() const
Reference to the mesh.
const dictionary & dict() const
Reference to the dictionary.
Model to supply absorption and emission coefficients for radiation modelling.
virtual tmp< volScalarField > aDisp(const label bandI=0) const
Absorption coefficient for dispersed phase.
Retrieves absorption/emission data from a cloud object.
cloudAbsorptionEmission(const dictionary &dict, const fvMesh &mesh)
Construct from components.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
A class for managing temporary objects.
Definition: PtrList.H:53
TypeName("cloudAbsorptionEmission")
Runtime type information.
autoPtr< radiation::radiationModel > radiation(radiation::radiationModel::New(T))
Namespace for OpenFOAM.