All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ChemistryCombustion.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) 2012-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::ChemistryCombustion
26 
27 Description
28  Chemistry model wrapper for combustion models
29 
30 SourceFiles
31  ChemistryCombustion.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef ChemistryCombustion_H
36 #define ChemistryCombustion_H
37 
38 #include "autoPtr.H"
39 #include "CombustionModel.H"
40 #include "BasicChemistryModel.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  class ChemistryCombustion Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class ReactionThermo>
53 :
54  public CombustionModel<ReactionThermo>
55 {
56 protected:
57 
58  // Protected data
59 
60  //- Pointer to chemistry model
62 
63 
64 public:
65 
66  // Constructors
67 
68  //- Construct from components and thermo
70  (
71  const word& modelType,
72  const ReactionThermo& thermo,
74  const word& combustionProperties
75  );
76 
77 
78  //- Destructor
79  virtual ~ChemistryCombustion();
80 
81 
82  // Member Functions
83 
84  //- Return const access to the thermo package
85  virtual const ReactionThermo& thermo() const;
86 };
87 
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #ifdef NoRepository
96  #include "ChemistryCombustion.C"
97 #endif
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************************************************************* //
autoPtr< BasicChemistryModel< ReactionThermo > > chemistryPtr_
Pointer to chemistry model.
virtual const ReactionThermo & thermo() const
Return const access to the thermo package.
ChemistryCombustion(const word &modelType, const ReactionThermo &thermo, const compressibleMomentumTransportModel &turb, const word &combustionProperties)
Construct from components and thermo.
A class for handling words, derived from string.
Definition: word.H:59
Chemistry model wrapper for combustion models.
virtual ~ChemistryCombustion()
Destructor.
Combustion models for templated thermodynamics.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Abstract base class for turbulence models (RAS, LES and laminar).
Namespace for OpenFOAM.