consumptionSpeed.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2020 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::consumptionSpeed
26 
27 Description
28  Correlation function for laminar consumption speed obtained from flamelet
29  solution at increasing strain rates.
30 
31 SourceFiles
32  consumptionSpeed.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef consumptionSpeed_H
37 #define consumptionSpeed_H
38 
39 #include "IOdictionary.H"
40 #include "volFields.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class consumptionSpeed Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class consumptionSpeed
52 {
53  // Private Data
54 
55  //- Maximum consumption speed
56  scalar omega0_;
57 
58  //- Exponential factor
59  scalar eta_;
60 
61  //- Extinction strain
62  scalar sigmaExt_;
63 
64  //- Minimum consumption speed
65  scalar omegaMin_;
66 
67 
68  // Private Member Functions
69 
70  //- Return consumption rate
71  scalar omega0Sigma(scalar sigma, scalar a) const;
72 
73 
74 public:
75 
76  //- Runtime type information
77  TypeName("consumptionSpeed");
78 
79 
80  // Constructors
81 
82  //- Construct from dictionary
84 
85  //- Disallow default bitwise copy construction
86  consumptionSpeed(const consumptionSpeed&) = delete;
87 
88 
89  //- Destructor
90  virtual ~consumptionSpeed();
91 
92 
93  // Member Functions
94 
95  //- Return speed consumption rate temp
96  tmp<volScalarField> omega0Sigma(const volScalarField& sigma);
97 
98 
99  // Access functions
101  scalar omega0() const
102  {
103  return omega0_;
104  }
106  scalar eta() const
107  {
108  return eta_;
109  }
111  scalar sigmaExt() const
112  {
113  return sigmaExt_;
114  }
116  scalar omegaMin() const
117  {
118  return omegaMin_;
119  }
120 
121 
122  // IO
123 
124  //- Update properties
125  void read(const dictionary& dict);
126 
127 
128  // Member Operators
129 
130  //- Disallow default bitwise assignment
131  void operator=(const consumptionSpeed&) = delete;
132 };
133 
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 } // End namespace Foam
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 #endif
142 
143 // ************************************************************************* //
Correlation function for laminar consumption speed obtained from flamelet solution at increasing stra...
void operator=(const consumptionSpeed &)=delete
Disallow default bitwise assignment.
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
void read(const dictionary &dict)
Update properties.
consumptionSpeed(const dictionary &dict)
Construct from dictionary.
const dimensionedScalar sigma
Stefan-Boltzmann constant: default SI units: [W/m^2/K^4].
virtual ~consumptionSpeed()
Destructor.
TypeName("consumptionSpeed")
Runtime type information.
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.