FreeFOAM The Cross-Platform CFD Toolkit
psiChemistryModel.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) 2009-2010 OpenCFD Ltd.
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::psiChemistryModel
26 
27 Description
28  Chemistry model for compressibility-based thermodynamics
29 
30 SourceFiles
31  psiChemistryModelI.H
32  psiChemistryModel.C
33  newChemistryModel.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef psiChemistryModel_H
38 #define psiChemistryModel_H
39 
41 #include <OpenFOAM/autoPtr.H>
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 // Forward declaration of classes
51 class fvMesh;
52 
53 /*---------------------------------------------------------------------------*\
54  class psiChemistryModel Declaration
55 \*---------------------------------------------------------------------------*/
56 
58 :
59  public basicChemistryModel
60 {
61  // Private Member Functions
62 
63  //- Construct as copy (not implemented)
65 
66  //- Disallow default bitwise assignment
67  void operator=(const psiChemistryModel&);
68 
69 
70 protected:
71 
72  // Protected data
73 
74  //- Thermo package
76 
77 
78 public:
79 
80  //- Runtime type information
81  TypeName("psiChemistryModel");
82 
83 
84  //- Declare run-time constructor selection tables
86  (
87  autoPtr,
89  fvMesh,
90  (
91  const fvMesh& mesh,
92  const word& compTypeName,
93  const word& thermoTypeName
94  ),
95  (mesh, compTypeName, thermoTypeName)
96  );
97 
98 
99  // Constructors
100 
101  //- Construct from mesh
102  psiChemistryModel(const fvMesh& mesh, const word& thermoTypeName);
103 
104 
105  //- Selector
106  static autoPtr<psiChemistryModel> New(const fvMesh& mesh);
107 
108 
109  //- Destructor
110  virtual ~psiChemistryModel();
111 
112 
113  // Member Functions
114 
115  //- Return access to the thermo package
116  inline hsCombustionThermo& thermo();
117 
118  //- Return const access to the thermo package
119  inline const hsCombustionThermo& thermo() const;
120 };
121 
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 } // End namespace Foam
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 #include "psiChemistryModelI.H"
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************ vim: set sw=4 sts=4 et: ************************ //