1 /*---------------------------------------------------------------------------*\
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
5 \\ / A nd | Copyright (C) 1991-2008 OpenCFD Ltd.
7 -------------------------------------------------------------------------------
9 This file is part of OpenFOAM.
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.
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
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
29 Base-class for all Xi generation models used by the b-Xi combustion model.
34 \*---------------------------------------------------------------------------*/
39 #include "IOdictionary.H"
40 #include "hhuCombustionThermo.H"
42 #include "runTimeSelectionTables.H"
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 /*---------------------------------------------------------------------------*\
50 Class XiGModel Declaration
51 \*---------------------------------------------------------------------------*/
60 dictionary XiGModelCoeffs_;
62 const hhuCombustionThermo& thermo_;
63 const compressible::RASModel& turbulence_;
64 const volScalarField& Su_;
69 // Private Member Functions
71 //- Disallow copy construct
72 XiGModel(const XiGModel&);
74 //- Disallow default bitwise assignment
75 void operator=(const XiGModel&);
80 //- Runtime type information
84 // Declare run-time constructor selection table
86 declareRunTimeSelectionTable
92 const dictionary& XiGProperties,
93 const hhuCombustionThermo& thermo,
94 const compressible::RASModel& turbulence,
95 const volScalarField& Su
108 //- Return a reference to the selected XiG model
109 static autoPtr<XiGModel> New
111 const dictionary& XiGProperties,
112 const hhuCombustionThermo& thermo,
113 const compressible::RASModel& turbulence,
114 const volScalarField& Su
120 //- Construct from components
123 const dictionary& XiGProperties,
124 const hhuCombustionThermo& thermo,
125 const compressible::RASModel& turbulence,
126 const volScalarField& Su
137 //- Return the flame-wrinking genration rate
138 virtual tmp<volScalarField> G() const = 0;
140 //- Return the flame diffusivity
141 virtual tmp<volScalarField> Db() const
143 return turbulence_.muEff();
146 //- Update properties from given dictionary
147 virtual bool read(const dictionary& XiGProperties) = 0;
151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
153 } // End namespace Foam
155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
159 // ************************************************************************* //