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

   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.
  10
  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.
  15
  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.
  20
  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/>.
  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             const objectRegistry&
  93         );
  94
  95         //- Construct from dictionary and mesh
  96         multiComponentMixture
  97         (
  98             const dictionary&,
  99             const fvMesh&,
 100             const objectRegistry&
 101         );
 102
 103
 104     //- Destructor
 105     virtual ~multiComponentMixture()
 106     {}
 107
 108
 109     // Member functions
 110
 111         const ThermoType& cellMixture(const label celli) const;
 112
 113         const ThermoType& patchFaceMixture
 114         (
 115             const label patchi,
 116             const label facei
 117         ) const;
 118
 119         //- Return the raw specie thermodynamic data
 120         const PtrList<ThermoType>& speciesData() const
 121         {
 122             return speciesData_;
 123         }
 124
 125         //- Read dictionary
 126         void read(const dictionary&);
 127 };
 128
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 } // End namespace Foam
 133
 134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 135
 136 #ifdef NoRepository
 137 #   include "multiComponentMixture.C"
 138 #endif
 139
 140 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 141
 142 #endif
 143
 144 // ************************************************************************* //