FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

scatterModel.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::radiation::scatterModel
00026 
00027 Description
00028     Base class for radiation scattering
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef scatterModel_H
00033 #define scatterModel_H
00034 
00035 #include <OpenFOAM/IOdictionary.H>
00036 #include <OpenFOAM/autoPtr.H>
00037 #include <OpenFOAM/runTimeSelectionTables.H>
00038 #include <finiteVolume/volFields.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 namespace radiation
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class scatterModel Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class scatterModel
00052 {
00053 
00054 protected:
00055 
00056     // Protected data
00057 
00058         //- Reference to the fvMesh
00059         const fvMesh& mesh_;
00060 
00061 public:
00062 
00063     //- Runtime type information
00064     TypeName("scatterModel");
00065 
00066     // Declare runtime constructor selection table
00067 
00068         declareRunTimeSelectionTable
00069         (
00070             autoPtr,
00071             scatterModel,
00072             dictionary,
00073             (
00074                 const dictionary& dict,
00075                 const fvMesh& mesh
00076             ),
00077             (dict, mesh)
00078         );
00079 
00080 
00081     // Constructors
00082 
00083         //- Construct from components
00084         scatterModel
00085         (
00086             const dictionary& dict,
00087             const fvMesh& mesh
00088         );
00089 
00090 
00091     // Selector
00092 
00093         static autoPtr<scatterModel> New
00094         (
00095             const dictionary& dict,
00096             const fvMesh& mesh
00097         );
00098 
00099 
00100     // Destructor
00101 
00102         virtual ~scatterModel();
00103 
00104 
00105     // Member Functions
00106 
00107         // Access
00108 
00109             //- Return scatter coefficient
00110             virtual tmp<volScalarField> sigmaEff() const = 0;
00111 };
00112 
00113 
00114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00115 
00116 } // End namespace radiation
00117 } // End namespace Foam
00118 
00119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00120 
00121 #endif
00122 
00123 // ************************ vim: set sw=4 sts=4 et: ************************ //
00124 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines