src/thermophysicalModels/reactionThermo/mixtures/multiComponentMixture/multiComponentMixture.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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::multiComponentMixture
  26
  27 Description
  28     Foam::multiComponentMixture
  29
  30 SourceFiles
  31     multiComponentMixture.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef multiComponentMixture_H
  36 #define multiComponentMixture_H
  37
  38 #include "basicMultiComponentMixture.H"
  39 #include "HashPtrTable.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                     Class multiComponentMixture Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class ThermoType>
  51 class multiComponentMixture
  52 :
  53     public basicMultiComponentMixture
  54 {
  55     // Private data
  56
  57         //- Species data
  58         PtrList<ThermoType> speciesData_;
  59
  60         //- Temporary storage for the cell/face mixture thermo data
  61         mutable ThermoType mixture_;
  62
  63
  64     // Private Member Functions
  65
  66         //- Construct the species data from the given dictionary and return the
  67         //  data for the first specie to initialise the mixture thermo data
  68         const ThermoType& constructSpeciesData(const dictionary& thermoDict);
  69
  70         //- Correct the mass fractions to sum to 1
  71         void correctMassFractions();
  72
  73         //- Construct as copy (not implemented)
  74         multiComponentMixture(const multiComponentMixture<ThermoType>&);
  75
  76
  77 public:
  78
  79     //- The type of thermodynamics this mixture is instantiated for
  80     typedef ThermoType thermoType;
  81
  82
  83     // Constructors
  84
  85         //- Construct from dictionary, specie names, thermo database and mesh
  86         multiComponentMixture
  87         (
  88             const dictionary&,
  89             const wordList& specieNames,
  90             const HashPtrTable<ThermoType>& specieThermoData,
  91             const fvMesh&
  92         );
  93
  94         //- Construct from dictionary and mesh
  95         multiComponentMixture(const dictionary&, const fvMesh&);
  96
  97
  98     //- Destructor
  99     virtual ~multiComponentMixture()
 100     {}
 101
 102
 103     // Member functions
 104
 105         const ThermoType& cellMixture(const label celli) const;
 106
 107         const ThermoType& patchFaceMixture
 108         (
 109             const label patchi,
 110             const label facei
 111         ) const;
 112
 113         //- Return the raw specie thermodynamic data
 114         const PtrList<ThermoType>& speciesData() const
 115         {
 116             return speciesData_;
 117         }
 118
 119         //- Read dictionary
 120         void read(const dictionary&);
 121
 122
 123         // Per specie properties
 124
 125             //- Number of moles []
 126             virtual scalar nMoles(const label specieI) const;
 127
 128             //- Molecular weight [kg/kmol]
 129             virtual scalar W(const label specieI) const;
 130
 131
 132         // Per specie thermo properties
 133
 134             //- Heat capacity at constant pressure [J/(kg K)]
 135             virtual scalar Cp(const label specieI, const scalar T) const;
 136
 137             //- Heat capacity at constant volume [J/(kg K)]
 138             virtual scalar Cv(const label specieI, const scalar T) const;
 139
 140             //- Enthalpy [J/kg]
 141             virtual scalar H(const label specieI, const scalar T) const;
 142
 143             //- Sensible enthalpy [J/kg]
 144             virtual scalar Hs(const label specieI, const scalar T) const;
 145
 146             //- Chemical enthalpy [J/kg]
 147             virtual scalar Hc(const label specieI) const;
 148
 149             //- Entropy [J/(kg K)]
 150             virtual scalar S(const label specieI, const scalar T) const;
 151
 152             //- Internal energy [J/kg]
 153             virtual scalar E(const label specieI, const scalar T) const;
 154
 155             //- Gibbs free energy [J/kg]
 156             virtual scalar G(const label specieI, const scalar T) const;
 157
 158             //- Helmholtz free energy [J/kg]
 159             virtual scalar A(const label specieI, const scalar T) const;
 160
 161
 162         // Per specie transport properties
 163
 164             //- Dynamic viscosity [kg/m/s]
 165             virtual scalar mu(const label specieI, const scalar T) const;
 166
 167             //- Thermal conductivity [W/m/K]
 168             virtual scalar kappa(const label specieI, const scalar T) const;
 169
 170             //- Thermal diffusivity [kg/m/s]
 171             virtual scalar alpha(const label specieI, const scalar T) const;
 172 };
 173
 174
 175 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 176
 177 } // End namespace Foam
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 #ifdef NoRepository
 182 #   include "multiComponentMixture.C"
 183 #endif
 184
 185 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 186
 187 #endif
 188
 189 // ************************************************************************* //