FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net. Fast, secure and Free Open Source software downloads
Public Member Functions | Friends

speciesTable Class Reference

A table of species. More...

#include <specie/speciesTable.H>

Detailed Description

A table of species.

Source files

Definition at line 51 of file speciesTable.H.

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 word &  operator[] (const label) const
 Return a specie's name.
label  operator[] (const word &) const
 Lookup a specie's name and return its index.

Friends

Istream &  operator>> (Istream &, speciesTable &)

Constructor & Destructor Documentation

speciesTable ( const wordList &   specieNames  )

Construct from list of specie names.

Definition at line 44 of file speciesTable.C.

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

Construct from number of species and list of specie names.

Definition at line 53 of file speciesTable.C.

References forAll, and speciesTable::operator[]().

speciesTable ( Istream &   is  )

Construct from Istream.

Definition at line 67 of file speciesTable.C.

Member Function Documentation

bool contains ( const word &   specieName  ) const [inline]

Does the table contain the given specie.

Definition at line 30 of file speciesTableI.H.

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

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

Return a specie's name.

Reimplemented from UList< T >.

Definition at line 39 of file speciesTableI.H.

References UList< T >::operator[]().

Referenced by speciesTable::speciesTable().

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

Lookup a specie's name and return its index.

Definition at line 47 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: