From 8eea4732501af74f2880e507659c5e2b0f623d15 Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Fri, 16 Jul 2010 21:47:21 +0000 Subject: [PATCH] doxygen update only - got rid of error messages. --- Cantera/src/transport/MMCollisionInt.cpp | 34 ++++--- Cantera/src/transport/MMCollisionInt.h | 110 +++++++++++++++++++++-- 2 files changed, 125 insertions(+), 19 deletions(-) diff --git a/Cantera/src/transport/MMCollisionInt.cpp b/Cantera/src/transport/MMCollisionInt.cpp index 42e6c267a..d4949529a 100644 --- a/Cantera/src/transport/MMCollisionInt.cpp +++ b/Cantera/src/transport/MMCollisionInt.cpp @@ -235,9 +235,17 @@ namespace Cantera { { } //==================================================================================================================== - - void MMCollisionInt::init(XML_Writer* xml, - doublereal tsmin, doublereal tsmax, int log_level) { + // Initialize the object for calculation + /* + * + * @param xml Pointer to the log file that will receive the debug output + * messages + * @param tsmin Minimum value of Tstar to carry out the fitting + * @param tsmax Maximum value of Tstar to carry out the fitting + * @param loglevel Set the loglevel for the object. The default + * loglevel is zero, indicating no output. + */ + void MMCollisionInt::init(XML_Writer* xml, doublereal tsmin, doublereal tsmax, int log_level) { #ifdef DEBUG_MODE if (!xml) { throw CanteraError("MMCollisionInt::init", "pointer to xml file is zero"); @@ -355,11 +363,9 @@ namespace Cantera { #endif } } + //==================================================================================================================== - - - doublereal MMCollisionInt::fitDelta(int table, int ntstar, - int degree, doublereal* c) { + doublereal MMCollisionInt::fitDelta(int table, int ntstar, int degree, doublereal* c) { vector_fp w(8); doublereal* begin = 0; int ndeg=0; @@ -378,6 +384,7 @@ namespace Cantera { w[0] = -1.0; return polyfit(8, delta, begin, DATA_PTR(w), degree, ndeg, 0.0, c); } + //==================================================================================================================== doublereal MMCollisionInt::omega22(double ts, double deltastar) { int i; @@ -398,6 +405,7 @@ namespace Cantera { return quadInterp(log(ts), DATA_PTR(m_logTemp) + i1, DATA_PTR(values)); } + //==================================================================================================================== doublereal MMCollisionInt::astar(double ts, double deltastar) { int i; @@ -418,6 +426,7 @@ namespace Cantera { return quadInterp(log(ts), DATA_PTR(m_logTemp) + i1, DATA_PTR(values)); } + //==================================================================================================================== doublereal MMCollisionInt::bstar(double ts, double deltastar) { @@ -439,7 +448,7 @@ namespace Cantera { return quadInterp(log(ts), DATA_PTR(m_logTemp) + i1, DATA_PTR(values)); } - + //==================================================================================================================== doublereal MMCollisionInt::cstar(double ts, double deltastar) { int i; @@ -458,8 +467,10 @@ namespace Cantera { else values[i-i1] = poly5(deltastar, DATA_PTR(m_cpoly[i])); } return quadInterp(log(ts), DATA_PTR(m_logTemp) + i1, - DATA_PTR(values)); } + DATA_PTR(values)); + } + //==================================================================================================================== void MMCollisionInt::fit_omega22(ostream& logfile, int degree, doublereal deltastar, doublereal* o22) @@ -488,6 +499,7 @@ namespace Cantera { } #endif } + //==================================================================================================================== void MMCollisionInt::fit(ostream& logfile, int degree, doublereal deltastar, doublereal* a, doublereal* b, doublereal* c) @@ -551,9 +563,9 @@ namespace Cantera { } #endif } - + //==================================================================================================================== } // namespace - +//====================================================================================================================== diff --git a/Cantera/src/transport/MMCollisionInt.h b/Cantera/src/transport/MMCollisionInt.h index 4bc0c3e17..0db470d6b 100644 --- a/Cantera/src/transport/MMCollisionInt.h +++ b/Cantera/src/transport/MMCollisionInt.h @@ -28,14 +28,25 @@ namespace Cantera { class XML_Writer; + + //! Error handler class for collision integrals + /*! + * This class doesn't + */ class MMCollisionIntError { public: + + //! Constructor + /*! + * @param logfile ostream reference for writing out errors + * @param msg error message + */ MMCollisionIntError(std::ostream& logfile, std::string msg) { logfile << "#### ERROR ####" << std::endl; logfile << "MMCollisionInt: " << msg << std::endl; std::cerr << "Error in fitting collision integrals. " - << "Execution terminated." << std::endl - << "See transport log file for more information." << std::endl; + << "Execution terminated." << std::endl + << "See transport log file for more information." << std::endl; } }; @@ -70,44 +81,127 @@ namespace Cantera { * @param loglevel Set the loglevel for the object. The default * loglevel is zero, indicating no output. */ - void init(XML_Writer* xml, doublereal tsmin, - doublereal tsmax, int loglevel = 0); + void init(XML_Writer* xml, doublereal tsmin, doublereal tsmax, int loglevel = 0); - + //! omega22 + /*! + * @param ts + * @param deltastar + */ doublereal omega22(double ts, double deltastar); + + //! astar + /*! + * @param ts + * @param deltastar + */ doublereal astar(double ts, double deltastar); + + //! bstar + /*! + * @param ts + * @param deltastar + */ doublereal bstar(double ts, double deltastar); + + //! cstar + /*! + * @param ts + * @param deltastar + */ doublereal cstar(double ts, double deltastar); + //! fit + /*! + * @param logfile + * @param degree + * @param deltastar + * @param astar + * @param bstar + * @param cstar + */ void fit(std::ostream& logfile, int degree, doublereal deltastar, doublereal* astar, doublereal* bstar, doublereal* cstar); + //! fit_omega22 + /*! + * @param logfile + * @param degree + * @param deltastar + * @param om22 + */ void fit_omega22(std::ostream& logfile, int degree, doublereal deltastar, doublereal* om22); + + //! omega11 + /*! + * @param ts + * @param deltastar + */ doublereal omega11(double ts, double deltastar) { return omega22(ts, deltastar)/astar(ts, deltastar); } private: - doublereal fitDelta(int table, int ntstar, - int degree, doublereal* c); + //! Fit delta + /*! + * @param table + * @param ntstar + * @param degree + * @param c C is probable the output vector + * + * @return + */ + doublereal fitDelta(int table, int ntstar, int degree, doublereal* c); + //! m_o22poly std::vector m_o22poly; + + //! m_apoly std::vector m_apoly; + //! m_bpoly std::vector m_bpoly; + + //! m_cpoly std::vector m_cpoly; + //! delta static doublereal delta[8]; + + //! tstar22 static doublereal tstar22[37]; + + //! Table of omega22 values from MM static doublereal omega22_table[37*8]; + + //! tstar + /*! + * table of tstar values + */ static doublereal tstar[39]; + + //! astar table from MM static doublereal astar_table[39*8]; + + //! bstar table from MM static doublereal bstar_table[39*8]; + + //! cstar table from MM static doublereal cstar_table[39*8]; + //! Log temp vector_fp m_logTemp; - int m_nmin, m_nmax; + + //! nmin + int m_nmin; + + //! nmax + int m_nmax; + + //! XML_Writer pointer XML_Writer* m_xml; + + //! loglevel int m_loglevel; }; }