instabilityXiEq.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) 2011-2012 OpenFOAM Foundation
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::XiEqModels::instability
26 
27 Description
28  This is the equilibrium level of the flame wrinkling generated by
29  instability. It is a constant (default 2.5). It is used in
30  @link XiModel.H @endlink.
31 
32 SourceFiles
33  instability.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef instability_H
38 #define instability_H
39 
40 #include "XiEqModel.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace XiEqModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class instability Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class instability
54 :
55  public XiEqModel
56 {
57  // Private data
58 
59  //- Equilibrium Xi due to instability only
60  scalar XiEqIn;
61 
62  //- Equilibrium Xi model due to all other effects
63  autoPtr<XiEqModel> XiEqModel_;
64 
65 
66  // Private Member Functions
67 
68  //- Disallow copy construct
69  instability(const instability&);
70 
71  //- Disallow default bitwise assignment
72  void operator=(const instability&);
73 
74 
75 public:
76 
77  //- Runtime type information
78  TypeName("instability");
79 
80 
81  // Constructors
82 
83  //- Construct from components
85  (
86  const dictionary& XiEqProperties,
89  const volScalarField& Su
90  );
91 
92 
93  //- Destructor
94  virtual ~instability();
95 
96 
97  // Member Functions
98 
99  //- Return the flame-wrinking XiEq
100  virtual tmp<volScalarField> XiEq() const;
101 
102  //- Update properties from given dictionary
103  virtual bool read(const dictionary& XiEqProperties);
104 
105 };
106 
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 } // End namespace XiEqModels
111 } // End namespace Foam
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 #endif
116 
117 // ************************************************************************* //
Foam::psiuReactionThermo.
This is the equilibrium level of the flame wrinkling generated by instability. It is a constant (defa...
virtual ~instability()
Destructor.
TypeName("instability")
Runtime type information.
virtual bool read(const dictionary &XiEqProperties)
Update properties from given dictionary.
autoPtr< compressible::turbulenceModel > turbulence
Definition: createFields.H:23
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
RASModel< EddyDiffusivity< turbulenceModel > > RASModel
Namespace for OpenFOAM.
virtual tmp< volScalarField > XiEq() const
Return the flame-wrinking XiEq.
tmp< GeometricField< Type, fvPatchField, volMesh > > Su(const GeometricField< Type, fvPatchField, volMesh > &su, const GeometricField< Type, fvPatchField, volMesh > &vf)
Definition: fvcSup.C:44
Base-class for all XiEq models used by the b-XiEq combustion model. The available models are : basicX...
Definition: XiEqModel.H:57
Basic thermodynamics type based on the use of fitting functions for cp, h, s obtained from the templa...
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
A class for managing temporary objects.
Definition: PtrList.H:118