src/lagrangian/intermediate/submodels/addOns/radiation/scatter/cloudScatter/cloudScatter.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::cloudScatter
  27
  28 Description
  29     Cloud radiation scatter model
  30
  31 SourceFiles
  32     scatterModel.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef radiationCloudScatter_H
  37 #define radiationCloudScatter_H
  38
  39 #include "scatterModel.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace radiation
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                          Class cloudScatter Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class cloudScatter
  53 :
  54     public scatterModel
  55 {
  56     // Private data
  57
  58         //- Absorption model dictionary
  59         dictionary coeffsDict_;
  60
  61         //- Cloud names
  62         wordList cloudNames_;
  63
  64
  65 public:
  66
  67     //- Runtime type information
  68     TypeName("cloudScatter");
  69
  70
  71     // Constructors
  72
  73         //- Construct from components
  74         cloudScatter
  75         (
  76             const dictionary& dict,
  77             const fvMesh& mesh
  78         );
  79
  80
  81     // Destructor
  82     virtual ~cloudScatter();
  83
  84
  85     // Member Operators
  86
  87         // Access
  88
  89             //- Return scatter coefficient
  90             tmp<volScalarField> sigmaEff() const;
  91 };
  92
  93
  94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  95
  96 } // End namespace radiation
  97 } // End namespace Foam
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 #endif
 102
 103 // ************************************************************************* //