noScatter.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) 2012-2016 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
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 
26 Class
27  Foam::radiation::noScatter
28 
29 Group
30  grpRadiationScatterSubModels
31 
32 Description
33  Dummy scatter model for 'none'
34 
35 SourceFiles
36  scatterModel.C
37 
38 \*---------------------------------------------------------------------------*/
39 
40 #ifndef radiation_noScatter_H
41 #define radiation_noScatter_H
42 
43 #include "scatterModel.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 namespace radiation
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  Class noScatter Declaration
54 \*---------------------------------------------------------------------------*/
55 
56 class noScatter
57 :
58  public scatterModel
59 {
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("none");
65 
66 
67  // Constructors
68 
69  //- Construct from components
70  noScatter(const dictionary& dict, const fvMesh& mesh);
71 
72 
73  //- Destructor
74  virtual ~noScatter() = default;
75 
76 
77  // Member Functions
78 
79  //- Return scatter coefficient
81 };
82 
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 } // End namespace radiation
87 } // End namespace Foam
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 #endif
92 
93 // ************************************************************************* //
Foam::radiation::noScatter::~noScatter
virtual ~noScatter()=default
Destructor.
scatterModel.H
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::radiation::noScatter::TypeName
TypeName("none")
Runtime type information.
Foam::radiation::noScatter::noScatter
noScatter(const dictionary &dict, const fvMesh &mesh)
Construct from components.
Definition: noScatter.C:46
Foam::radiation::noScatter
Dummy scatter model for 'none'.
Definition: noScatter.H:55
radiation
autoPtr< radiation::radiationModel > radiation(radiation::radiationModel::New(T))
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:83
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::radiation::scatterModel
Base class for radiation scattering.
Definition: scatterModel.H:52
Foam::radiation::noScatter::sigmaEff
tmp< volScalarField > sigmaEff() const
Return scatter coefficient.
Definition: noScatter.C:57