The open source CFD toolbox
consumptionSpeed.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-2015 OpenFOAM Foundation
9-------------------------------------------------------------------------------
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
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::reactionRateFlameAreaModels::consumptionSpeed
28
29Description
30 Correlation function for laminar consumption speed obtained from flamelet
31 solution at increasing strain rates.
32
33SourceFiles
34 consumptionSpeed.C
35
36\*---------------------------------------------------------------------------*/
37
38#ifndef consumptionSpeed_H
39#define consumptionSpeed_H
40
41#include "IOdictionary.H"
42#include "volFields.H"
43// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45namespace Foam
46{
47
48/*---------------------------------------------------------------------------*\
49 Class consumptionSpeed Declaration
50\*---------------------------------------------------------------------------*/
53{
54 // Private Data
55
56 //- Maximum consumption speed
57 scalar omega0_;
58
59 //- Exponential factor
60 scalar eta_;
61
62 //- Extinction strain
63 scalar sigmaExt_;
64
65 //- Minimum consumption speed
66 scalar omegaMin_;
67
68
69 // Private member functions
70
71 //- Return consumption rate
72 scalar omega0Sigma(scalar sigma, scalar a) const;
73
74 //- No copy construct
75 consumptionSpeed(const consumptionSpeed&) = delete;
76
77 //- No copy assignment
78 void operator=(const consumptionSpeed&) = delete;
79
80
81public:
82
83 //- Runtime type information
84 TypeName("consumptionSpeed");
85
86
87 // Constructors
88
89 //- Construct from dictionary
91
92
93 //- Destructor
94 virtual ~consumptionSpeed();
95
96
97 // Member functions
98
99 //- Return speed consumption rate temp
100 tmp<volScalarField> omega0Sigma(const volScalarField& sigma);
101
102
103 // Access functions
105 scalar omega0() const
106 {
107 return omega0_;
108 }
110 scalar eta() const
111 {
112 return eta_;
113 }
115 scalar sigmaExt() const
116 {
117 return sigmaExt_;
118 }
120 scalar omegaMin() const
121 {
122 return omegaMin_;
123 }
124
125
126 // IO
127
128 //- Update properties
130};
131
132
133// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134
135} // End namespace Foam
136
137// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138
139#endif
140
141// ************************************************************************* //
Update properties.
TypeName("consumptionSpeed")
Runtime type information.
virtual ~consumptionSpeed()
Destructor.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
A class for managing temporary objects.
Definition: tmp.H:65
Namespace for OpenFOAM.
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73