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-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 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 protected:
62 
63  // Protected data
64 
66 
67  //- Fuel
68  word fuel_;
69 
70  //- Equivalence ratio of a homogeneous mixture
71  scalar equivalenceRatio_;
72 
73 
74 public:
75 
76  //- Runtime type information
77  TypeName("laminarFlameSpeed");
78 
79 
80  // Declare run-time constructor selection table
81 
83  (
84  autoPtr,
86  dictionary,
87  (
88  const dictionary& dict,
89  const psiuReactionThermo& ct
90  ),
91  (dict, ct)
92  );
93 
94 
95  // Constructors
96 
97  //- Construct from dictionary and psiuReactionThermo
99  (
100  const dictionary&,
101  const psiuReactionThermo&
102  );
103 
104  //- Disallow default bitwise copy construction
105  laminarFlameSpeed(const laminarFlameSpeed&) = delete;
106 
107 
108  // Selector
109 
111  (
112  const psiuReactionThermo&
113  );
114 
115 
116  //- Destructor
117  virtual ~laminarFlameSpeed();
118 
119 
120  // Member Operators
121 
122  //- Return the laminar flame speed [m/s]
123  virtual tmp<volScalarField> operator()() const = 0;
124 
125  //- Disallow default bitwise assignment
126  void operator=(const laminarFlameSpeed&) = delete;
127 };
128 
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 } // End namespace Foam
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 #endif
137 
138 // ************************************************************************* //
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:156
scalar equivalenceRatio_
Equivalence ratio of a homogeneous mixture.
laminarFlameSpeed(const dictionary &, const psiuReactionThermo &)
Construct from dictionary and psiuReactionThermo.
A class for handling words, derived from string.
Definition: word.H:59
void operator=(const laminarFlameSpeed &)=delete
Disallow default bitwise assignment.
declareRunTimeSelectionTable(autoPtr, laminarFlameSpeed, dictionary,(const dictionary &dict, const psiuReactionThermo &ct),(dict, ct))
TypeName("laminarFlameSpeed")
Runtime type information.
static autoPtr< laminarFlameSpeed > New(const psiuReactionThermo &)
Base-class for combustion fluid thermodynamic properties based on compressibility.
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.