00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd. 00006 \\/ M anipulation | 00007 ------------------------------------------------------------------------------- 00008 License 00009 This file is part of OpenFOAM. 00010 00011 OpenFOAM is free software: you can redistribute it and/or modify it 00012 under the terms of the GNU General Public License as published by 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your option) any later version. 00015 00016 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT 00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00018 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 00019 for more details. 00020 00021 You should have received a copy of the GNU General Public License 00022 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 00023 00024 Class 00025 Foam::speciesTable 00026 00027 Description 00028 A table of species 00029 00030 SourceFiles 00031 speciesTableI.H 00032 speciesTable.C 00033 00034 \*---------------------------------------------------------------------------*/ 00035 00036 #ifndef speciesTable_H 00037 #define speciesTable_H 00038 00039 #include <OpenFOAM/wordList.H> 00040 #include <OpenFOAM/HashTable.H> 00041 00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00043 00044 namespace Foam 00045 { 00046 00047 /*---------------------------------------------------------------------------*\ 00048 Class speciesTable Declaration 00049 \*---------------------------------------------------------------------------*/ 00050 00051 class speciesTable 00052 : 00053 public wordList 00054 { 00055 // Private data 00056 00057 HashTable<label> specieIndices_; 00058 00059 00060 // Private member functions 00061 00062 void setIndices(); 00063 00064 00065 public: 00066 00067 // Constructors 00068 00069 //- Construct from list of specie names 00070 speciesTable(const wordList& specieNames); 00071 00072 //- Construct from number of species and list of specie names 00073 speciesTable(const label nSpecies, const char** specieNames); 00074 00075 //- Construct from Istream 00076 speciesTable(Istream&); 00077 00078 00079 // Member Functions 00080 00081 //- Does the table contain the given specie 00082 inline bool contains(const word& specieName) const; 00083 00084 00085 // Member Operators 00086 00087 //- Return a specie's name 00088 inline const word& operator[](const label) const; 00089 00090 //- Lookup a specie's name and return its index 00091 inline label operator[](const word&) const; 00092 00093 00094 // Istream operators 00095 00096 friend Istream& operator>>(Istream&, speciesTable&); 00097 }; 00098 00099 00100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00101 00102 } // End namespace Foam 00103 00104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00105 00106 #include <specie/speciesTableI.H> 00107 00108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00109 00110 #endif 00111 00112 // ************************ vim: set sw=4 sts=4 et: ************************ //
