psiCombustionModel.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) 2011-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::psiCombustionModel
26 
27 Description
28  Combustion models for compressibility-based thermodynamics
29 
30 SourceFiles
31  psiCombustionModelI.H
32  psiCombustionModel.C
33  psiCombustionModelNew.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef psiCombustionModel_H
38 #define psiCombustionModel_H
39 
40 #include "combustionModel.H"
41 #include "autoPtr.H"
42 #include "runTimeSelectionTables.H"
43 #include "psiReactionThermo.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 namespace combustionModels
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  class psiCombustionModel Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 :
58  public combustionModel
59 {
60  // Private Member Functions
61 
62  //- Construct as copy (not implemented)
64 
65  //- Disallow default bitwise assignment
66  void operator=(const psiCombustionModel&);
67 
68 
69 public:
70 
72 
73 
74  //- Runtime type information
75  TypeName("psiCombustionModel");
76 
77 
78  //- Declare run-time constructor selection tables
80  (
81  autoPtr,
83  dictionary,
84  (
85  const word& modelType,
86  const fvMesh& mesh,
87  const word& combustionProperties,
88  const word& phaseName
89  ),
90  (modelType, mesh, combustionProperties, phaseName)
91  );
92 
93 
94  // Constructors
95 
96  //- Construct from components
98  (
99  const word& modelType,
100  const fvMesh& mesh,
101  const word& combustionProperties,
102  const word& phaseName
103  );
104 
105 
106  //- Selector
108  (
109  const fvMesh& mesh,
110  const word& combustionProperties=combustionPropertiesName,
111  const word& phaseName=word::null
112  );
113 
114 
115  //- Destructor
116  virtual ~psiCombustionModel();
117 
118 
119  // Member Functions
120 
121  //- Return access to the thermo package
122  virtual psiReactionThermo& thermo() = 0;
123 
124  //- Return const access to the thermo package
125  virtual const psiReactionThermo& thermo() const = 0;
126 
127 
128  // IO
129 
130  //- Update properties from given dictionary
131  virtual bool read();
132 };
133 
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 } // End namespace combustionModels
138 } // End namespace Foam
139 
140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
141 
142 #endif
143 
144 // ************************************************************************* //
virtual bool read()
Update properties from given dictionary.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const fvMesh & mesh() const
Return const access to the mesh database.
A class for handling words, derived from string.
Definition: word.H:59
static const word null
An empty word.
Definition: word.H:77
Foam::psiReactionThermo.
Base class for combustion models.
TypeName("psiCombustionModel")
Runtime type information.
declareRunTimeSelectionTable(autoPtr, psiCombustionModel, dictionary,(const word &modelType, const fvMesh &mesh, const word &combustionProperties, const word &phaseName),(modelType, mesh, combustionProperties, phaseName))
Declare run-time constructor selection tables.
static autoPtr< psiCombustionModel > New(const fvMesh &mesh, const word &combustionProperties=combustionPropertiesName, const word &phaseName=word::null)
Selector.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
virtual psiReactionThermo & thermo()=0
Return access to the thermo package.
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.
Namespace for OpenFOAM.
static const word combustionPropertiesName
Default combustionProperties dictionary name.