Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / thermophysicalModels / reactionThermo / combustionThermo / mixtureThermos / hhuMixtureThermo / hhuMixtureThermo.H
blob9a906aacea4f1cc308d2d27e45bcd52ed1b11cdb
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::hhuMixtureThermo
27 Description
28     Foam::hhuMixtureThermo
30 SourceFiles
31     hhuMixtureThermo.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef hhuMixtureThermo_H
36 #define hhuMixtureThermo_H
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 namespace Foam
43 /*---------------------------------------------------------------------------*\
44                       Class hhuMixtureThermo Declaration
45 \*---------------------------------------------------------------------------*/
47 template<class MixtureType>
48 class hhuMixtureThermo
50     public hhuCombustionThermo,
51     public MixtureType
53     // Private member functions
55         void calculate();
57         //- Construct as copy (not implemented)
58         hhuMixtureThermo(const hhuMixtureThermo<MixtureType>&);
61 public:
63     //- Runtime type information
64     TypeName("hhuMixtureThermo");
67     // Constructors
69         //- Construct from mesh
70         hhuMixtureThermo(const fvMesh&, const objectRegistry&);
73     //- Destructor
74     virtual ~hhuMixtureThermo();
77     // Member functions
79         //- Return the compostion of the multi-component mixture
80         virtual basicMultiComponentMixture& composition()
81         {
82             return *this;
83         }
85         //- Return the compostion of the multi-component mixture
86         virtual const basicMultiComponentMixture& composition() const
87         {
88             return *this;
89         }
91         //- Update properties
92         virtual void correct();
94         //- Chemical enthalpy [J/kg]
95         virtual tmp<volScalarField> hc() const;
98         // Fields derived from thermodynamic state variables
100             //- Enthalpy for cell-set [J/kg]
101             virtual tmp<scalarField> h
102             (
103                 const scalarField& T,
104                 const labelList& cells
105             ) const;
107             //- Enthalpy for patch [J/kg]
108             virtual tmp<scalarField> h
109             (
110                 const scalarField& T,
111                 const label patchi
112             ) const;
114             //- Heat capacity at constant pressure for patch [J/kg/K]
115             virtual tmp<scalarField> Cp
116             (
117                 const scalarField& T,
118                 const label patchi
119             ) const;
121             //- Heat capacity at constant pressure for cell-set [J/kg/K]
122             virtual tmp<scalarField> Cp
123             (
124                 const scalarField& T,
125                 const labelList& cells
126             ) const;
128             //- Heat capacity at constant pressure [J/kg/K]
129             virtual tmp<volScalarField> Cp() const;
131             //- Heat capacity at constant volume for patch [J/kg/K]
132             virtual tmp<scalarField> Cv
133             (
134                 const scalarField& T,
135                 const label patchi
136             ) const;
138             //- Heat capacity at constant pressure [J/kg/K]
139             virtual tmp<volScalarField> Cv() const;
141             //- Unburnt gas enthalpy for cell-set [J/kg]
142             virtual tmp<scalarField> hu
143             (
144                 const scalarField& T,
145                 const labelList& cells
146             ) const;
148             //- Unburnt gas enthalpy for patch [J/kg]
149             virtual tmp<scalarField> hu
150             (
151                 const scalarField& T,
152                 const label patchi
153             ) const;
156             //- Burnt gas temperature [K]
157             virtual tmp<volScalarField> Tb() const;
159             //- Unburnt gas compressibility [s^2/m^2]
160             virtual tmp<volScalarField> psiu() const;
162             //- Burnt gas compressibility [s^2/m^2]
163             virtual tmp<volScalarField> psib() const;
166         // Access to transport variables
168             //- Dynamic viscosity of unburnt gas [kg/ms]
169             virtual tmp<volScalarField> muu() const;
171             //- Dynamic viscosity of burnt gas [kg/ms]
172             virtual tmp<volScalarField> mub() const;
175         //- Read thermophysicalProperties dictionary
176         virtual bool read();
180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
182 } // End namespace Foam
184 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
186 #ifdef NoRepository
187 #   include "hhuMixtureThermo.C"
188 #endif
190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
192 #endif
194 // ************************************************************************* //