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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
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
26Class
27 Foam::thermoCloud
28
29Description
30 Virtual abstract base class for templated ThermoCloud
31
32SourceFiles
33 thermoCloud.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef thermoCloud_H
38#define thermoCloud_H
39
40#include "volFields.H"
41
42// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44namespace Foam
45{
46
47/*---------------------------------------------------------------------------*\
48 Class thermoCloud Declaration
49\*---------------------------------------------------------------------------*/
51class thermoCloud
52{
53public:
54
55 //- Runtime type information
56 TypeName("thermoCloud");
57
58
59 // Constructors
60
61 //- Null constructor
62 thermoCloud() = default;
63
64
65 //- Destructor
66 virtual ~thermoCloud() = default;
67
68
69 // Member Functions
70
71 // Access
72
73 // Radiation
74
75 //- Return tmp equivalent particulate emission
76 virtual tmp<volScalarField> Ep() const = 0;
77
78 //- Return tmp equivalent particulate absorption
79 virtual tmp<volScalarField> ap() const = 0;
80
81 //- Return tmp equivalent particulate scattering factor
82 virtual tmp<volScalarField> sigmap() const = 0;
83};
84
85
86// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87
88} // End namespace Foam
89
90// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91
92#endif
93
94// ************************************************************************* //
Virtual abstract base class for templated ThermoCloud.
Definition: thermoCloud.H:51
thermoCloud()=default
Null constructor.
virtual tmp< volScalarField > sigmap() const =0
Return tmp equivalent particulate scattering factor.
virtual tmp< volScalarField > Ep() const =0
Return tmp equivalent particulate emission.
virtual tmp< volScalarField > ap() const =0
Return tmp equivalent particulate absorption.
TypeName("thermoCloud")
Runtime type information.
virtual ~thermoCloud()=default
Destructor.
A class for managing temporary objects.
Definition: tmp.H:65
Namespace for OpenFOAM.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73