research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doxygen updates

Browse source
This commit is contained in:
Harry Moffat 2009-01-09 16:52:55 +00:00
parent 477d0080bc
commit f0d110ea28
2 changed files with 204 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

111
Cantera/src/base/ctml.cpp
View file

@ -361,11 +361,13 @@ namespace ctml {
if (typeString != "") f.addAttribute("type", typeString); if (typeString != "") f.addAttribute("type", typeString);
} }
XML_Node* getByTitle(XML_Node& node, string title) { XML_Node* getByTitle(const Cantera::XML_Node& node, const std::string &title) {
XML_Node* s = node.findByAttr("title",title); XML_Node* s = node.findByAttr("title", title);
if (!s) return 0; if (!s) return 0;
if (s->parent() == &node) return s; if (s->parent() == &node) {
else return 0; return s;
}
return 0;
} }
// This function reads a child node with the name string and returns // This function reads a child node with the name string and returns
@ -420,7 +422,7 @@ namespace ctml {
* Reads the following the snippet in the XML file: * Reads the following the snippet in the XML file:
* @verbatum * @verbatum
<string title="titleString" type="typeString"> <string title="titleString" type="typeString">
valueString valueString
<\string> <\string>
@endverbatum @endverbatum
* *
@ -429,7 +431,7 @@ namespace ctml {
* @param valueString Value string that is found in the child node. output variable * @param valueString Value string that is found in the child node. output variable
* @param typeString String type. This is an optional output variable * @param typeString String type. This is an optional output variable
*/ */
void getString(Cantera::XML_Node& node, const std::string &titleString, std::string& valueString, void getString(const Cantera::XML_Node& node, const std::string &titleString, std::string& valueString,
std::string& typeString) { std::string& typeString) {
valueString = ""; valueString = "";
typeString = ""; typeString = "";
@ -442,12 +444,53 @@ namespace ctml {
} }
} }
void getIntegers(const Cantera::XML_Node& node, map<string,int>& v) {
vector<XML_Node*> f; // Get a vector of integer values from a child element.
/*
* Returns a std::map containing a keyed values for child XML_Nodes
* of the current node with the name, "integer".
* In the keyed mapping there will be a list of titles vs. values
* for all of the XML nodes.
* The integer XML_nodes are expected to be in a particular form created
* by the function addInteger(). One value per XML_node is expected.
*
*
* Example:
*
* Code snipet:
* @verbatum
const XML_Node &State_XMLNode;
std::map<std::string, integer> v;
getinteger(State_XMLNode, v);
@endverbatum
*
* reads the corresponding XML file:
*
* @verbatum
<state>
<integer title="i1"> 1 <\integer>
<integer title="i2"> 2 <\integer>
<integer title="i3"> 3 <\integer>
<\state>
@endverbatum
*
* Will produce the mapping:
*
* v["i1"] = 1
* v["i2"] = 2
* v["i3"] = 3
*
*
* @param node Current XML node to get the values from
* @param v Output map of the results.
*/
void getIntegers(const Cantera::XML_Node& node,
std::map<std::string, int>& v) {
std::vector<XML_Node*> f;
node.getChildren("integer",f); node.getChildren("integer",f);
int n = static_cast<int>(f.size()); int n = static_cast<int>(f.size());
integer x, x0, x1; integer x, x0, x1;
string typ, title, vmin, vmax; std::string typ, title, vmin, vmax;
for (int i = 0; i < n; i++) { for (int i = 0; i < n; i++) {
const XML_Node& fi = *(f[i]); const XML_Node& fi = *(f[i]);
x = atoi(fi().c_str()); x = atoi(fi().c_str());
@ -463,14 +506,54 @@ namespace ctml {
} }
// Get a vector of floating-point values from a child element.
/*
void getFloats(const Cantera::XML_Node& node, map<string,double>& v, bool convert) { * Returns a std::map containing a keyed values for child XML_Nodes
vector<XML_Node*> f; * of the current node with the name, "float".
* In the keyed mapping there will be a list of titles vs. values
* for all of the XML nodes.
* The float XML_nodes are expected to be in a particular form created
* by the function addFloat(). One value per XML_node is expected.
*
*
* Example:
*
* Code snipet:
* @verbatum
const XML_Node &State_XMLNode;
std::map<std::string,double> v;
bool convert = true;
getFloats(State_XMLNode, v, convert);
@endverbatum
*
* reads the corresponding XML file:
*
* @verbatum
<state>
<float title="a1" units="m3"> 32.4 <\float>
<float title="a2" units="cm3"> 1. <\float>
<float title="a3"> 100. <\float>
<\state>
@endverbatum
*
* Will produce the mapping:
*
* v["a1"] = 32.4
* v["a2"] = 1.0E-6
* v["a3"] = 100.
*
*
* @param node Current XML node to get the values from
* @param v Output map of the results.
* @param convert Turn on conversion to SI units
*/
void getFloats(const Cantera::XML_Node& node, std::map<std::string, double>& v,
const bool convert) {
std::vector<XML_Node*> f;
node.getChildren("float",f); node.getChildren("float",f);
int n = static_cast<int>(f.size()); int n = static_cast<int>(f.size());
doublereal x, x0, x1, fctr; doublereal x, x0, x1, fctr;
string typ, title, units, vmin, vmax; std::string typ, title, units, vmin, vmax;
for (int i = 0; i < n; i++) { for (int i = 0; i < n; i++) {
const XML_Node& fi = *(f[i]); const XML_Node& fi = *(f[i]);
x = atof(fi().c_str()); x = atof(fi().c_str());

114
Cantera/src/base/ctml.h
View file

@ -352,9 +352,47 @@ namespace ctml {
Cantera::Array2D &returnValues, bool convert = true, Cantera::Array2D &returnValues, bool convert = true,
bool matrixSymmetric = false); bool matrixSymmetric = false);
//! Get a vector of integer values from a child element.
/*!
* Returns a std::map containing a keyed values for child XML_Nodes
* of the current node with the name, "integer".
* In the keyed mapping there will be a list of titles vs. values
* for all of the XML nodes.
* The integer XML_nodes are expected to be in a particular form created
* by the function addInteger(). One value per XML_node is expected.
*
*
* Example:
*
* Code snipet:
* @verbatum
const XML_Node &State_XMLNode;
std::map<std::string, integer> v;
getinteger(State_XMLNode, v);
@endverbatum
*
* reads the corresponding XML file:
*
* @verbatum
<state>
<integer title="i1"> 1 <\integer>
<integer title="i2"> 2 <\integer>
<integer title="i3"> 3 <\integer>
<\state>
@endverbatum
*
* Will produce the mapping:
*
* v["i1"] = 1
* v["i2"] = 2
* v["i3"] = 3
*
*
* @param node Current XML node to get the values from
* @param v Output map of the results.
*/
void getIntegers(const Cantera::XML_Node& node, std::map<std::string,int>& v); void getIntegers(const Cantera::XML_Node& node, std::map<std::string,int>& v);
void getFloats(const Cantera::XML_Node& node, std::map<std::string,double>& v,
bool convert=true);
//! Get a floating-point value from a child element. //! Get a floating-point value from a child element.
@ -380,7 +418,7 @@ namespace ctml {
* reads the corresponding XML file: * reads the corresponding XML file:
* @verbatum * @verbatum
<state> <state>
<pressure units="Pa"> 101325.0 </pressure> <pressure units="Pa"> 101325.0 </pressure>
<\state> <\state>
@endverbatum @endverbatum
* *
@ -393,6 +431,51 @@ namespace ctml {
doublereal getFloat(const Cantera::XML_Node& parent, std::string name, doublereal getFloat(const Cantera::XML_Node& parent, std::string name,
std::string type=""); std::string type="");
//! Get a vector of floating-point values from a child element.
/*!
* Returns a std::map containing a keyed values for child XML_Nodes
* of the current node with the name, "float".
* In the keyed mapping there will be a list of titles vs. values
* for all of the XML nodes.
* The float XML_nodes are expected to be in a particular form created
* by the function addFloat(). One value per XML_node is expected.
*
*
* Example:
*
* Code snipet:
* @verbatum
const XML_Node &State_XMLNode;
std::map<std::string,double> v;
bool convert = true;
getFloats(State_XMLNode, v, convert);
@endverbatum
*
* reads the corresponding XML file:
*
* @verbatum
<state>
<float title="a1" units="m3"> 32.4 <\float>
<float title="a2" units="cm3"> 1. <\float>
<float title="a3"> 100. <\float>
<\state>
@endverbatum
*
* Will produce the mapping:
*
* v["a1"] = 32.4
* v["a2"] = 1.0E-6
* v["a3"] = 100.
*
*
* @param node Current XML node to get the values from
* @param v Output map of the results.
* @param convert Turn on conversion to SI units
*/
void getFloats(const Cantera::XML_Node& node, std::map<std::string, double>& v,
const bool convert=true);
//! Get a floating-point value from a child element with a defined units field //! Get a floating-point value from a child element with a defined units field
/*! /*!
* Returns a double value for the child named 'name' of element 'parent'. * Returns a double value for the child named 'name' of element 'parent'.
@ -414,7 +497,7 @@ namespace ctml {
* reads the corresponding XML file: * reads the corresponding XML file:
* @verbatum * @verbatum
<state> <state>
<pressure units="Pa"> 101325.0 </pressure> <pressure units="Pa"> 101325.0 </pressure>
<\state> <\state>
@endverbatum @endverbatum
* *
@ -450,7 +533,7 @@ namespace ctml {
* reads the corresponding XML file: * reads the corresponding XML file:
* @verbatum * @verbatum
<state> <state>
<numProcs> 10 <numProcs/> <numProcs> 10 <numProcs/>
<\state> <\state>
@endverbatum @endverbatum
* *
@ -462,7 +545,18 @@ namespace ctml {
void getFunction(const Cantera::XML_Node& node, std::string& type, void getFunction(const Cantera::XML_Node& node, std::string& type,
doublereal& xmin, doublereal& xmax, Cantera::vector_fp& coeffs); doublereal& xmin, doublereal& xmax, Cantera::vector_fp& coeffs);
Cantera::XML_Node* getByTitle(Cantera::XML_Node& node, std::string title);
//! Search the child nodes of the current node for an XML Node with a Title
//! attribute of a given name.
/*!
* @param node Current node from which to conduct the search
* @param title Name of the title attribute
*
* @return Returns a pointer to the matched child node. Returns 0 if no node is
* found.
*/
Cantera::XML_Node* getByTitle(const Cantera::XML_Node& node, const std::string &title);
//! This function reads a child node with the name string with a specific //! This function reads a child node with the name string with a specific
//! title attribute named titleString //! title attribute named titleString
@ -485,7 +579,7 @@ namespace ctml {
* Reads the following the snippet in the XML file: * Reads the following the snippet in the XML file:
* @verbatum * @verbatum
<string title="titleString" type="typeString"> <string title="titleString" type="typeString">
valueString valueString
<\string> <\string>
@endverbatum @endverbatum
* *
@ -494,7 +588,7 @@ namespace ctml {
* @param valueString Value string that is found in the child node. output variable * @param valueString Value string that is found in the child node. output variable
* @param typeString String type. This is an optional output variable * @param typeString String type. This is an optional output variable
*/ */
void getString(Cantera::XML_Node& node, const std::string &titleString, void getString(const Cantera::XML_Node& node, const std::string &titleString,
std::string& valueString, std::string& typeString); std::string& valueString, std::string& typeString);
//! This function reads a child node with the name, nameString, and returns //! This function reads a child node with the name, nameString, and returns
@ -516,7 +610,7 @@ namespace ctml {
* *
* @verbatum * @verbatum
<vacencySpecies> <vacencySpecies>
O(V) O(V)
<\vancencySpecies> <\vancencySpecies>
@endverbatum @endverbatum
* *
@ -527,7 +621,7 @@ namespace ctml {
*/ */
std::string getChildValue(const Cantera::XML_Node& parent, const std::string &nameString); std::string getChildValue(const Cantera::XML_Node& parent, const std::string &nameString);
// these are defined in ct2ctml.cpp // These are defined in ct2ctml.cpp
void get_CTML_Tree(Cantera::XML_Node* node, std::string file, int debug = 0); void get_CTML_Tree(Cantera::XML_Node* node, std::string file, int debug = 0);
//! Convert a cti file into a ctml file //! Convert a cti file into a ctml file