OpenFOAM logo
The Open Source CFD Toolbox
  Source Guide OpenCFD Solutions Contact OpenFOAM

speciesTable Class Reference

A table of species. More...

Inheritance diagram for speciesTable:
Collaboration diagram for speciesTable:

List of all members.


Public Member Functions

 speciesTable (const wordList &specieNames)
 Construct from list of specie names.
 speciesTable (const label nSpecies, const char **specieNames)
 Construct from number of species and list of specie names.
 speciesTable (Istream &)
 Construct from Istream.
bool contains (const word &specieName) const
 Does the table contain the given specie.
const wordoperator[] (const label) const
 Return a specie's name.
label operator[] (const word &) const
 Lookup a specie's name and return its index.

Friends

Istreamoperator>> (Istream &, speciesTable &)

Detailed Description

A table of species.

Source files

Definition at line 46 of file speciesTable.H.


Constructor & Destructor Documentation

speciesTable ( const wordList specieNames  ) 

Construct from list of specie names.

Definition at line 37 of file speciesTable.C.

speciesTable ( const label  nSpecies,
const char **  specieNames 
)

Construct from number of species and list of specie names.

Definition at line 46 of file speciesTable.C.

speciesTable ( Istream is  ) 

Construct from Istream.

Definition at line 60 of file speciesTable.C.


Member Function Documentation

bool contains ( const word specieName  )  const [inline]

Does the table contain the given specie.

Definition at line 23 of file speciesTableI.H.

const Foam::word & operator[] ( const label  specieIndex  )  const [inline]

Return a specie's name.

Definition at line 32 of file speciesTableI.H.

References HashTable< T, Key, Hash >::found().

Here is the call graph for this function:

Foam::label operator[] ( const word specieName  )  const [inline]

Lookup a specie's name and return its index.

Definition at line 40 of file speciesTableI.H.


Friends And Related Function Documentation

Istream& operator>> ( Istream ,
speciesTable  
) [friend]


The documentation for this class was generated from the following files:
Copyright © 2000-2009 OpenCFD Ltd