Forward compatibility: flex
[foam-extend-3.2.git] / src / thermophysicalModels / radiation / submodels / scatterModel / constantScatter / constantScatter.H
blob2572b89cfce3503825d1363aabe51cebde9dab91
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend 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 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::radiation::constantScatter
27 Description
28     Constant radiation scatter coefficient
30 SourceFiles
31     scatterModel.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef radiationConstantScatter_H
36 #define radiationConstantScatter_H
38 #include "scatterModel.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
44 namespace radiation
47 /*---------------------------------------------------------------------------*\
48                            Class constantScatter Declaration
49 \*---------------------------------------------------------------------------*/
51 class constantScatter
53     public scatterModel
56     // Private data
58         //- Coefficients dictionary
59         dictionary coeffsDict_;
61         //- Scattering coefficient / [1/m]
62         dimensionedScalar sigma_;
64         //- Linear-anisotropic phase function coefficient / []
65         //  -1 < C < 1
66         //  - = backward scattering
67         //  0 = isotropic scattering (reasonable default value)
68         //  + = forward scattering
69         dimensionedScalar C_;
72 public:
74     //- Runtime type information
75     TypeName("constantScatter");
78     // Constructors
80         //- Construct from components
81         constantScatter
82         (
83             const dictionary& dict,
84             const fvMesh& mesh
85         );
88     // Destructor
90         ~constantScatter();
93     // Member Operators
95         // Edit
97         // Access
99             //- Return scatter coefficient
100             tmp<volScalarField> sigmaEff() const;
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 } // End namespace radiation
107 } // End namespace Foam
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 #endif
113 // ************************************************************************* //