KTS.H 2.82 KB
Newer Older
1
2
3
4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
Henry's avatar
Henry committed
5
    \\  /    A nd           | Copyright (C) 2011-2012 OpenFOAM Foundation
6
7
8
9
10
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

11
12
13
14
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
15
16
17
18
19
20
21

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    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
sergio's avatar
sergio committed
25
    Foam::XiGModels::KTS
26
27

Description
sergio's avatar
sergio committed
28
29
    Simple Kolmogorov time-scale (KTS) model for the flame-wrinling generation
    rate.
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

SourceFiles
    KTS.C

\*---------------------------------------------------------------------------*/

#ifndef KTS_H
#define KTS_H

#include "XiGModel.H"

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{
namespace XiGModels
{

/*---------------------------------------------------------------------------*\
                          Class KTS Declaration
\*---------------------------------------------------------------------------*/

class KTS
:
    public XiGModel
{
    // Private data

sergio's avatar
sergio committed
58
        scalar GEtaCoef_;
59
60
61
62


    // Private Member Functions

63
64
        //- No copy construct
        KTS(const KTS&) = delete;
65

66
67
        //- No copy assignment
        void operator=(const KTS&) = delete;
68
69
70
71
72
73
74
75
76
77
78
79
80
81


public:

    //- Runtime type information
    TypeName("KTS");


    // Constructors

        //- Construct from components
        KTS
        (
            const dictionary& XiGProperties,
Henry's avatar
Henry committed
82
            const psiuReactionThermo& thermo,
Andrew Heather's avatar
Andrew Heather committed
83
            const compressible::RASModel& turbulence,
84
85
86
87
            const volScalarField& Su
        );


88
    //- Destructor
89
    virtual ~KTS();
90
91
92
93


    // Member Functions

Andrew Heather's avatar
Andrew Heather committed
94
        //- Return the flame-wrinkling generation rate
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
        virtual tmp<volScalarField> G() const;

        //- Update properties from given dictionary
        virtual bool read(const dictionary& XiGProperties);
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace XiGModels
} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#endif

// ************************************************************************* //