psiChemistryCombustion.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) 2012-2016 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::psiChemistryCombustion
26 
27 Description
28  Compressibility-based chemistry model wrapper for combustion models
29 
30 SourceFiles
31  psiChemistryCombustion.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef psiChemistryCombustion_H
36 #define psiChemistryCombustion_H
37 
38 #include "autoPtr.H"
39 #include "psiCombustionModel.H"
40 #include "psiChemistryModel.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace combustionModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  class psiChemistryCombustion Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  public psiCombustionModel
56 {
57  // Private Member Functions
58 
59  //- Construct as copy (not implemented)
61 
62  //- Disallow default bitwise assignment
63  void operator=(const psiChemistryCombustion&);
64 
65 
66 protected:
67 
68  // Protected data
69 
70  //- Pointer to chemistry model
72 
73 
74 public:
75 
76  // Constructors
77 
78  //- Construct from components and thermo
80  (
81  const word& modelType,
82  const fvMesh& mesh,
83  const word& combustionProperties,
84  const word& phaseName
85  );
86 
87 
88  //- Destructor
89  virtual ~psiChemistryCombustion();
90 
91 
92  // Member Functions
93 
94  //- Return access to the thermo package
95  virtual psiReactionThermo& thermo();
96 
97  //- Return const access to the thermo package
98  virtual const psiReactionThermo& thermo() const;
99 };
100 
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 } // End namespace combustionModels
105 } // End namespace Foam
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
const fvMesh & mesh() const
Return const access to the mesh database.
A class for handling words, derived from string.
Definition: word.H:59
Foam::psiReactionThermo.
virtual psiReactionThermo & thermo()
Return access to the thermo package.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
autoPtr< psiChemistryModel > chemistryPtr_
Pointer to chemistry model.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Namespace for OpenFOAM.