rhoChemistryModel.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-2015 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::rhoChemistryModel
26 
27 Description
28  Chemistry model for density-based thermodynamics
29 
30 SourceFiles
31  rhoChemistryModelI.H
32  rhoChemistryModel.C
33  newChemistryModel.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef rhoChemistryModel_H
38 #define rhoChemistryModel_H
39 
40 #include "basicChemistryModel.H"
41 #include "autoPtr.H"
42 #include "runTimeSelectionTables.H"
43 #include "rhoReactionThermo.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 // Forward declaration of classes
51 class fvMesh;
52 
53 /*---------------------------------------------------------------------------*\
54  class rhoChemistryModel 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 rhoChemistryModel&);
68 
69 
70 protected:
71 
72  // Protected data
73 
74  //- Thermo package
76 
77 
78 public:
79 
80  //- Runtime type information
81  TypeName("rho");
82 
83 
84  //- Declare run-time constructor selection tables
86  (
87  autoPtr,
89  fvMesh,
90  (const fvMesh& mesh, const word& phaseName),
91  (mesh, phaseName)
92  );
93 
94 
95  // Constructors
96 
97  //- Construct from mesh and phase name
98  rhoChemistryModel(const fvMesh& mesh, const word& phaseName);
99 
100 
101  //- Selector
103  (
104  const fvMesh& mesh,
105  const word& phaseName=word::null
106  );
107 
108 
109  //- Destructor
110  virtual ~rhoChemistryModel();
111 
112 
113  // Member Functions
114 
115  //- Return access to the thermo package
116  inline rhoReactionThermo& thermo();
117 
118  //- Return const access to the thermo package
119  inline const rhoReactionThermo& thermo() const;
120 };
121 
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 } // End namespace Foam
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 #include "rhoChemistryModelI.H"
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************************************************************* //
autoPtr< rhoReactionThermo > thermo_
Thermo package.
declareRunTimeSelectionTable(autoPtr, rhoChemistryModel, fvMesh,(const fvMesh &mesh, const word &phaseName),(mesh, phaseName))
Declare run-time constructor selection tables.
TypeName("rho")
Runtime type information.
A class for handling words, derived from string.
Definition: word.H:59
Foam::rhoReactionThermo.
const fvMesh & mesh() const
Return const access to the mesh database.
static const word null
An empty word.
Definition: word.H:77
static autoPtr< rhoChemistryModel > New(const fvMesh &mesh, const word &phaseName=word::null)
Selector.
virtual ~rhoChemistryModel()
Destructor.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
Macros to ease declaration of run-time selection tables.
rhoReactionThermo & thermo()
Return access to the thermo package.
Namespace for OpenFOAM.
Base class for chemistry models.
Chemistry model for density-based thermodynamics.