All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
laminarFlameSpeed.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-2019 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 Namespace
25  Foam::laminarFlameSpeedModels
26 
27 Description
28  Namespace for laminar flame speed models
29 
30 
31 Class
32  Foam::laminarFlameSpeed
33 
34 Description
35  Abstract class for laminar flame speed
36 
37 SourceFiles
38  laminarFlameSpeed.C
39  laminarFlameSpeedNew.C
40 
41 \*---------------------------------------------------------------------------*/
42 
43 #ifndef laminarFlameSpeed_H
44 #define laminarFlameSpeed_H
45 
46 #include "psiuReactionThermo.H"
47 #include "autoPtr.H"
48 #include "runTimeSelectionTables.H"
49 
50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
51 
52 namespace Foam
53 {
54 
55 /*---------------------------------------------------------------------------*\
56  Class laminarFlameSpeed Declaration
57 \*---------------------------------------------------------------------------*/
58 
60 {
61 
62 protected:
63 
64  // Protected data
65 
67 
68  //- Fuel
69  word fuel_;
70 
71  //- Equivalence ratio of a homogeneous mixture
72  scalar equivalenceRatio_;
73 
74 
75 private:
76 
77  // Private Member Functions
78 
79  //- Construct as copy (not implemented)
81  void operator=(const laminarFlameSpeed&);
82 
83 
84 public:
85 
86  //- Runtime type information
87  TypeName("laminarFlameSpeed");
88 
89 
90  // Declare run-time constructor selection table
91 
93  (
94  autoPtr,
96  dictionary,
97  (
98  const dictionary& dict,
99  const psiuReactionThermo& ct
100  ),
101  (dict, ct)
102  );
103 
104 
105  // Constructors
106 
107  //- Construct from dictionary and psiuReactionThermo
109  (
110  const dictionary&,
111  const psiuReactionThermo&
112  );
113 
114 
115  // Selector
116 
118  (
119  const psiuReactionThermo&
120  );
121 
122 
123  //- Destructor
124  virtual ~laminarFlameSpeed();
125 
126 
127  // Member Functions
128 
129  //- Return the laminar flame speed [m/s]
130  virtual tmp<volScalarField> operator()() const = 0;
131 };
132 
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 } // End namespace Foam
137 
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 
140 #endif
141 
142 // ************************************************************************* //
dictionary dict
virtual tmp< volScalarField > operator()() const =0
Return the laminar flame speed [m/s].
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
scalar equivalenceRatio_
Equivalence ratio of a homogeneous mixture.
A class for handling words, derived from string.
Definition: word.H:59
declareRunTimeSelectionTable(autoPtr, laminarFlameSpeed, dictionary,(const dictionary &dict, const psiuReactionThermo &ct),(dict, ct))
TypeName("laminarFlameSpeed")
Runtime type information.
static autoPtr< laminarFlameSpeed > New(const psiuReactionThermo &)
Foam::psiuReactionThermo.
Abstract class for laminar flame speed.
const psiuReactionThermo & psiuReactionThermo_
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Macros to ease declaration of run-time selection tables.
A class for managing temporary objects.
Definition: PtrList.H:53
virtual ~laminarFlameSpeed()
Destructor.
Namespace for OpenFOAM.