From 1133733d3f27cdc0dda81c82c4390fdfc31ee10d Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Thu, 21 Aug 2003 22:35:29 +0000 Subject: [PATCH] Added more comments. --- Cantera/src/importCTML.cpp | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/Cantera/src/importCTML.cpp b/Cantera/src/importCTML.cpp index adcb447db..9aa666b61 100755 --- a/Cantera/src/importCTML.cpp +++ b/Cantera/src/importCTML.cpp @@ -1242,6 +1242,23 @@ next: /** * Import a reaction mechanism for a phase or an interface. + * + * @param phase This is an xml node containing a description + * of a phase. Within the phase is a XML element + * called reactionArray containing the location + * of the description of the reactions that make + * up the kinetics object. + * Also within the phase is an XML element called + * phaseArray containing a listing of other phases + * that participate in the kinetics mechanism. + * + * @param th This is a list of ThermoPhase pointers containing + * the phases that participate in the kinetics + * reactions. + * + * @param k This is a pointer to the kinetics manager class + * that will be initialized with a kinetics + * mechanism. */ bool importKinetics(const XML_Node& phase, vector th, Kinetics* k) { @@ -1270,7 +1287,6 @@ next: phase_ids.push_back(default_phase); int np = phase_ids.size(); - int nt = th.size(); // for each referenced phase, attempt to find its id among those @@ -1313,7 +1329,8 @@ next: } /** - * Build a single-phase solution. + * Build a single-phase ThermoPhase object with associated kinetics + * mechanism. */ bool buildSolutionFromXML(XML_Node& root, string id, string nm, ThermoPhase* th, Kinetics* k) {