reactionRateFlameArea.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::reactionRateFlameArea
26 
27 Description
28  Abstract class for reaction rate per flame area unit
29 
30 SourceFiles
31  reactionRateFlameArea.C
32  reactionRateFlameAreaNew.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef reactionRateFlameArea_H
37 #define reactionRateFlameArea_H
38 
39 #include "runTimeSelectionTables.H"
40 #include "dictionary.H"
41 #include "autoPtr.H"
42 #include "volFields.H"
43 #include "combustionModel.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 class fvMesh;
50 
51 /*---------------------------------------------------------------------------*\
52  Class reactionRateFlameArea Declaration
53 \*---------------------------------------------------------------------------*/
54 
56 {
57 
58 protected:
59 
60  // Protected data
61 
62  //- Dictionary
64 
65  //- Mesh reference
66  const fvMesh& mesh_;
67 
68  //- Combustion model owner
70 
71  //- Fuel name
72  word fuel_;
73 
74  //- Fuel consumption rate per unit of flame area
76 
77 
78 public:
79 
80  //- Runtime type information
81  TypeName("reactionRateFlameArea");
82 
83 
84  // Declare run-time constructor selection table
85 
87  (
88  autoPtr,
90  dictionary,
91  (
92  const word modelType,
93  const dictionary& dict,
94  const fvMesh& mesh,
95  const combustionModel& combModel
96  ),
97  (modelType, dict, mesh, combModel)
98  );
99 
100 
101  // Constructors
102 
103  //- Construct from components
105  (
106  const word& modelType,
107  const dictionary& dict,
108  const fvMesh& mesh,
109  const combustionModel& combModel
110  );
111 
112  //- Disallow default bitwise copy construction
114 
115 
116  // Selector
117 
119  (
120  const dictionary& dict,
121  const fvMesh& mesh,
122  const combustionModel& combModel
123  );
124 
125 
126  // Destructor
127 
128  virtual ~reactionRateFlameArea();
129 
130 
131  // Member Functions
132 
133  //- Access functions
134 
135  //- Return omega
136  const volScalarField& omega() const
137  {
138  return omega_;
139  }
140 
141 
142  //- Correct omega
143  virtual void correct(const volScalarField& sigma) = 0;
144 
145  //- Update from dictionary
146  virtual bool read(const dictionary& dictProperties);
147 
148 
149  // Member Operators
150 
151  //- Disallow default bitwise assignment
152  void operator=(const reactionRateFlameArea&) = delete;
153 };
154 
155 
156 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
157 
158 } // End namespace Foam
159 
160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
161 
162 #endif
163 
164 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
Abstract class for reaction rate per flame area unit.
void operator=(const reactionRateFlameArea &)=delete
Disallow default bitwise assignment.
virtual bool read(const dictionary &dictProperties)
Update from dictionary.
const combustionModel & combModel_
Combustion model owner.
declareRunTimeSelectionTable(autoPtr, reactionRateFlameArea, dictionary,(const word modelType, const dictionary &dict, const fvMesh &mesh, const combustionModel &combModel),(modelType, dict, mesh, combModel))
const dimensionedScalar sigma
Stefan-Boltzmann constant: default SI units: [W/m^2/K^4].
dynamicFvMesh & mesh
A class for handling words, derived from string.
Definition: word.H:59
reactionRateFlameArea(const word &modelType, const dictionary &dict, const fvMesh &mesh, const combustionModel &combModel)
Construct from components.
volScalarField omega_
Fuel consumption rate per unit of flame area.
Base class for combustion models.
dictionary coeffDict_
Dictionary.
const volScalarField & omega() const
Access functions.
virtual void correct(const volScalarField &sigma)=0
Correct omega.
TypeName("reactionRateFlameArea")
Runtime type information.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
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.
const fvMesh & mesh_
Mesh reference.
static autoPtr< reactionRateFlameArea > New(const dictionary &dict, const fvMesh &mesh, const combustionModel &combModel)
Namespace for OpenFOAM.