src/thermophysicalModels/specie/speciesTable/speciesTable.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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::speciesTable
  27
  28 Description
  29     A table of species
  30
  31 SourceFiles
  32     speciesTableI.H
  33     speciesTable.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef speciesTable_H
  38 #define speciesTable_H
  39
  40 #include "wordList.H"
  41 #include "HashTable.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class speciesTable Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class speciesTable
  53 :
  54     public wordList
  55 {
  56     // Private data
  57
  58         HashTable<label> specieIndices_;
  59
  60
  61     // Private member functions
  62
  63         void setIndices();
  64
  65
  66 public:
  67
  68     // Constructors
  69
  70         //- Construct from list of specie names
  71         speciesTable(const wordList& specieNames);
  72
  73         //- Construct from number of species and list of specie names
  74         speciesTable(const label nSpecies, const char** specieNames);
  75
  76         //- Construct from Istream
  77         speciesTable(Istream&);
  78
  79
  80     // Member Functions
  81
  82         //- Does the table contain the given specie
  83         inline bool contains(const word& specieName) const;
  84
  85
  86     // Member Operators
  87
  88         //- Return a specie's name
  89         inline const word& operator[](const label) const;
  90
  91         //- Lookup a specie's name and return its index
  92         inline label operator[](const word&) const;
  93
  94
  95     // Istream operators
  96
  97         friend Istream& operator>>(Istream&, speciesTable&);
  98 };
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #include "speciesTableI.H"
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 #endif
 112
 113 // ************************************************************************* //