applications/utilities/thermophysical/mixtureAdiabaticFlameT/mixture.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::mixture
  26
  27 Description
  28
  29 SourceFiles
  30     mixtureI.H
  31     mixture.C
  32     mixtureIO.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef mixture_H
  37 #define mixture_H
  38
  39 #include "error.H"
  40
  41 #include "List.H"
  42 #include "substance.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class mixture Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class mixture
  54 :
  55     public List<substance>
  56 {
  57     // Private data
  58
  59         word name_;
  60
  61
  62 public:
  63
  64     // Constructors
  65
  66         //- Construct from Istream
  67         mixture(Istream& is)
  68         :
  69             List<substance>(is),
  70             name_(is)
  71         {
  72             scalar volTot = 0;
  73
  74             for (label i = 0; i < size(); i++)
  75             {
  76                 volTot += operator[](i).volFrac();
  77             }
  78
  79             if (volTot > 1.001 || volTot < 0.999)
  80             {
  81                 FatalErrorIn("mixture::mixture(istream& is)")
  82                     << "Sum of volume fractions for Mixture " << name_
  83                     << " = " << volTot << endl
  84                     << "Should equal one."
  85                     << abort(FatalError);
  86             }
  87         }
  88
  89
  90     // Member Functions
  91
  92         // Access
  93
  94             const word& name() const
  95             {
  96                 return name_;
  97             }
  98 };
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #endif
 108
 109 // ************************************************************************* //