src/thermophysicalModels/radiation/radiationModel/radiationModel/radiationModel.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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 Namespace
  26     Foam::radiation
  27
  28 Description
  29     Namespace for radiation modelling
  30
  31
  32 Class
  33     Foam::radiation::radiationModel
  34
  35 Description
  36     Top level model for radiation modelling
  37
  38 SourceFiles
  39     radiationModel.C
  40
  41 \*---------------------------------------------------------------------------*/
  42
  43 #ifndef radiationModel_H
  44 #define radiationModel_H
  45
  46 #include "IOdictionary.H"
  47 #include "autoPtr.H"
  48 #include "runTimeSelectionTables.H"
  49 #include "volFields.H"
  50 #include "basicThermo.H"
  51 #include "fvMatrices.H"
  52
  53 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  54
  55 namespace Foam
  56 {
  57 namespace radiation
  58 {
  59
  60 class absorptionEmissionModel;
  61 class scatterModel;
  62
  63 /*---------------------------------------------------------------------------*\
  64                            Class radiationModel Declaration
  65 \*---------------------------------------------------------------------------*/
  66
  67 class radiationModel
  68 :
  69     public IOdictionary
  70 {
  71
  72 protected:
  73
  74     // Protected data
  75
  76         //- Reference to the temperature field
  77         const volScalarField& T_;
  78
  79         //- Reference to the mesh
  80         const fvMesh& mesh_;
  81
  82         //- Model specific dictionary input parameters
  83         Switch radiation_;
  84
  85         //- Radiation model dictionary
  86         dictionary radiationModelCoeffs_;
  87
  88
  89         // References to the radiation sub-models
  90
  91             //- Absorption/emission model
  92             autoPtr<absorptionEmissionModel> absorptionEmission_;
  93
  94             //- Scatter model
  95             autoPtr<scatterModel> scatter_;
  96
  97
  98 private:
  99
 100     // Private Member Functions
 101
 102         //- Disallow default bitwise copy construct
 103         radiationModel(const radiationModel&);
 104
 105         //- Disallow default bitwise assignment
 106         void operator=(const radiationModel&);
 107
 108
 109 public:
 110
 111     //- Runtime type information
 112     TypeName("radiationModel");
 113
 114
 115     // Declare runtime constructor selection table
 116
 117          declareRunTimeSelectionTable
 118          (
 119              autoPtr,
 120              radiationModel,
 121              dictionary,
 122              (
 123                  const volScalarField& T
 124              ),
 125              (T)
 126          );
 127
 128
 129     // Constructors
 130
 131         //- Construct from components
 132         radiationModel
 133         (
 134             const word& type,
 135             const volScalarField& T
 136         );
 137
 138
 139     // Selectors
 140
 141          //- Return a reference to the selected radiation model
 142          static autoPtr<radiationModel> New
 143          (
 144              const volScalarField& T
 145          );
 146
 147
 148     // Destructor
 149
 150         virtual ~radiationModel();
 151
 152
 153     // Member Functions
 154
 155         // Edit
 156
 157             //- Solve radiation equation(s)
 158             virtual void correct() = 0;
 159
 160             //- Read radiationProperties dictionary
 161             virtual bool read() = 0;
 162
 163
 164         // Access
 165
 166             //- Source term component (for power of T^4)
 167             virtual tmp<volScalarField> Rp() const = 0;
 168
 169             //- Source term component (constant)
 170             virtual tmp<DimensionedField<scalar, volMesh> > Ru() const = 0;
 171
 172             //- Enthalpy source term
 173             virtual tmp<fvScalarMatrix> Sh
 174             (
 175                 basicThermo& thermo
 176             ) const;
 177 };
 178
 179
 180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 181
 182 } // End namespace radiation
 183 } // End namespace Foam
 184
 185 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 186
 187 #endif
 188
 189 // ************************************************************************* //
 190