noTransmissivity.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) 2015 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::noTransmissivity
26 
27 Description
28  Dummy transmissivity model for 'none'
29 
30 SourceFiles
31  noTransmissivity.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef radiationConstantScatter_H
36 #define radiationConstantScatter_H
37 
38 #include "transmissivityModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace radiation
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class noTransmissivity Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class noTransmissivity
52 :
53  public transmissivityModel
54 {
55 
56 public:
57 
58  //- Runtime type information
59  TypeName("none");
60 
61 
62  // Constructors
63 
64  //- Construct from components
65  noTransmissivity(const dictionary& dict, const fvMesh& mesh);
66 
67 
68  //- Destructor
69  virtual ~noTransmissivity();
70 
71 
72  // Member Functions
73 
74  //- Return scatter coefficient
75  tmp<volScalarField> tauEff(const label bandI = 0) const;
76 
77  //- Is Grey
78  inline bool isGrey() const
79  {
80  return true;
81  }
82 
83 
84  //- Number of bands
85  inline label nBands() const
86  {
87  return 1;
88  }
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace radiation
95 } // End namespace Foam
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************************************************************* //
Foam::radiation::noTransmissivity
Dummy transmissivity model for 'none'.
Definition: noTransmissivity.H:50
Foam::radiation::noTransmissivity::isGrey
bool isGrey() const
Is Grey.
Definition: noTransmissivity.H:77
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:118
Foam::radiation::transmissivityModel
Base class for radiation scattering.
Definition: transmissivityModel.H:50
Foam::label
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Foam::radiation::noTransmissivity::tauEff
tmp< volScalarField > tauEff(const label bandI=0) const
Return scatter coefficient.
Definition: noTransmissivity.C:67
radiation
autoPtr< radiation::radiationModel > radiation(radiation::radiationModel::New(T))
Foam::radiation::noTransmissivity::~noTransmissivity
virtual ~noTransmissivity()
Destructor.
Definition: noTransmissivity.C:60
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:137
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:18
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
transmissivityModel.H
Foam::radiation::noTransmissivity::TypeName
TypeName("none")
Runtime type information.
Foam::radiation::noTransmissivity::noTransmissivity
noTransmissivity(const dictionary &dict, const fvMesh &mesh)
Construct from components.
Definition: noTransmissivity.C:49
Foam::radiation::noTransmissivity::nBands
label nBands() const
Number of bands.
Definition: noTransmissivity.H:84