src/thermophysicalModels/radiation/submodels/scatterModel/scatterModel/scatterModel.H

   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.
  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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::radiation::scatterModel
  27
  28 Description
  29     Base class for radiation scattering
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef scatterModel_H
  34 #define scatterModel_H
  35
  36 #include "IOdictionary.H"
  37 #include "autoPtr.H"
  38 #include "runTimeSelectionTables.H"
  39 #include "volFields.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace radiation
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class scatterModel Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class scatterModel
  53 {
  54
  55 protected:
  56
  57     // Protected data
  58
  59         //- Reference to the fvMesh
  60         const fvMesh& mesh_;
  61
  62 public:
  63
  64     //- Runtime type information
  65     TypeName("scatterModel");
  66
  67     // Declare runtime constructor selection table
  68
  69         declareRunTimeSelectionTable
  70         (
  71             autoPtr,
  72             scatterModel,
  73             dictionary,
  74             (
  75                 const dictionary& dict,
  76                 const fvMesh& mesh
  77             ),
  78             (dict, mesh)
  79         );
  80
  81
  82     // Constructors
  83
  84         //- Construct from components
  85         scatterModel
  86         (
  87             const dictionary& dict,
  88             const fvMesh& mesh
  89         );
  90
  91
  92     // Selector
  93
  94         static autoPtr<scatterModel> New
  95         (
  96             const dictionary& dict,
  97             const fvMesh& mesh
  98         );
  99
 100
 101     // Destructor
 102
 103         virtual ~scatterModel();
 104
 105
 106     // Member Functions
 107
 108         // Access
 109
 110             //- Return scatter coefficient
 111             virtual tmp<volScalarField> sigmaEff() const = 0;
 112 };
 113
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 } // End namespace radiation
 118 } // End namespace Foam
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 #endif
 123
 124 // ************************************************************************* //
 125