Antioch::ChemKinDefinitions Class Reference

#include <chemkin_definitions.h>

Public Types
enum	Delim {   ERROR = -1, PLUS, IRREVERSIBLE, REVERSIBLE,   REVERSIBLE_ALT }
enum	Symbol { TB = 0, FAL, PHOTO, ELECTRO }

Public Member Functions
	ChemKinDefinitions ()
	~ChemKinDefinitions ()
const std::map< Delim, std::string > &	delim () const
const std::map< Symbol, std::string > &	symbol () const
const std::string &	reversible () const
const std::string &	duplicate () const
const std::string &	end_tag () const
const std::string &	comment () const
const std::string &	parser () const
bool	is_comment (const char &c) const
bool	is_equation_delimiter (const std::string &test) const
Delim	equation_delimiter (const std::string &test) const

Private Attributes
const std::string	_reversible
const std::string	_duplicate
const std::string	_end_tag
const std::string	_comment
const std::string	_parser
std::map< Delim, std::string >	_delim
std::map< Symbol, std::string >	_symbol

Detailed Description

Definition at line 38 of file chemkin_definitions.h.

Member Enumeration Documentation

enum Antioch::ChemKinDefinitions::Delim

Enumerator
ERROR
PLUS
IRREVERSIBLE
REVERSIBLE
REVERSIBLE_ALT

Definition at line 44 of file chemkin_definitions.h.

              { ERROR = -1,
                PLUS,
                IRREVERSIBLE,
                REVERSIBLE,
                REVERSIBLE_ALT
              };

enum Antioch::ChemKinDefinitions::Symbol

Enumerator
TB
FAL
PHOTO
ELECTRO

Definition at line 51 of file chemkin_definitions.h.

               {
                 TB = 0,
                 FAL,
                 PHOTO,
                 ELECTRO
             };

Constructor & Destructor Documentation

Antioch::ChemKinDefinitions::ChemKinDefinitions ( )

inline

Definition at line 90 of file chemkin_definitions.h.

References _delim, _symbol, ELECTRO, FAL, IRREVERSIBLE, PHOTO, PLUS, REVERSIBLE, REVERSIBLE_ALT, and TB.

                                        :
     _reversible("REV"),
     _duplicate("DUP"),
     _end_tag("END"),
     _comment("!"),
     _parser("/")
  {
    _delim[PLUS]           = "+";
    _delim[REVERSIBLE]     = "=";
    _delim[REVERSIBLE_ALT] = "<=>";
    _delim[IRREVERSIBLE]   = "=>";

    _symbol[TB]      = "M";
    _symbol[FAL]     = "(+M)";
    _symbol[PHOTO]   = "HV";
    _symbol[ELECTRO] = "E";
  }

Antioch::ChemKinDefinitions::~ChemKinDefinitions ( )

inline

Definition at line 42 of file chemkin_definitions.h.

{}

Member Function Documentation

const std::string & Antioch::ChemKinDefinitions::comment ( ) const

inline

Definition at line 139 of file chemkin_definitions.h.

References _comment.

  {
    return _comment;
  }

const std::map< ChemKinDefinitions::Delim, std::string > & Antioch::ChemKinDefinitions::delim ( ) const

inline

Definition at line 109 of file chemkin_definitions.h.

References _delim.

  {
    return _delim;
  }

const std::string & Antioch::ChemKinDefinitions::duplicate ( ) const

inline

Definition at line 127 of file chemkin_definitions.h.

References _duplicate.

  {
    return _duplicate;
  }

const std::string & Antioch::ChemKinDefinitions::end_tag ( ) const

inline

Definition at line 133 of file chemkin_definitions.h.

References _end_tag.

  {
    return _end_tag;
  }

ChemKinDefinitions::Delim Antioch::ChemKinDefinitions::equation_delimiter ( const std::string &  test ) const

inline

Definition at line 166 of file chemkin_definitions.h.

References _delim, ERROR, IRREVERSIBLE, REVERSIBLE, and REVERSIBLE_ALT.

  {
    if(test.find(_delim.at(REVERSIBLE_ALT)) != std::string::npos)
    {
       return REVERSIBLE_ALT;
    }else if(test.find(_delim.at(IRREVERSIBLE)) != std::string::npos)
    {
      return IRREVERSIBLE;
    }else if(test.find(_delim.at(REVERSIBLE)) != std::string::npos)
    {
      return REVERSIBLE;
    }else
    {
      return ERROR;
    }
  }

bool Antioch::ChemKinDefinitions::is_comment ( const char &  c ) const

inline

Definition at line 151 of file chemkin_definitions.h.

References _comment.

  {
    return (c == _comment[0]);
  }

bool Antioch::ChemKinDefinitions::is_equation_delimiter ( const std::string &  test ) const

inline

Definition at line 157 of file chemkin_definitions.h.

References _delim, IRREVERSIBLE, REVERSIBLE, and REVERSIBLE_ALT.

  {
    return (test == _delim.at(REVERSIBLE)     || 
            test == _delim.at(REVERSIBLE_ALT) || 
            test == _delim.at(IRREVERSIBLE)
           );
  }

const std::string & Antioch::ChemKinDefinitions::parser ( ) const

inline

Definition at line 145 of file chemkin_definitions.h.

References _parser.

  {
    return _parser;
  }

const std::string & Antioch::ChemKinDefinitions::reversible ( ) const

inline

Definition at line 121 of file chemkin_definitions.h.

References _reversible.

  {
    return _reversible;
  }

const std::map< ChemKinDefinitions::Symbol, std::string > & Antioch::ChemKinDefinitions::symbol ( ) const

inline

Definition at line 115 of file chemkin_definitions.h.

References _symbol.

  {
    return _symbol;
  }

Member Data Documentation

const std::string Antioch::ChemKinDefinitions::_comment

private

Definition at line 82 of file chemkin_definitions.h.

Referenced by comment(), and is_comment().

std::map<Delim,std::string> Antioch::ChemKinDefinitions::_delim

private

Definition at line 84 of file chemkin_definitions.h.

Referenced by ChemKinDefinitions(), delim(), equation_delimiter(), and is_equation_delimiter().

const std::string Antioch::ChemKinDefinitions::_duplicate

private

Definition at line 80 of file chemkin_definitions.h.

Referenced by duplicate().

const std::string Antioch::ChemKinDefinitions::_end_tag

private

Definition at line 81 of file chemkin_definitions.h.

Referenced by end_tag().

const std::string Antioch::ChemKinDefinitions::_parser

private

Definition at line 83 of file chemkin_definitions.h.

Referenced by parser().

const std::string Antioch::ChemKinDefinitions::_reversible

private

Definition at line 79 of file chemkin_definitions.h.

Referenced by reversible().

std::map<Symbol,std::string> Antioch::ChemKinDefinitions::_symbol

private

Definition at line 85 of file chemkin_definitions.h.

Referenced by ChemKinDefinitions(), and symbol().

---

The documentation for this class was generated from the following file:

• src/parsing/include/antioch/chemkin_definitions.h