src/thermophysicalModels/reactionThermo/mixtures/inhomogeneousMixture/inhomogeneousMixture.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::inhomogeneousMixture
  26
  27 Description
  28     Foam::inhomogeneousMixture
  29
  30 SourceFiles
  31     inhomogeneousMixture.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef inhomogeneousMixture_H
  36 #define inhomogeneousMixture_H
  37
  38 #include "basicMultiComponentMixture.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                     Class inhomogeneousMixture Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class ThermoType>
  50 class inhomogeneousMixture
  51 :
  52     public basicMultiComponentMixture
  53 {
  54     // Private data
  55
  56         static const int nSpecies_ = 2;
  57         static const char* specieNames_[2];
  58
  59         dimensionedScalar stoicRatio_;
  60
  61         ThermoType fuel_;
  62         ThermoType oxidant_;
  63         ThermoType products_;
  64
  65         mutable ThermoType mixture_;
  66
  67         //- Mixture fraction
  68         volScalarField& ft_;
  69
  70         //- Regress variable
  71         volScalarField& b_;
  72
  73         //- Construct as copy (not implemented)
  74         inhomogeneousMixture(const inhomogeneousMixture<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 and mesh
  86         inhomogeneousMixture(const dictionary&, const fvMesh&, const objectRegistry&);
  87
  88
  89     //- Destructor
  90     virtual ~inhomogeneousMixture()
  91     {}
  92
  93
  94     // Member functions
  95
  96         const dimensionedScalar& stoicRatio() const
  97         {
  98             return stoicRatio_;
  99         }
 100
 101         const ThermoType& mixture(const scalar, const scalar) const;
 102
 103         const ThermoType& cellMixture(const label celli) const
 104         {
 105             return mixture(ft_[celli], b_[celli]);
 106         }
 107
 108         const ThermoType& patchFaceMixture
 109         (
 110             const label patchi,
 111             const label facei
 112         ) const
 113         {
 114             return mixture
 115             (
 116                 ft_.boundaryField()[patchi][facei],
 117                 b_.boundaryField()[patchi][facei]
 118             );
 119         }
 120
 121         const ThermoType& cellReactants(const label celli) const
 122         {
 123             return mixture(ft_[celli], 1);
 124         }
 125
 126         const ThermoType& patchFaceReactants
 127         (
 128             const label patchi,
 129             const label facei
 130         ) const
 131         {
 132             return mixture
 133             (
 134                 ft_.boundaryField()[patchi][facei],
 135                 1
 136             );
 137         }
 138
 139         const ThermoType& cellProducts(const label celli) const
 140         {
 141             return mixture(ft_[celli], 0);
 142         }
 143
 144         const ThermoType& patchFaceProducts
 145         (
 146             const label patchi,
 147             const label facei
 148         ) const
 149         {
 150             return mixture
 151             (
 152                 ft_.boundaryField()[patchi][facei],
 153                 0
 154             );
 155         }
 156
 157         //- Read dictionary
 158         void read(const dictionary&);
 159 };
 160
 161
 162 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 163
 164 } // End namespace Foam
 165
 166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 167
 168 #ifdef NoRepository
 169 #   include "inhomogeneousMixture.C"
 170 #endif
 171
 172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 173
 174 #endif
 175
 176 // ************************************************************************* //