Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
thermophysicalModels
specie
speciesTable
speciesTable.H
Go to the documentation of this file.
1
/*---------------------------------------------------------------------------*\
2
========= |
3
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4
\\ / O peration |
5
\\ / A nd | Copyright (C) 1991-2010 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
13
the Free Software Foundation, either version 3 of the License, or
14
(at your 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, see <http://www.gnu.org/licenses/>.
23
24
Class
25
Foam::speciesTable
26
27
Description
28
A table of species
29
30
SourceFiles
31
speciesTableI.H
32
speciesTable.C
33
34
\*---------------------------------------------------------------------------*/
35
36
#ifndef speciesTable_H
37
#define speciesTable_H
38
39
#include <
OpenFOAM/wordList.H
>
40
#include <
OpenFOAM/HashTable.H
>
41
42
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44
namespace
Foam
45
{
46
47
/*---------------------------------------------------------------------------*\
48
Class speciesTable Declaration
49
\*---------------------------------------------------------------------------*/
50
51
class
speciesTable
52
:
53
public
wordList
54
{
55
// Private data
56
57
HashTable<label>
specieIndices_;
58
59
60
// Private member functions
61
62
void
setIndices();
63
64
65
public
:
66
67
// Constructors
68
69
//- Construct from list of specie names
70
speciesTable
(
const
wordList
& specieNames);
71
72
//- Construct from number of species and list of specie names
73
speciesTable
(
const
label nSpecies,
const
char
** specieNames);
74
75
//- Construct from Istream
76
speciesTable
(
Istream
&);
77
78
79
// Member Functions
80
81
//- Does the table contain the given specie
82
inline
bool
contains
(
const
word
& specieName)
const
;
83
84
85
// Member Operators
86
87
//- Return a specie's name
88
inline
const
word
&
operator[]
(
const
label)
const
;
89
90
//- Lookup a specie's name and return its index
91
inline
label
operator[]
(
const
word
&)
const
;
92
93
94
// Istream operators
95
96
friend
Istream
&
operator>>
(
Istream
&,
speciesTable
&);
97
};
98
99
100
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101
102
}
// End namespace Foam
103
104
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105
106
#include <
specie/speciesTableI.H
>
107
108
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109
110
#endif
111
112
// ************************ vim: set sw=4 sts=4 et: ************************ //