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