src/thermophysicalModels/reactionThermo/mixtures/basicMultiComponentMixture/basicMultiComponentMixture.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::basicMultiComponentMixture
  26
  27 Description
  28     combustion mixture
  29
  30 SourceFiles
  31     basicMultiComponentMixture.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef basicMultiComponentMixture_H
  36 #define basicMultiComponentMixture_H
  37
  38 #include "volFields.H"
  39 #include "PtrList.H"
  40 #include "speciesTable.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                  Class basicMultiComponentMixture Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class basicMultiComponentMixture
  52 {
  53
  54 protected:
  55
  56     // Protected data
  57
  58         //- Table of specie names
  59         speciesTable species_;
  60
  61         //- Species mass fractions
  62         PtrList<volScalarField> Y_;
  63
  64
  65 public:
  66
  67     // Constructors
  68
  69         //- Construct from dictionary and mesh
  70         basicMultiComponentMixture
  71         (
  72             const dictionary&,
  73             const wordList& specieNames,
  74             const fvMesh&,
  75             const objectRegistry&
  76         );
  77
  78
  79     //- Destructor
  80     virtual ~basicMultiComponentMixture()
  81     {}
  82
  83
  84     // Member functions
  85
  86         //- Return the table of species
  87         const speciesTable& species() const
  88         {
  89             return species_;
  90         }
  91
  92         //- Return the mass-fraction fields
  93         inline PtrList<volScalarField>& Y();
  94
  95         //- Return the const mass-fraction fields
  96         inline const PtrList<volScalarField>& Y() const;
  97
  98         //- Return the mass-fraction field for a specie given by index
  99         inline volScalarField& Y(const label i);
 100
 101         //- Return the const mass-fraction field for a specie given by index
 102         inline const volScalarField& Y(const label i) const;
 103
 104         //- Return the mass-fraction field for a specie given by name
 105         inline volScalarField& Y(const word& specieName);
 106
 107         //- Return the const mass-fraction field for a specie given by name
 108         inline const volScalarField& Y(const word& specieName) const;
 109
 110         //- Does the mixture include this specie?
 111         inline bool contains(const word& specieName) const;
 112
 113         inline scalar fres(const scalar ft, const scalar stoicRatio) const;
 114
 115         inline tmp<volScalarField> fres
 116         (
 117             const volScalarField& ft,
 118             const dimensionedScalar& stoicRatio
 119         ) const;
 120 };
 121
 122
 123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 124
 125 } // End namespace Foam
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 #include "basicMultiComponentMixtureI.H"
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 #endif
 134
 135 // ************************************************************************* //