FreeFOAM The Cross-Platform CFD Toolkit
constantScatter.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 | Copyright (C) 1991-2010 OpenCFD Ltd.
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::radiation::constantScatter
26 
27 Description
28  Constant radiation scatter coefficient
29 
30 SourceFiles
31  scatterModel.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef radiationConstantScatter_H
36 #define radiationConstantScatter_H
37 
38 #include <radiation/scatterModel.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace radiation
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class constantScatter Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public scatterModel
54 {
55 
56  // Private data
57 
58  //- Coefficients dictionary
59  dictionary coeffsDict_;
60 
61  //- Scattering coefficient / [1/m]
62  dimensionedScalar sigma_;
63 
64  //- Linear-anisotropic phase function coefficient / []
65  // -1 < C < 1
66  // - = backward scattering
67  // 0 = isotropic scattering (reasonable default value)
68  // + = forward scattering
70 
71 
72 public:
73 
74  //- Runtime type information
75  TypeName("constantScatter");
76 
77 
78  // Constructors
79 
80  //- Construct from components
82  (
83  const dictionary& dict,
84  const fvMesh& mesh
85  );
86 
87 
88  // Destructor
89 
91 
92 
93  // Member Operators
94 
95  // Edit
96 
97  // Access
98 
99  //- Return scatter coefficient
101 };
102 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace radiation
107 } // End namespace Foam
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************ vim: set sw=4 sts=4 et: ************************ //