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