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

SCOPEXiEq.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::XiEqModel::SCOPEXiEq
00026 
00027 Description
00028     Simple SCOPEXiEq model for XiEq based on SCOPEXiEqs correlation
00029     with a linear correction function to give a plausible profile for XiEq.
00030     See \link SCOPELaminarFlameSpeed.H \endlink for details on the SCOPE laminar
00031     flame speed model.
00032 
00033 SourceFiles
00034     SCOPEXiEq.C
00035 
00036 \*---------------------------------------------------------------------------*/
00037 
00038 #ifndef SCOPEXiEq_H
00039 #define SCOPEXiEq_H
00040 
00041 #include "../XiEqModel/XiEqModel.H"
00042 #include "../../../laminarFlameSpeed/SCOPE/SCOPELaminarFlameSpeed.H"
00043 
00044 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00045 
00046 namespace Foam
00047 {
00048 namespace XiEqModels
00049 {
00050 
00051 /*---------------------------------------------------------------------------*\
00052                           Class SCOPEXiEq Declaration
00053 \*---------------------------------------------------------------------------*/
00054 
00055 class SCOPEXiEq
00056 :
00057     public XiEqModel
00058 {
00059     // Private data
00060 
00061         scalar XiEqCoef;
00062         scalar XiEqExp;
00063         scalar lCoef;
00064         dimensionedScalar SuMin;
00065 
00066         //- The SCOPE laminar flame speed model used to obtain the
00067         //  Marstein number.  Note: the laminar flame speed need not be
00068         //  obtained form the same model.
00069         laminarFlameSpeedModels::SCOPE MaModel;
00070 
00071 
00072     // Private Member Functions
00073 
00074         //- Disallow copy construct
00075         SCOPEXiEq(const SCOPEXiEq&);
00076 
00077         //- Disallow default bitwise assignment
00078         void operator=(const SCOPEXiEq&);
00079 
00080 
00081 public:
00082 
00083     //- Runtime type information
00084     TypeName("SCOPEXiEq");
00085 
00086 
00087     // Constructors
00088 
00089         //- Construct from components
00090         SCOPEXiEq
00091         (
00092             const dictionary& XiEqProperties,
00093             const hhuCombustionThermo& thermo,
00094             const compressible::RASModel& turbulence,
00095             const volScalarField& Su
00096         );
00097 
00098 
00099     // Destructor
00100 
00101         virtual ~SCOPEXiEq();
00102 
00103 
00104     // Member Functions
00105 
00106         //- Return the flame-wrinking XiEq
00107         virtual tmp<volScalarField> XiEq() const;
00108 
00109         //- Update properties from given dictionary
00110         virtual bool read(const dictionary& XiEqProperties);
00111 };
00112 
00113 
00114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00115 
00116 } // End namespace XiEqModels
00117 } // End namespace Foam
00118 
00119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00120 
00121 #endif
00122 
00123 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines