FreeFOAM The Cross-Platform CFD Toolkit
hReactionThermo.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::hReactionThermo
26 
27 Description
28  Foam::hReactionThermo
29 
30 SourceFiles
31  hReactionThermo.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef hReactionThermo_H
36 #define hReactionThermo_H
37 
40 #include <OpenFOAM/autoPtr.H>
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class hReactionThermo Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public basicRhoThermo
55 {
56 
57 protected:
58 
59  // Protected data
60 
61  //- Enthalpy field
63 
64 
65 public:
66 
67  //- Runtime type information
68  TypeName("hReactionThermo");
69 
70 
71  //- Declare run-time constructor selection tables
73  (
74  autoPtr,
76  fvMesh,
77  (const fvMesh& mesh),
78  (mesh)
79  );
80 
81 
82  // Constructors
83 
84  //- Construct from dictionary and mesh
85  hReactionThermo(const fvMesh&);
86 
87 
88  // Selectors
89 
90  //- Standard selection based on fvMesh
91  static autoPtr<hReactionThermo> New(const fvMesh&);
92 
93  //- Select and check that package contains 'thermoType'
95  (
96  const fvMesh&,
97  const word& thermoType
98  );
99 
100 
101  //- Destructor
102  virtual ~hReactionThermo();
103 
104 
105  // Member functions
106 
107  //- Return the composition of the multi-component mixture
109 
110  //- Return the composition of the multi-component mixture
111  virtual const basicMultiComponentMixture& composition() const = 0;
112 
113 
114  // Access to thermodynamic state variables
115 
116  //- Enthalpy [J/kg]
117  // Non-const access allowed for transport equations
118  virtual volScalarField& h()
119  {
120  return h_;
121  }
122 
123  //- Enthalpy [J/kg]
124  virtual const volScalarField& h() const
125  {
126  return h_;
127  }
128 
129 
130  //- Update properties
131  virtual void correct() = 0;
132 };
133 
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 } // End namespace Foam
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 #endif
142 
143 // ************************ vim: set sw=4 sts=4 et: ************************ //