Forward compatibility: flex
[foam-extend-3.2.git] / src / thermophysicalModels / reactionThermo / combustionThermo / mixtureThermos / hsPsiMixtureThermo / hsPsiMixtureThermo.H
blobffc06a67c71e46485d3702d40ea3c12095606286
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend 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 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::hsPsiMixtureThermo
27 Description
28     Foam::hsPsiMixtureThermo
30 SourceFiles
31     hsPsiMixtureThermo.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef hsPsiMixtureThermo_H
36 #define hsPsiMixtureThermo_H
38 #include "hsCombustionThermo.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 /*---------------------------------------------------------------------------*\
46                    Class hsPsiMixtureThermo Declaration
47 \*---------------------------------------------------------------------------*/
49 template<class MixtureType>
50 class hsPsiMixtureThermo
52     public hsCombustionThermo,
53     public MixtureType
55     // Private member functions
57         void calculate();
59         //- Construct as copy (not implemented)
60         hsPsiMixtureThermo(const hsPsiMixtureThermo<MixtureType>&);
63 public:
65     //- Runtime type information
66     TypeName("hsPsiMixtureThermo");
69     // Constructors
71         //- Construct from mesh and object registry
72         hsPsiMixtureThermo(const fvMesh&, const objectRegistry&);
75     //- Destructor
76     virtual ~hsPsiMixtureThermo();
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             //- Sensible enthalpy for cell-set [J/kg]
103             virtual tmp<scalarField> hs
104             (
105                 const scalarField& T,
106                 const labelList& cells
107             ) const;
109             //- Sensible enthalpy for patch [J/kg]
110             virtual tmp<scalarField> hs
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 for cell-set [J/kg/K]
124             virtual tmp<scalarField> Cp
125             (
126                 const scalarField& T,
127                 const labelList& cells
128             ) const;
130             //- Heat capacity at constant pressure [J/kg/K]
131             virtual tmp<volScalarField> Cp() const;
134         //- Read thermophysicalProperties dictionary
135         virtual bool read();
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
141 } // End namespace Foam
143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
145 #ifdef NoRepository
146 #   include "hsPsiMixtureThermo.C"
147 #endif
149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
151 #endif
153 // ************************************************************************* //