KTS.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::XiGModels::KTS
26 
27 Description
28  Simple Kolmogorov time-scale (KTS) model for the flame-wrinling generation
29  rate.
30 
31 SourceFiles
32  KTS.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef KTS_H
37 #define KTS_H
38 
39 #include "XiGModel.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace XiGModels
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class KTS Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class KTS
53 :
54  public XiGModel
55 {
56  // Private data
57 
58  scalar GEtaCoef_;
59 
60 
61  // Private Member Functions
62 
63  //- Disallow copy construct
64  KTS(const KTS&);
65 
66  //- Disallow default bitwise assignment
67  void operator=(const KTS&);
68 
69 
70 public:
71 
72  //- Runtime type information
73  TypeName("KTS");
74 
75 
76  // Constructors
77 
78  //- Construct from components
79  KTS
80  (
81  const dictionary& XiGProperties,
84  const volScalarField& Su
85  );
86 
87 
88  //- Destructor
89  virtual ~KTS();
90 
91 
92  // Member Functions
93 
94  //- Return the flame-wrinking generation rate
95  virtual tmp<volScalarField> G() const;
96 
97  //- Update properties from given dictionary
98  virtual bool read(const dictionary& XiGProperties);
99 };
100 
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 } // End namespace XiGModels
105 } // End namespace Foam
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
Foam::psiuReactionThermo.
virtual tmp< volScalarField > G() const
Return the flame-wrinking generation rate.
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.
tmp< GeometricField< Type, fvPatchField, volMesh > > Su(const GeometricField< Type, fvPatchField, volMesh > &su, const GeometricField< Type, fvPatchField, volMesh > &vf)
Definition: fvcSup.C:44
TypeName("KTS")
Runtime type information.
Base-class for all Xi generation models used by the b-Xi combustion model. See Technical Report SH/RE...
Definition: XiGModel.H:54
virtual ~KTS()
Destructor.
Simple Kolmogorov time-scale (KTS) model for the flame-wrinling generation rate.
Definition: KTS.H:51
Basic thermodynamics type based on the use of fitting functions for cp, h, s obtained from the templa...
A class for managing temporary objects.
Definition: PtrList.H:118
virtual bool read(const dictionary &XiGProperties)
Update properties from given dictionary.