FreeFOAM The Cross-Platform CFD Toolkit
instabilityG.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::XiGModels::instabilityG
26 
27 Description
28  Flame-surface instabilityG flame-wrinking generation rate coefficient model
29  used in \link XiModel.H \endlink.
30 
31  See Technical Report SH/RE/01R for details on the PDR modelling.
32 
33 SourceFiles
34  instabilityG.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef instabilityG_H
39 #define instabilityG_H
40 
41 #include "../XiGModel/XiGModel.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 namespace XiGModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class instabilityG Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
56  public XiGModel
57 {
58  // Private data
59 
60  //- Flame instabilityG wrinling generation rate coefficient
62 
63  //- InstabilityG length-scale
64  dimensionedScalar lambdaIn;
65 
66  //- Xi generation rate model due to all other processes
67  autoPtr<XiGModel> XiGModel_;
68 
69 
70  // Private Member Functions
71 
72  //- Disallow copy construct
73  instabilityG(const instabilityG&);
74 
75  //- Disallow default bitwise assignment
76  void operator=(const instabilityG&);
77 
78 
79 public:
80 
81  //- Runtime type information
82  TypeName("instabilityG");
83 
84 
85  // Constructors
86 
87  //- Construct from components
89  (
90  const dictionary& XiGProperties,
93  const volScalarField& Su
94  );
95 
96 
97  // Destructor
98 
99  virtual ~instabilityG();
100 
101 
102  // Member Functions
103 
104  //- Return the flame-wrinking generation rate
105  virtual tmp<volScalarField> G() const;
106 
107  //- Return the flame diffusivity
108  virtual tmp<volScalarField> Db() const;
109 
110  //- Update properties from given dictionary
111  virtual bool read(const dictionary& XiGProperties);
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace XiGModels
118 } // End namespace Foam
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 #endif
123 
124 // ************************ vim: set sw=4 sts=4 et: ************************ //