FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

constantScatter.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::radiation::constantScatter
00026 
00027 Description
00028     Constant radiation scatter coefficient
00029 
00030 SourceFiles
00031     scatterModel.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef radiationConstantScatter_H
00036 #define radiationConstantScatter_H
00037 
00038 #include <radiation/scatterModel.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 namespace radiation
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class constantScatter Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class constantScatter
00052 :
00053     public scatterModel
00054 {
00055 
00056     // Private data
00057 
00058         //- Coefficients dictionary
00059         dictionary coeffsDict_;
00060 
00061         //- Scattering coefficient / [1/m]
00062         dimensionedScalar sigma_;
00063 
00064         //- Linear-anisotropic phase function coefficient / []
00065         //  -1 < C < 1
00066         //  - = backward scattering
00067         //  0 = isotropic scattering (reasonable default value)
00068         //  + = forward scattering
00069         dimensionedScalar C_;
00070 
00071 
00072 public:
00073 
00074     //- Runtime type information
00075     TypeName("constantScatter");
00076 
00077 
00078     // Constructors
00079 
00080         //- Construct from components
00081         constantScatter
00082         (
00083             const dictionary& dict,
00084             const fvMesh& mesh
00085         );
00086 
00087 
00088     // Destructor
00089 
00090         ~constantScatter();
00091 
00092 
00093     // Member Operators
00094 
00095         // Edit
00096 
00097         // Access
00098 
00099             //- Return scatter coefficient
00100             tmp<volScalarField> sigmaEff() const;
00101 };
00102 
00103 
00104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00105 
00106 } // End namespace radiation
00107 } // End namespace Foam
00108 
00109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00110 
00111 #endif
00112 
00113 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines