cloudScatter.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 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::cloudScatter
26 
27 Description
28  Cloud radiation scatter model
29 
30 SourceFiles
31  scatterModel.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cloudScatter_H
36 #define cloudScatter_H
37 
38 #include "scatterModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace radiation
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class cloudScatter Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class cloudScatter
52 :
53  public scatterModel
54 {
55  // Private data
56 
57  //- Absorption model dictionary
58  dictionary coeffsDict_;
59 
60  //- Cloud names
61  wordList cloudNames_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("cloudScatter");
68 
69 
70  // Constructors
71 
72  //- Construct from components
74  (
75  const dictionary& dict,
76  const fvMesh& mesh
77  );
78 
79 
80  //- Destructor
81  virtual ~cloudScatter();
82 
83 
84  // Member Operators
85 
86  // Access
87 
88  //- Return scatter coefficient
90 };
91 
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 } // End namespace radiation
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #endif
101 
102 // ************************************************************************* //
TypeName("cloudScatter")
Runtime type information.
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual ~cloudScatter()
Destructor.
Definition: cloudScatter.C:64
dynamicFvMesh & mesh
tmp< volScalarField > sigmaEff() const
Return scatter coefficient.
Definition: cloudScatter.C:71
cloudScatter(const dictionary &dict, const fvMesh &mesh)
Construct from components.
Definition: cloudScatter.C:51
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Base class for radiation scattering.
Definition: scatterModel.H:50
A class for managing temporary objects.
Definition: PtrList.H:53
autoPtr< radiation::radiationModel > radiation(radiation::radiationModel::New(T))
Namespace for OpenFOAM.
Cloud radiation scatter model.
Definition: cloudScatter.H:50