initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / lagrangian / intermediate / clouds / baseClasses / thermoCloud / thermoCloud.H
blob9eff9c62ee4a3d3d45c57668ef50fb8400229e43
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::thermoCloud
28 Description
29     Virtual abstract base class for templated ThermoCloud
31 SourceFiles
32     thermoCloud.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef thermoCloud_H
37 #define thermoCloud_H
39 #include "volFields.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
46 /*---------------------------------------------------------------------------*\
47                        Class thermoCloud Declaration
48 \*---------------------------------------------------------------------------*/
50 class thermoCloud
52     // Private Member Functions
54         //- Disallow default bitwise copy construct
55         thermoCloud(const thermoCloud&);
57         //- Disallow default bitwise assignment
58         void operator=(const thermoCloud&);
61 public:
63     //- Runtime type information
64     TypeName("thermoCloud");
66     // Constructors
68         //- Null constructor
69         thermoCloud();
72     //- Destructor
73     virtual ~thermoCloud();
76     // Member Functions
78         // Access
80             // Radiation
82                 //- Return tmp equivalent particulate emission
83                 virtual tmp<volScalarField> Ep() const = 0;
85                 //- Return tmp equivalent particulate absorption
86                 virtual tmp<volScalarField> ap() const = 0;
88                 //- Return tmp equivalent particulate scattering factor
89                 virtual tmp<volScalarField> sigmap() const = 0;
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 } // End namespace Foam
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 #endif
101 // ************************************************************************* //