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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2012 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::XiGModels::KTS
28
29Description
30 Simple Kolmogorov time-scale (KTS) model for the flame-wrinling generation
31 rate.
32
33SourceFiles
34 KTS.C
35
36\*---------------------------------------------------------------------------*/
37
38#ifndef KTS_H
39#define KTS_H
40
41#include "XiGModel.H"
42
43// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45namespace Foam
46{
47namespace XiGModels
48{
49
50/*---------------------------------------------------------------------------*\
51 Class KTS Declaration
52\*---------------------------------------------------------------------------*/
54class KTS
55:
56 public XiGModel
57{
58 // Private data
59
60 scalar GEtaCoef_;
61
62
63 // Private Member Functions
64
65 //- No copy construct
66 KTS(const KTS&) = delete;
67
68 //- No copy assignment
69 void operator=(const KTS&) = delete;
70
71
72public:
73
74 //- Runtime type information
75 TypeName("KTS");
76
77
78 // Constructors
79
80 //- Construct from components
81 KTS
82 (
83 const dictionary& XiGProperties,
85 const compressible::RASModel& turbulence,
86 const volScalarField& Su
87 );
88
89
90 //- Destructor
91 virtual ~KTS();
92
93
94 // Member Functions
95
96 //- Return the flame-wrinkling generation rate
97 virtual tmp<volScalarField> G() const;
98
99 //- Update properties from given dictionary
100 virtual bool read(const dictionary& XiGProperties);
101};
102
103
104// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105
106} // End namespace XiGModels
107} // End namespace Foam
108
109// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110
111#endif
112
113// ************************************************************************* //
Base-class for all Xi generation models used by the b-Xi combustion model. See Technical Report SH/RE...
Definition: XiGModel.H:57
Simple Kolmogorov time-scale (KTS) model for the flame-wrinling generation rate.
Definition: KTS.H:56
virtual ~KTS()
Destructor.
virtual bool read(const dictionary &XiGProperties)
Update properties from given dictionary.
virtual tmp< volScalarField > G() const
Return the flame-wrinkling generation rate.
KTS(const dictionary &XiGProperties, const psiuReactionThermo &thermo, const compressible::RASModel &turbulence, const volScalarField &Su)
Construct from components.
TypeName("KTS")
Runtime type information.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Foam::psiuReactionThermo.
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: tmp.H:65
zeroField Su
Definition: alphaSuSp.H:1
RASModel< EddyDiffusivity< turbulenceModel > > RASModel
Namespace for OpenFOAM.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73