DOC: Corrected class names in the file descriptions
[freefoam.git] / src / thermophysicalModels / radiation / radiationModel / fvDOM / absorptionCoeffs / absorptionCoeffs.H
blob8800d92cf568505eb439e3dfa3094431a0d0e051
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2008-2010 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
13     the Free Software Foundation, either version 3 of the License, or
14     (at your 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, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::absorptionCoeffs
27 Description
28     Absorption coefficients class used in greyMeanAbsorptionEmission and
29     wideBandAbsorptionEmission
31 SourceFiles
32     absorptionCoeffs.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef absorptionCoeffs_H
37 #define absorptionCoeffs_H
39 #include <OpenFOAM/List.H>
40 #include <OpenFOAM/IOstreams.H>
41 #include <OpenFOAM/IOdictionary.H>
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
46 namespace radiation
49 /*---------------------------------------------------------------------------*\
50                       Class absorptionCoeffs Declaration
51 \*---------------------------------------------------------------------------*/
53 class absorptionCoeffs
55 public:
57     // Public data members
59         static const int nCoeffs_ = 6;
60         typedef FixedList<scalar, nCoeffs_> coeffArray;
63 private:
65     // Private data
67         // Temperature limits of applicability for functions
69             scalar Tcommon_;
71             scalar Tlow_;
73             scalar Thigh_;
76         // Polynomial using inverse temperatures
77         bool invTemp_;
79         coeffArray highACoeffs_;
80         coeffArray lowACoeffs_;
83     // Private member functions
85         //- Check given temperature is within the range of the fitted coeffs
86         void checkT(const scalar T) const;
89 public:
91     // Constructors
93         //- Construct from Istream
94         absorptionCoeffs(Istream&);
96         // Null constructor
97         absorptionCoeffs()
98         {}
101     // Destructor
102     ~absorptionCoeffs();
105     // Member functions
107         //- Return the coefficients corresponding to the given temperature
108         const coeffArray& coeffs(const scalar T) const;
110         // Initialise from a dictionary
111         void initialise(const dictionary&);
113         // Initialise from an Istream
114         void initialise(Istream&);
117     // Access Functions
119         inline bool invTemp() const;
121         inline scalar Tcommon() const;
123         inline scalar Tlow() const;
125         inline scalar Thigh() const;
127         inline const coeffArray& highACoeffs() const;
129         inline const coeffArray& lowACoeffs() const;
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 } // End namespace Foam
135 } // End namespace radiation
137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 #include "absorptionCoeffsI.H"
141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
143 #endif
145 // ************************ vim: set sw=4 sts=4 et: ************************ //