src/thermophysicalModels/specie/reaction/reactionRate/thirdBodyEfficiencies/thirdBodyEfficiencies.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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::thirdBodyEfficiencies
  27
  28 Description
  29     Third body efficiencies
  30
  31 SourceFiles
  32     thirdBodyEfficienciesI.H
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef thirdBodyEfficiencies_H
  37 #define thirdBodyEfficiencies_H
  38
  39 #include "scalarList.H"
  40 #include "speciesTable.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of friend functions and operators
  48
  49 class thirdBodyEfficiencies;
  50 Ostream& operator<<(Ostream&, const thirdBodyEfficiencies&);
  51
  52
  53 /*---------------------------------------------------------------------------*\
  54                            Class thirdBodyEfficiencies Declaration
  55 \*---------------------------------------------------------------------------*/
  56
  57 class thirdBodyEfficiencies
  58 :
  59     public scalarList
  60 {
  61     // Private data
  62
  63         const speciesTable& species_;
  64
  65
  66 public:
  67
  68     // Constructors
  69
  70         //- Construct from components
  71         inline thirdBodyEfficiencies
  72         (
  73             const speciesTable& species,
  74             const scalarList& efficiencies
  75         );
  76
  77         //- Construct from Istream
  78         inline thirdBodyEfficiencies
  79         (
  80             const speciesTable& species,
  81             Istream& is
  82         );
  83
  84
  85     // Member functions
  86
  87         //- Calculate and return M, the concentration of the third-bodies
  88         inline scalar M(const scalarList& c) const;
  89
  90
  91     // Ostream Operator
  92
  93         friend Ostream& operator<<(Ostream&, const thirdBodyEfficiencies&);
  94 };
  95
  96
  97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  98
  99 } // End namespace Foam
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 #include "thirdBodyEfficienciesI.H"
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #endif
 108
 109 // ************************************************************************* //