global.h File Reference

This file contains definitions for utility functions and text for modules, inputfiles, logs, textlogs, (see Input File Handling, Diagnostic Output, and Writing messages to the screen). More...

#include "ct_defs.h"

Include dependency graph for global.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
	Cantera
	Namespace for the Cantera kernel.

Functions
int	nErrors ()
	Return the number of errors that have been encountered so far. More...
string	lastErrorMessage ()
	Retrieve the last error message in a string. More...
void	setError (const std::string &r, const std::string &msg)
	Set an error condition in the application class without throwing an exception. More...
void	showErrors (std::ostream &f)
	Prints all of the error messages to an ostream. More...
void	showErrors ()
	Prints all of the error messages using writelog. More...
void	popError ()
	Discard the last error message. More...
std::string	findInputFile (const std::string &name)
	Find an input file. More...
void	addDirectory (const std::string &dir)
	Add a directory to the data file search path. More...
void	appdelete ()
	Delete and free all memory associated with the application. More...
void	thread_complete ()
	Delete and free memory allocated per thread in multithreaded applications. More...
string	canteraRoot ()
	Returns root directory where Cantera is installed. More...
void	writelog (const std::string &msg)
	Write a message to the screen. More...
void	writelog (const std::string &msg, int loglevel)
	Write a message to the log only if loglevel > 0. More...
void	writelogf (const char *fmt,...)
	Write a formatted message to the screen. More...
void	writelogendl ()
	Write an end of line character to the screen and flush output. More...
void	writeline (char repeat, size_t count, bool endl_after, bool endl_before)
void	error (const std::string &msg)
	Write an error message and quit. More...
void	warn_deprecated (const std::string &method, const std::string &extra="")
	Print a warning indicating that method is deprecated. More...
void	suppress_deprecation_warnings ()
	Globally disable printing of deprecation warnings. More...
void	setLogger (Logger *logwriter)
	Install a logger. More...
doublereal	toSI (const std::string &unit)
	Return the conversion factor to convert unit std::string 'unit' to SI units. More...
doublereal	actEnergyToSI (const std::string &unit)
	Return the conversion factor to convert activation energy unit std::string 'unit' to Kelvin. More...
XML_Node *	get_XML_File (const std::string &file, int debug=0)
	Return a pointer to the XML tree for a Cantera input file. More...
XML_Node *	get_XML_from_string (const std::string &text)
	Read a CTI or CTML string and fill up an XML tree. More...
void	close_XML_File (const std::string &file)
	Close an XML File. More...
XML_Node *	get_XML_Node (const std::string &file_ID, XML_Node *root)
	This routine will locate an XML node in either the input XML tree or in another input file specified by the file part of the file_ID string. More...
XML_Node *	get_XML_NameID (const std::string &nameTarget, const std::string &file_ID, XML_Node *root)
	This routine will locate an XML node in either the input XML tree or in another input file specified by the file part of the file_ID string. More...
template<class T >
T	clip (const T &value, const T &lower, const T &upper)
	Clip value such that lower <= value <= upper. More...
template<typename T >
int	sign (T x)
	Sign of a number. Returns -1 if x < 0, 1 if x > 0 and 0 if x == 0. More...

Detailed Description

This file contains definitions for utility functions and text for modules, inputfiles, logs, textlogs, (see Input File Handling, Diagnostic Output, and Writing messages to the screen).

These functions store some parameters in global storage that are accessible at all times from the calling application. Contains module definitions for

• inputfiles (see Input File Handling)
• logs (see Diagnostic Output)
• textlogs (see Writing messages to the screen)

Definition in file global.h.