src/thermophysicalModels/radiation/submodels/scatterModel/constantScatter/constantScatter.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 Class
  26     Foam::radiation::constantScatter
  27
  28 Description
  29     Constant radiation scatter coefficient
  30
  31 SourceFiles
  32     scatterModel.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef radiationConstantScatter_H
  37 #define radiationConstantScatter_H
  38
  39 #include "scatterModel.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace radiation
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class constantScatter Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class constantScatter
  53 :
  54     public scatterModel
  55 {
  56
  57     // Private data
  58
  59         //- Coefficients dictionary
  60         dictionary coeffsDict_;
  61
  62         //- Scattering coefficient / [1/m]
  63         dimensionedScalar sigma_;
  64
  65         //- Linear-anisotropic phase function coefficient / []
  66         //  -1 < C < 1
  67         //  - = backward scattering
  68         //  0 = isotropic scattering (reasonable default value)
  69         //  + = forward scattering
  70         dimensionedScalar C_;
  71
  72
  73 public:
  74
  75     //- Runtime type information
  76     TypeName("constantScatter");
  77
  78
  79     // Constructors
  80
  81         //- Construct from components
  82         constantScatter
  83         (
  84             const dictionary& dict,
  85             const fvMesh& mesh
  86         );
  87
  88
  89     // Destructor
  90
  91         ~constantScatter();
  92
  93
  94     // Member Operators
  95
  96         // Edit
  97
  98         // Access
  99
 100             //- Return scatter coefficient
 101             tmp<volScalarField> sigmaEff() const;
 102 };
 103
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 } // End namespace radiation
 108 } // End namespace Foam
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 #endif
 113
 114 // ************************************************************************* //