src/thermophysicalModels/combustion/mixtureThermos/mixtures/homogeneousMixture/homogeneousMixture.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::homogeneousMixture
  27
  28 Description
  29     Foam::homogeneousMixture
  30
  31 SourceFiles
  32     homogeneousMixture.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef homogeneousMixture_H
  37 #define homogeneousMixture_H
  38
  39 #include "combustionMixture.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class homogeneousMixture Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class ThermoType>
  51 class homogeneousMixture
  52 :
  53     public combustionMixture
  54 {
  55     // Private data
  56
  57         static const int nSpecies_ = 1;
  58         static const char* specieNames_[1];
  59
  60         ThermoType reactants_;
  61         ThermoType products_;
  62
  63         mutable ThermoType mixture_;
  64
  65         //- Construct as copy (not implemented)
  66         homogeneousMixture(const homogeneousMixture<ThermoType>&);
  67
  68         //- Regress variable
  69         volScalarField& b_;
  70
  71
  72 public:
  73
  74     //- The type of thermodynamics this mixture is instantiated for
  75     typedef ThermoType thermoType;
  76
  77
  78     // Constructors
  79
  80         //- Construct from dictionary and mesh
  81         homogeneousMixture(const dictionary&, const fvMesh&);
  82
  83
  84     // Destructor
  85
  86         virtual ~homogeneousMixture()
  87         {}
  88
  89
  90     // Member functions
  91
  92         const ThermoType& mixture(const scalar) const;
  93
  94         const ThermoType& cellMixture(const label celli) const
  95         {
  96             return mixture(b_[celli]);
  97         }
  98
  99         const ThermoType& patchFaceMixture
 100         (
 101             const label patchi,
 102             const label facei
 103         ) const
 104         {
 105             return mixture(b_.boundaryField()[patchi][facei]);
 106         }
 107
 108         const ThermoType& cellReactants(const label) const
 109         {
 110             return reactants_;
 111         }
 112
 113         const ThermoType& patchFaceReactants(const label, const label) const
 114         {
 115             return reactants_;
 116         }
 117
 118         const ThermoType& cellProducts(const label) const
 119         {
 120             return products_;
 121         }
 122
 123         const ThermoType& patchFaceProducts(const label, const label) const
 124         {
 125             return products_;
 126         }
 127
 128         //- Read dictionary
 129         void read(const dictionary&);
 130 };
 131
 132
 133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 134
 135 } // End namespace Foam
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 138
 139 #ifdef NoRepository
 140 #   include "homogeneousMixture.C"
 141 #endif
 142
 143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 144
 145 #endif
 146
 147 // ************************************************************************* //