initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / thermophysicalModels / reactionThermo / combustionThermo / mixtureThermos / hPsiMixtureThermo / hPsiMixtureThermo.H
blob64503284478016985773a5cef53b5de87af8d299
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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 the
13     Free Software Foundation; either version 2 of the License, or (at your
14     option) any later version.
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.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::hPsiMixtureThermo
28 Description
29     Foam::hPsiMixtureThermo
31 SourceFiles
32     hPsiMixtureThermo.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef hPsiMixtureThermo_H
37 #define hPsiMixtureThermo_H
39 #include "hCombustionThermo.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
46 /*---------------------------------------------------------------------------*\
47                       Class hPsiMixtureThermo Declaration
48 \*---------------------------------------------------------------------------*/
50 template<class MixtureType>
51 class hPsiMixtureThermo
53     public hCombustionThermo,
54     public MixtureType
56     // Private member functions
58         void calculate();
60         //- Construct as copy (not implemented)
61         hPsiMixtureThermo(const hPsiMixtureThermo<MixtureType>&);
64 public:
66     //- Runtime type information
67     TypeName("hPsiMixtureThermo");
70     // Constructors
72         //- Construct from mesh
73         hPsiMixtureThermo(const fvMesh&);
76     //- Destructor
77     virtual ~hPsiMixtureThermo();
80     // Member functions
82         //- Return the compostion of the multi-component mixture
83         virtual basicMultiComponentMixture& composition()
84         {
85             return *this;
86         }
88         //- Return the compostion of the multi-component mixture
89         virtual const basicMultiComponentMixture& composition() const
90         {
91             return *this;
92         }
94         //- Update properties
95         virtual void correct();
97         //- Sensible enthalpy [J/kg]
98         virtual tmp<volScalarField> hs() const;
100         //- Chemical enthalpy [J/kg]
101         virtual tmp<volScalarField> hc() const;
104         // Fields derived from thermodynamic state variables
106             //- Enthalpy for cell-set [J/kg]
107             virtual tmp<scalarField> h
108             (
109                 const scalarField& T,
110                 const labelList& cells
111             ) const;
113             //- Enthalpy for patch [J/kg]
114             virtual tmp<scalarField> h
115             (
116                 const scalarField& T,
117                 const label patchi
118             ) const;
120             //- Heat capacity at constant pressure for patch [J/kg/K]
121             virtual tmp<scalarField> Cp
122             (
123                 const scalarField& T,
124                 const label patchi
125             ) const;
127             //- Heat capacity at constant pressure [J/kg/K]
128             virtual tmp<volScalarField> Cp() const;
131         //- Read thermophysicalProperties dictionary
132         virtual bool read();
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 } // End namespace Foam
140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142 #ifdef NoRepository
143 #   include "hPsiMixtureThermo.C"
144 #endif
146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
148 #endif
150 // ************************************************************************* //