ThermoCombustion.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::ThermoCombustion
26 
27 Description
28  Thermo model wrapper for combustion models
29 
30 SourceFiles
31  ThermoCombustion.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef ThermoCombustion_H
36 #define ThermoCombustion_H
37 
38 #include "autoPtr.H"
39 #include "CombustionModel.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  class ThermoCombustion Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class ReactionThermo>
51 class ThermoCombustion
52 :
53  public CombustionModel<ReactionThermo>
54 {
55 protected:
56 
57  // Protected data
58 
59  //- Thermo
60  const ReactionThermo& thermo_;
61 
62 
63 public:
64 
65  // Constructors
66 
67  //- Construct from components
69  (
70  const word& modelType,
71  const ReactionThermo& thermo,
73  );
74 
75 
76  //- Destructor
77  virtual ~ThermoCombustion();
78 
79 
80  // Member Functions
81 
82  //- Return const access to the thermo package
83  virtual const ReactionThermo& thermo() const;
84 };
85 
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 } // End namespace Foam
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 #ifdef NoRepository
94  #include "ThermoCombustion.C"
95 #endif
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 #endif
100 
101 // ************************************************************************* //
virtual const ReactionThermo & thermo() const
Return const access to the thermo package.
virtual ~ThermoCombustion()
Destructor.
const ReactionThermo & thermo_
Thermo.
ThermoCombustion(const word &modelType, const ReactionThermo &thermo, const compressibleMomentumTransportModel &turb)
Construct from components.
A class for handling words, derived from string.
Definition: word.H:59
Thermo model wrapper for combustion models.
Combustion models for templated thermodynamics.
Abstract base class for turbulence models (RAS, LES and laminar).
Namespace for OpenFOAM.