initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / applications / solvers / combustion / PDRFoam / XiModels / XiGModels / instabilityG / instabilityG.H
blobab01b3a8e030e518790a03d9195fdfe653231d3f
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.
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
19     for more details.
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
25 Class
26     Foam::XiGModels::instabilityG
28 Description
29     Flame-surface instabilityG flame-wrinking generation rate coefficient model
30     used in \link XiModel.H \endlink.
32     See Technical Report SH/RE/01R for details on the PDR modelling.
34 SourceFiles
35     instabilityG.C
37 \*---------------------------------------------------------------------------*/
39 #ifndef instabilityG_H
40 #define instabilityG_H
42 #include "XiGModel.H"
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 namespace Foam
48 namespace XiGModels
51 /*---------------------------------------------------------------------------*\
52                           Class instabilityG Declaration
53 \*---------------------------------------------------------------------------*/
55 class instabilityG
57     public XiGModel
59     // Private data
61         //- Flame instabilityG wrinling generation rate coefficient
62         dimensionedScalar GIn;
64         //- InstabilityG length-scale
65         dimensionedScalar lambdaIn;
67         //- Xi generation rate model due to all other processes
68         autoPtr<XiGModel> XiGModel_;
71     // Private Member Functions
73         //- Disallow copy construct
74         instabilityG(const instabilityG&);
76         //- Disallow default bitwise assignment
77         void operator=(const instabilityG&);
80 public:
82     //- Runtime type information
83     TypeName("instabilityG");
86     // Constructors
88         //- Construct from components
89         instabilityG
90         (
91             const dictionary& XiGProperties,
92             const hhuCombustionThermo& thermo,
93             const compressible::RASModel& turbulence,
94             const volScalarField& Su
95         );
98     // Destructor
100         virtual ~instabilityG();
103     // Member Functions
105         //- Return the flame-wrinking generation rate
106         virtual tmp<volScalarField> G() const;
108         //- Return the flame diffusivity
109         virtual tmp<volScalarField> Db() const;
111         //- Update properties from given dictionary
112         virtual bool read(const dictionary& XiGProperties);
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 } // End namespace XiGModels
119 } // End namespace Foam
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 #endif
125 // ************************************************************************* //