FreeFOAM The Cross-Platform CFD Toolkit
laminarFlameSpeed.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 | Copyright (C) 1991-2010 OpenCFD Ltd.
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  newLaminarFlameSpeed.C
40 
41 \*---------------------------------------------------------------------------*/
42 
43 #ifndef laminarFlameSpeed_H
44 #define laminarFlameSpeed_H
45 
47 #include <OpenFOAM/autoPtr.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 hhuCombustionThermo& ct
100  ),
101  (dict, ct)
102  );
103 
104 
105  // Constructors
106 
107  //- Construct from dictionary and hhuCombustionThermo
109  (
110  const dictionary&,
111  const hhuCombustionThermo&
112  );
113 
114 
115  // Selector
116 
118  (
119  const hhuCombustionThermo&
120  );
121 
122 
123  // Destructor
124 
125  virtual ~laminarFlameSpeed();
126 
127 
128  // Member functions
129 
130  //- Return the laminar flame speed [m/s]
131  virtual tmp<volScalarField> operator()() const = 0;
132 };
133 
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 } // End namespace Foam
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 #endif
142 
143 // ************************ vim: set sw=4 sts=4 et: ************************ //