ctml.cpp File Reference

Definitions for functions to read and write CTML. More...

#include "cantera/base/ctml.h"
#include "cantera/base/stringUtils.h"
#include "cantera/base/Array.h"

Include dependency graph for ctml.cpp:

Go to the source code of this file.

Namespaces
	Cantera
	Namespace for the Cantera kernel.

Functions
void	addInteger (XML_Node &node, const std::string &titleString, const int value, const std::string &unitsString="", const std::string &typeString="")
	This function adds a child node with the name, "integer", with a value consisting of a single integer. More...
void	addFloat (XML_Node &node, const std::string &titleString, const doublereal value, const std::string &unitsString="", const std::string &typeString="", const doublereal minval=Undef, const doublereal maxval=Undef)
	This function adds a child node with the name, "float", with a value consisting of a single floating point number. More...
void	addFloatArray (XML_Node &node, const std::string &titleString, const size_t n, const doublereal *const values, const std::string &unitsString="", const std::string &typeString="", const doublereal minval=Undef, const doublereal maxval=Undef)
	This function adds a child node with the name, "floatArray", with a value consisting of a comma separated list of floats. More...
void	addNamedFloatArray (XML_Node &parentNode, const std::string &name, const size_t n, const doublereal *const vals, const std::string units="", const std::string type="", const doublereal minval=Undef, const doublereal maxval=Undef)
	This function adds a child node with the name given by the first parameter with a value consisting of a comma separated list of floats. More...
void	addString (XML_Node &node, const std::string &titleString, const std::string &valueString, const std::string &typeString="")
	This function adds a child node with the name string with a string value to the current node. More...
XML_Node *	getByTitle (const XML_Node &node, const std::string &title)
	Search the child nodes of the current node for an XML Node with a Title attribute of a given name. More...
std::string	getChildValue (const XML_Node &parent, const std::string &nameString)
	This function reads a child node with the name, nameString, and returns its XML value as the return string. More...
void	getString (const XML_Node &node, const std::string &titleString, std::string &valueString, std::string &typeString)
	This function reads a child node with the name string with a specific title attribute named titleString. More...
void	getNamedStringValue (const XML_Node &node, const std::string &nameString, std::string &valueString, std::string &typeString)
	This function attempts to read a named child node and returns with the contents in the value string. More...
void	getIntegers (const XML_Node &node, std::map< std::string, int > &v)
	Get a vector of integer values from a child element. More...
doublereal	getFloat (const XML_Node &parent, const std::string &name, const std::string &type="")
	Get a floating-point value from a child element. More...
doublereal	getFloatCurrent (const XML_Node &currXML, const std::string &type="")
	Get a floating-point value from the current XML element. More...
bool	getOptionalFloat (const XML_Node &parent, const std::string &name, doublereal &fltRtn, const std::string &type="")
	Get an optional floating-point value from a child element. More...
doublereal	getFloatDefaultUnits (const XML_Node &parent, const std::string &name, const std::string &defaultUnits, const std::string &type="toSI")
	Get a floating-point value from a child element with a defined units field. More...
bool	getOptionalModel (const XML_Node &parent, const std::string &nodeName, std::string &modelName)
	Get an optional model name from a named child node. More...
int	getInteger (const XML_Node &parent, const std::string &name)
	Get an integer value from a child element. More...
size_t	getFloatArray (const XML_Node &node, std::vector< doublereal > &v, const bool convert=true, const std::string &unitsString="", const std::string &nodeName="floatArray")
	This function reads the current node or a child node of the current node with the default name, "floatArray", with a value field consisting of a comma separated list of floats. More...
void	getMap (const XML_Node &node, std::map< std::string, std::string > &m)
	This routine is used to interpret the value portions of XML elements that contain colon separated pairs. More...
int	getPairs (const XML_Node &node, std::vector< std::string > &key, std::vector< std::string > &val)
	This function interprets the value portion of an XML element as a series of "Pairs" separated by white space. More...
void	getMatrixValues (const XML_Node &node, const std::vector< std::string > &keyStringRow, const std::vector< std::string > &keyStringCol, Array2D &returnValues, const bool convert=true, const bool matrixSymmetric=false)
	This function interprets the value portion of an XML element as a series of "Matrix ids and entries" separated by white space. More...
void	getStringArray (const XML_Node &node, std::vector< std::string > &v)
	This function interprets the value portion of an XML element as a string. More...

Variables
std::string	FP_Format = "%23.15E"

Detailed Description

Definitions for functions to read and write CTML.

Definition in file ctml.cpp.