thermoCloud.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) 2011 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::thermoCloud
26 
27 Description
28  Virtual abstract base class for templated ThermoCloud
29 
30 SourceFiles
31  thermoCloud.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef thermoCloud_H
36 #define thermoCloud_H
37 
38 #include "volFields.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class thermoCloud Declaration
47 \*---------------------------------------------------------------------------*/
48 
49 class thermoCloud
50 {
51  // Private Member Functions
52 
53  //- Disallow default bitwise copy construct
54  thermoCloud(const thermoCloud&);
55 
56  //- Disallow default bitwise assignment
57  void operator=(const thermoCloud&);
58 
59 
60 public:
61 
62  //- Runtime type information
63  TypeName("thermoCloud");
64 
65  // Constructors
66 
67  //- Null constructor
68  thermoCloud();
69 
70 
71  //- Destructor
72  virtual ~thermoCloud();
73 
74 
75  // Member Functions
76 
77  // Access
78 
79  // Radiation
80 
81  //- Return tmp equivalent particulate emission
82  virtual tmp<volScalarField> Ep() const = 0;
83 
84  //- Return tmp equivalent particulate absorption
85  virtual tmp<volScalarField> ap() const = 0;
86 
87  //- Return tmp equivalent particulate scattering factor
88  virtual tmp<volScalarField> sigmap() const = 0;
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
virtual tmp< volScalarField > sigmap() const =0
Return tmp equivalent particulate scattering factor.
TypeName("thermoCloud")
Runtime type information.
thermoCloud()
Null constructor.
Definition: thermoCloud.C:38
virtual ~thermoCloud()
Destructor.
Definition: thermoCloud.C:44
virtual tmp< volScalarField > Ep() const =0
Return tmp equivalent particulate emission.
Namespace for OpenFOAM.
Virtual abstract base class for templated ThermoCloud.
Definition: thermoCloud.H:48
virtual tmp< volScalarField > ap() const =0
Return tmp equivalent particulate absorption.
A class for managing temporary objects.
Definition: PtrList.H:118