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

doxygen update

Browse source
This commit is contained in:
Harry Moffat 2010-08-14 19:25:53 +00:00
parent 95fd7f0b76
commit 83d0bbf7c7
2 changed files with 15 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -959,7 +959,7 @@ namespace ctml {
*
* @note change the v to a std::vector to eliminate a doxygen error. No idea why doxygen needs this.
*/
int getFloatArray(const Cantera::XML_Node& node, std::vector<double> &v,
int getFloatArray(const Cantera::XML_Node& node, Cantera::vector_fp & v,
const bool convert, const std::string unitsString,
const std::string nodeName) {
std::string::size_type icom;
@ -1294,26 +1294,27 @@ namespace ctml {
* separating each field.
* If the node array has an units attribute field, then
* the units are used to convert the floats, iff convert is true.
* This function is a wrapper around the function getFloatArray().
*
* Example:
*
* Code snipet:
* @verbatum
* @verbatim
const XML_Node &State_XMLNode;
vector_fp v;
bool convert = true;
unitsString = "";
nodeName="floatArray";
getFloatArray(State_XMLNode, v, convert, unitsString, nodeName);
@endverbatum
@endverbatim
*
* reads the corresponding XML file:
*
* @verbatum
* @verbatim
<state>
<floatArray units="m3"> 32.4, 1, 100. <\floatArray>
<\state>
@endverbatum
@endverbatim
*
* Will produce the vector
*
@ -1323,21 +1324,15 @@ namespace ctml {
*
*
* @param node XML parent node of the floatArray
* @param v Output vector of floats containing the floatArray information.
* @param convert Conversion to SI is carried out if this boolean is
* True. The default is true.
* @param typeString String name of the type attribute. This is an optional
* parameter. The default is to have an empty string.
* The only string that is recognized is actEnergy.
* Anything else has no effect. This affects what
* units converter is used.
* @param nodeName XML Name of the XML node to read.
* The default value for the node name is floatArray
*
* @note change the coeffs to a std::vector to eliminate a doxygen error. No idea why doxygen needs this.
* @param typeString Returns the type attribute of the current node.
* @param xmin Returns the minimum value attribute of the
* current node.
* @param xmax Returns the maximum value attribute of the
* current node.
* @param coeffs Output vector of floats containing the floatArray information.
*/
void getFunction(const Cantera::XML_Node& node, std::string& type, doublereal& xmin,
doublereal& xmax, std::vector< double > & coeffs) {
doublereal& xmax, Cantera::vector_fp & coeffs) {
const XML_Node& c = node.child("floatArray");
coeffs.clear();
getFloatArray(c,coeffs);

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

@ -833,12 +833,10 @@ namespace ctml {
* current node.
* @param xmax Returns the maximum value attribute of the
* current node.
* @param v Output vector of floats containing the floatArray
* information.
* @param coeffs Output vector of floats containing the floatArray information.
*/
void getFunction(const Cantera::XML_Node& node, std::string& typeString,
doublereal& xmin, doublereal& xmax, Cantera::vector_fp& v);
doublereal& xmin, doublereal& xmax, Cantera::vector_fp & coeffs);
//! Search the child nodes of the current node for an XML Node with a Title
//! attribute of a given name.