cloudScatter.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 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::cloudScatter
28 
29 Description
30  Cloud radiation scatter model
31 
32 SourceFiles
33  scatterModel.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef radiation_cloudScatter_H
38 #define radiation_cloudScatter_H
39 
40 #include "scatterModel.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace radiation
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class cloudScatter Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class cloudScatter
54 :
55  public scatterModel
56 {
57  // Private data
58 
59  //- Absorption model dictionary
60  dictionary coeffsDict_;
61 
62  //- Cloud names
63  wordList cloudNames_;
64 
65 
66 public:
67 
68  //- Runtime type information
69  TypeName("cloudScatter");
70 
71 
72  // Constructors
73 
74  //- Construct from components
76  (
77  const dictionary& dict,
78  const fvMesh& mesh
79  );
80 
81 
82  //- Destructor
83  virtual ~cloudScatter();
84 
85 
86  // Member Operators
87 
88  // Access
89 
90  //- Return scatter coefficient
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace radiation
98 } // End namespace Foam
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 #endif
103 
104 // ************************************************************************* //
Foam::radiation::cloudScatter::TypeName
TypeName("cloudScatter")
Runtime type information.
scatterModel.H
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::radiation::cloudScatter::cloudScatter
cloudScatter(const dictionary &dict, const fvMesh &mesh)
Construct from components.
Definition: cloudScatter.C:53
Foam::radiation::cloudScatter::~cloudScatter
virtual ~cloudScatter()
Destructor.
Definition: cloudScatter.C:66
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:123
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::radiation::scatterModel
Base class for radiation scattering.
Definition: scatterModel.H:52
Foam::List< word >
Foam::radiation::cloudScatter
Cloud radiation scatter model.
Definition: cloudScatter.H:52
Foam::radiation::cloudScatter::sigmaEff
tmp< volScalarField > sigmaEff() const
Return scatter coefficient.
Definition: cloudScatter.C:73