initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / lagrangian / intermediate / submodels / addOns / radiation / absorptionEmission / cloudAbsorptionEmission / cloudAbsorptionEmission.H
bloba737764e88ce9add4f113e6c324ddd1bd9f8f266
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::radiation::cloudAbsorptionEmission
28 Description
29     Retrieves absorption/emission data from a cloud object
31 SourceFiles
32     cloudAbsorptionEmission.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef radiationCloudAbsorptionEmission_H
37 #define radiationCloudAbsorptionEmission_H
39 #include "absorptionEmissionModel.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
45 namespace radiation
48 /*---------------------------------------------------------------------------*\
49                   Class cloudAbsorptionEmission Declaration
50 \*---------------------------------------------------------------------------*/
52 class cloudAbsorptionEmission
54     public absorptionEmissionModel
56     // Private data
58         //- Coefficients dictionary
59         dictionary coeffsDict_;
61         //- Cloud name(s)
62         const wordList cloudNames_;
65 public:
67     //- Runtime type information
68     TypeName("cloudAbsorptionEmission");
71     // Constructors
73         //- Construct from components
74         cloudAbsorptionEmission(const dictionary& dict, const fvMesh& mesh);
77     // Destructor
78     virtual ~cloudAbsorptionEmission();
81     // Member Operators
83         // Access
85             // Absorption coefficient
87                 //- Absorption coefficient for dispersed phase
88                 virtual tmp<volScalarField> aDisp(const label bandI = 0) const;
91             // Emission coefficient
93                 //- Emission coefficient for dispersed phase
94                 virtual tmp<volScalarField> eDisp(const label bandI = 0) const;
97             // Emission contribution
99                 //- Return emission contribution for dispersed phase
100                 virtual tmp<volScalarField> EDisp(const label bandI = 0) const;
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 } // End namespace radiation
107 } // End namespace Foam
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 #endif
113 // ************************************************************************* //