Initial commit for version 2.0.x patch release
[OpenFOAM-2.0.x.git] / src / thermophysicalModels / reactionThermo / combustionThermo / mixtureThermos / hPsiMixtureThermo / hPsiMixtureThermo.H
blobacf3c31fd2cd7a65ddb7d1636a3aa59d00ef4afb
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2004-2010 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
13     the Free Software Foundation, either version 3 of the License, or
14     (at your 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, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::hPsiMixtureThermo
27 Description
28     Foam::hPsiMixtureThermo
30 SourceFiles
31     hPsiMixtureThermo.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef hPsiMixtureThermo_H
36 #define hPsiMixtureThermo_H
38 #include "hCombustionThermo.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 /*---------------------------------------------------------------------------*\
46                       Class hPsiMixtureThermo Declaration
47 \*---------------------------------------------------------------------------*/
49 template<class MixtureType>
50 class hPsiMixtureThermo
52     public hCombustionThermo,
53     public MixtureType
55     // Private Member Functions
57         void calculate();
59         //- Construct as copy (not implemented)
60         hPsiMixtureThermo(const hPsiMixtureThermo<MixtureType>&);
63 public:
65     //- Runtime type information
66     TypeName("hPsiMixtureThermo");
69     // Constructors
71         //- Construct from mesh
72         hPsiMixtureThermo(const fvMesh&);
75     //- Destructor
76     virtual ~hPsiMixtureThermo();
79     // Member functions
81         //- Return the compostion of the multi-component mixture
82         virtual basicMultiComponentMixture& composition()
83         {
84             return *this;
85         }
87         //- Return the compostion of the multi-component mixture
88         virtual const basicMultiComponentMixture& composition() const
89         {
90             return *this;
91         }
93         //- Update properties
94         virtual void correct();
97         // Fields derived from thermodynamic state variables
99             //- Chemical enthalpy [J/kg]
100             virtual tmp<volScalarField> hc() const;
102             //- Enthalpy for cell-set [J/kg]
103             virtual tmp<scalarField> h
104             (
105                 const scalarField& T,
106                 const labelList& cells
107             ) const;
109             //- Enthalpy for patch [J/kg]
110             virtual tmp<scalarField> h
111             (
112                 const scalarField& T,
113                 const label patchi
114             ) const;
116             //- Heat capacity at constant pressure for patch [J/kg/K]
117             virtual tmp<scalarField> Cp
118             (
119                 const scalarField& T,
120                 const label patchi
121             ) const;
123             //- Heat capacity at constant pressure [J/kg/K]
124             virtual tmp<volScalarField> Cp() const;
127         //- Read thermophysicalProperties dictionary
128         virtual bool read();
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 } // End namespace Foam
136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
138 #ifdef NoRepository
139 #   include "hPsiMixtureThermo.C"
140 #endif
142 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 #endif
146 // ************************************************************************* //