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-2024 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::radiationModels::absorptionEmissionModels::cloud
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 radiationModels
45 {
46 namespace absorptionEmissionModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class cloud Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class cloud
54 :
56 {
57  // Private Data
58 
59  //- Cloud name(s)
60  const wordList cloudNames_;
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("cloud");
67 
68 
69  // Constructors
70 
71  //- Construct from components
72  cloud(const dictionary& dict, const fvMesh& mesh);
73 
74 
75  //- Destructor
76  virtual ~cloud();
77 
78 
79  // Member Functions
80 
81  //- Absorption coefficient for dispersed phase
82  virtual tmp<volScalarField> aDisp(const label bandI = 0) const;
83 
84  //- Emission coefficient for dispersed phase
85  virtual tmp<volScalarField> eDisp(const label bandI = 0) const;
86 
87  //- Return emission contribution for dispersed phase
88  virtual tmp<volScalarField> EDisp(const label bandI = 0) const;
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace absorptionEmissionModels
95 } // End namespace radiationModels
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #endif
101 
102 // ************************************************************************* //
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:96
Model to supply absorption and emission coefficients for radiation modelling.
const fvMesh & mesh() const
Reference to the mesh.
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.
cloud(const dictionary &dict, const fvMesh &mesh)
Construct from components.
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.
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
dictionary dict