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) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::multiComponentMixture
  27
  28 Description
  29     Foam::multiComponentMixture
  30
  31 SourceFiles
  32     multiComponentMixture.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef multiComponentMixture_H
  37 #define multiComponentMixture_H
  38
  39 #include "basicMultiComponentMixture.H"
  40 #include "HashPtrTable.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                     Class multiComponentMixture Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template<class ThermoType>
  52 class multiComponentMixture
  53 :
  54     public basicMultiComponentMixture
  55 {
  56     // Private data
  57
  58         //- Species data
  59         PtrList<ThermoType> speciesData_;
  60
  61         //- Temporary storage for the cell/face mixture thermo data
  62         mutable ThermoType mixture_;
  63
  64
  65     // Private member functions
  66
  67         //- Construct the species data from the given dictionary and return the
  68         //  data for the first specie to initialise the mixture thermo data
  69         const ThermoType& constructSpeciesData(const dictionary& thermoDict);
  70
  71         //- Correct the mass fractions to sum to 1
  72         void correctMassFractions();
  73
  74         //- Construct as copy (not implemented)
  75         multiComponentMixture(const multiComponentMixture<ThermoType>&);
  76
  77
  78 public:
  79
  80     //- The type of thermodynamics this mixture is instantiated for
  81     typedef ThermoType thermoType;
  82
  83
  84     // Constructors
  85
  86         //- Construct from dictionary, specie names, thermo database and mesh
  87         multiComponentMixture
  88         (
  89             const dictionary&,
  90             const wordList& specieNames,
  91             const HashPtrTable<ThermoType>& specieThermoData,
  92             const fvMesh&
  93         );
  94
  95         //- Construct from dictionary and mesh
  96         multiComponentMixture(const dictionary&, const fvMesh&);
  97
  98
  99     //- Destructor
 100     virtual ~multiComponentMixture()
 101     {}
 102
 103
 104     // Member functions
 105
 106         const ThermoType& cellMixture(const label celli) const;
 107
 108         const ThermoType& patchFaceMixture
 109         (
 110             const label patchi,
 111             const label facei
 112         ) const;
 113
 114         //- Return the raw specie thermodynamic data
 115         const PtrList<ThermoType>& speciesData() const
 116         {
 117             return speciesData_;
 118         }
 119
 120         //- Read dictionary
 121         void read(const dictionary&);
 122 };
 123
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 } // End namespace Foam
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 #ifdef NoRepository
 132 #   include "multiComponentMixture.C"
 133 #endif
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 #endif
 138
 139 // ************************************************************************* //