FreeFOAM The Cross-Platform CFD Toolkit
scatterModel.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::scatterModel
26 
27 Description
28  Base class for radiation scattering
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef scatterModel_H
33 #define scatterModel_H
34 
35 #include <OpenFOAM/IOdictionary.H>
36 #include <OpenFOAM/autoPtr.H>
38 #include <finiteVolume/volFields.H>
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace radiation
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class scatterModel Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 {
53 
54 protected:
55 
56  // Protected data
57 
58  //- Reference to the fvMesh
59  const fvMesh& mesh_;
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("scatterModel");
65 
66  // Declare runtime constructor selection table
67 
69  (
70  autoPtr,
72  dictionary,
73  (
74  const dictionary& dict,
75  const fvMesh& mesh
76  ),
77  (dict, mesh)
78  );
79 
80 
81  // Constructors
82 
83  //- Construct from components
85  (
86  const dictionary& dict,
87  const fvMesh& mesh
88  );
89 
90 
91  // Selector
92 
94  (
95  const dictionary& dict,
96  const fvMesh& mesh
97  );
98 
99 
100  // Destructor
101 
102  virtual ~scatterModel();
103 
104 
105  // Member Functions
106 
107  // Access
108 
109  //- Return scatter coefficient
110  virtual tmp<volScalarField> sigmaEff() const = 0;
111 };
112 
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 } // End namespace radiation
117 } // End namespace Foam
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 #endif
122 
123 // ************************ vim: set sw=4 sts=4 et: ************************ //
124