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) 2011-2015 OpenFOAM Foundation
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 "IOdictionary.H"
36 #include "autoPtr.H"
37 #include "runTimeSelectionTables.H"
38 #include "volFields.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace radiation
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class scatterModel Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class scatterModel
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
84  scatterModel(const dictionary& dict, const fvMesh& mesh);
85 
86 
87  // Selector
88 
90  (
91  const dictionary& dict,
92  const fvMesh& mesh
93  );
94 
95 
96  //- Destructor
97  virtual ~scatterModel();
98 
99 
100  // Member Functions
101 
102  //- Return scatter coefficient
103  virtual tmp<volScalarField> sigmaEff() const = 0;
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace radiation
110 } // End namespace Foam
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 #endif
115 
116 // ************************************************************************* //
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
virtual tmp< volScalarField > sigmaEff() const =0
Return scatter coefficient.
Macros to ease declaration of run-time selection tables.
dynamicFvMesh & mesh
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
Namespace for OpenFOAM.
dictionary dict
static autoPtr< scatterModel > New(const dictionary &dict, const fvMesh &mesh)
const fvMesh & mesh_
Reference to the fvMesh.
Definition: scatterModel.H:58
virtual ~scatterModel()
Destructor.
Definition: scatterModel.C:55
autoPtr< radiation::radiationModel > radiation(radiation::radiationModel::New(T))
TypeName("scatterModel")
Runtime type information.
declareRunTimeSelectionTable(autoPtr, scatterModel, dictionary,( const dictionary &dict, const fvMesh &mesh ),(dict, mesh))
scatterModel(const dictionary &dict, const fvMesh &mesh)
Construct from components.
Definition: scatterModel.C:44
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
A class for managing temporary objects.
Definition: PtrList.H:118
Base class for radiation scattering.
Definition: scatterModel.H:50