Chemkin file reader class. More...

#include <CKReader.h>

Collaboration diagram for CKReader:

Public Member Functions
	CKReader ()
	Constructor.

	~CKReader ()
	Destructor. Does nothing.

bool	read (const std::string &inputFile, const std::string &thermoDatabase, const std::string &logFile)
	Read and optionally validate a Chemkin input file.

void	write (string outputFile)
	not implemented.

Public Attributes
elementList	elements
	a list of Element objects

speciesList	species
	a list of Species objects

reactionList	reactions
	a list of Reaction objects

groupList	groups
	a list of Groups

speciesTable	speciesData
	a map from species names to Species objects

ReactionUnits	units
	reaction units

bool	verbose
	print detailed messages to log file

bool	validate
	validate elements, species, and reaction

bool	debug
	enable debugging output

Private Member Functions
bool	validateSpecies (ostream &log)
	validate the species.

bool	validateReactions (ostream &log)
	validate the reactions.

bool	writeReactions (ostream &log)
	print a summary of all reactions to the log file

Detailed Description

Chemkin file reader class.

Class CKReader parses and validates a file containing a description of a chemical reaction mechanism in Chemkin format. See the Examples section for examples of how CKReader is used in user programs.

Definition at line 60 of file CKReader.h.

Constructor & Destructor Documentation

CKReader ( )

inline

Constructor.

Construct a new CKReader instance. By default, validation is enabled, as well as verbose output to the log file.

Definition at line 68 of file CKReader.h.

~CKReader ( )

inline

Destructor. Does nothing.

Definition at line 71 of file CKReader.h.

Member Function Documentation

bool read	(	const std::string &	inputFile,
		const std::string &	thermoDatabase,
		const std::string &	logfile
	)

Read and optionally validate a Chemkin input file.

read and optionally validate an input file in Chemkin format.

Parameters

inputFile	path to the input file.
thermoDatabase	path to the species thermodynamic property database. If no database is required, enter a null string.
logFile	file to write logging and error messages to.