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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2015 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::radiation::scatterModel
28
29Description
30 Base class for radiation scattering
31
32\*---------------------------------------------------------------------------*/
33
34#ifndef scatterModel_H
35#define scatterModel_H
36
37#include "IOdictionary.H"
38#include "autoPtr.H"
40#include "volFields.H"
41
42// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44namespace Foam
45{
46namespace radiation
47{
48
49/*---------------------------------------------------------------------------*\
50 Class scatterModel Declaration
51\*---------------------------------------------------------------------------*/
53class scatterModel
54{
55
56protected:
57
58 // Protected data
59
60 //- Reference to the fvMesh
61 const fvMesh& mesh_;
62
63public:
64
65 //- Runtime type information
66 TypeName("scatterModel");
67
68 // Declare runtime constructor selection table
71 (
72 autoPtr,
75 (
76 const dictionary& dict,
77 const fvMesh& mesh
78 ),
79 (dict, mesh)
80 );
81
82
83 // Constructors
84
85 //- Construct from components
86 scatterModel(const dictionary& dict, const fvMesh& mesh);
87
88
89 // Selector
90
92 (
93 const dictionary& dict,
94 const fvMesh& mesh
95 );
96
97
98 //- Destructor
99 virtual ~scatterModel();
100
101
102 // Member Functions
103
104 //- Return scatter coefficient
105 virtual tmp<volScalarField> sigmaEff() const = 0;
106};
107
108
109// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110
111} // End namespace radiation
112} // End namespace Foam
113
114// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115
116#endif
117
118// ************************************************************************* //
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
Base class for radiation scattering.
Definition: scatterModel.H:53
const fvMesh & mesh_
Reference to the fvMesh.
Definition: scatterModel.H:60
TypeName("scatterModel")
Runtime type information.
virtual ~scatterModel()
Destructor.
Definition: scatterModel.C:57
virtual tmp< volScalarField > sigmaEff() const =0
Return scatter coefficient.
declareRunTimeSelectionTable(autoPtr, scatterModel, dictionary,(const dictionary &dict, const fvMesh &mesh),(dict, mesh))
static autoPtr< scatterModel > New(const dictionary &dict, const fvMesh &mesh)
A class for managing temporary objects.
Definition: tmp.H:65
dynamicFvMesh & mesh
autoPtr< radiation::radiationModel > radiation(radiation::radiationModel::New(T))
Namespace for OpenFOAM.
Macros to ease declaration of run-time selection tables.
#define declareRunTimeSelectionTable(ptrWrapper, baseType, argNames, argList, parList)
Declare a run-time selection (variables and adder classes)
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73