From 438fea4660566f03a7da816ee83c22b0f6650aed Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Mon, 16 Aug 2010 20:01:30 +0000 Subject: [PATCH] Doxygen update --- Cantera/src/transport/LTPspecies.cpp | 28 ++++++++++++----- Cantera/src/transport/LTPspecies.h | 45 ++++++++++++++++++---------- 2 files changed, 50 insertions(+), 23 deletions(-) diff --git a/Cantera/src/transport/LTPspecies.cpp b/Cantera/src/transport/LTPspecies.cpp index 2b61d35a7..17c74db7e 100644 --- a/Cantera/src/transport/LTPspecies.cpp +++ b/Cantera/src/transport/LTPspecies.cpp @@ -62,7 +62,7 @@ namespace Cantera { * @param thermo const pointer to the ThermoPhase object, which is used to find the temperature. */ LTPspecies::LTPspecies(const XML_Node * const propNode, std::string name, - TransportPropertyType tp_ind, const thermo_t* const thermo) : + TransportPropertyType tp_ind, const thermo_t * thermo) : m_speciesName(name), m_model(LTR_MODEL_NOTSET), m_property(tp_ind), @@ -200,13 +200,22 @@ namespace Cantera { //==================================================================================================================== // Construct an LTPspecies object for a liquid tranport property // expressed in extended Arrhenius form. - /* The transport property is constructed from the XML node, + /* + * The transport property is constructed from the XML node, * \verbatim , \endverbatim that is a child of the - * \verbatim \endverbatim node and specifies a type of - * transport property (like viscosity) + * \verbatim \endverbatim node and specifies a type of transport property (like viscosity) + * + * + * @param propNode Referenc to the XML node that contains the property information.This class + * is assumed to be parameterized by reading XML_Node information. + * @param name String containing the species name + * @param tp_ind enum TransportPropertyType containing the property id that this object + * is creating a parameterization for (e.g., viscosity) + * @param thermo const pointer to the ThermoPhase object, which is used to find the temperature. + * */ LTPspecies_Arrhenius::LTPspecies_Arrhenius(const XML_Node &propNode, std::string name, - TransportPropertyType tp_ind, thermo_t* thermo) : + TransportPropertyType tp_ind, const thermo_t* thermo) : LTPspecies(&propNode, name, tp_ind, thermo) { m_model = LTR_MODEL_ARRHENIUS; @@ -251,6 +260,11 @@ namespace Cantera { return *this; } //==================================================================================================================== + // Destructor + LTPspecies_Arrhenius::~LTPspecies_Arrhenius() + { + } + //==================================================================================================================== // Duplication routine /* * @return Returns a copy of this routine as a pointer to LTPspecies @@ -312,7 +326,7 @@ namespace Cantera { * transport property (like viscosity) */ LTPspecies_Poly::LTPspecies_Poly(const XML_Node &propNode, std::string name, - TransportPropertyType tp_ind, thermo_t* thermo) : + TransportPropertyType tp_ind, const thermo_t* thermo) : LTPspecies(&propNode, name, tp_ind, thermo) { m_model = LTR_MODEL_POLY; @@ -389,7 +403,7 @@ namespace Cantera { * transport property (like viscosity) */ LTPspecies_ExpT::LTPspecies_ExpT(const XML_Node &propNode, std::string name, TransportPropertyType tp_ind, - thermo_t* thermo) : + const thermo_t* thermo) : LTPspecies(&propNode, name, tp_ind, thermo) { m_model = LTR_MODEL_EXPT; diff --git a/Cantera/src/transport/LTPspecies.h b/Cantera/src/transport/LTPspecies.h index 9c128f165..b0be5b6f1 100644 --- a/Cantera/src/transport/LTPspecies.h +++ b/Cantera/src/transport/LTPspecies.h @@ -102,7 +102,7 @@ namespace Cantera { * @param thermo const pointer to the ThermoPhase object, which is used to find the temperature. */ LTPspecies(const XML_Node * const propNode = 0, std::string name = "-", - TransportPropertyType tp_ind = TP_UNKNOWN, const thermo_t* const thermo = 0); + TransportPropertyType tp_ind = TP_UNKNOWN, const thermo_t* thermo = 0); //! Copy constructor /*! @@ -300,21 +300,34 @@ namespace Cantera { /*! * The transport property is constructed from the XML node, * \verbatim , \endverbatim that is a child of the - * \verbatim \endverbatim node and specifies a type of - * transport property (like viscosity) + * \verbatim \endverbatim node and specifies a type of transport property (like viscosity) + * + * + * @param propNode Referenc to the XML node that contains the property information.This class + * is assumed to be parameterized by reading XML_Node information. + * @param name String containing the species name + * @param tp_ind enum TransportPropertyType containing the property id that this object + * is creating a parameterization for (e.g., viscosity) + * @param thermo const pointer to the ThermoPhase object, which is used to find the temperature. + * */ - LTPspecies_Arrhenius( const XML_Node &propNode, - std::string name, - TransportPropertyType tp_ind, - thermo_t* thermo ); + LTPspecies_Arrhenius(const XML_Node &propNode, std::string name, + TransportPropertyType tp_ind, const thermo_t * thermo); //! Copy constructor - LTPspecies_Arrhenius( const LTPspecies_Arrhenius &right ); + /*! + * @param Object to be copied + */ + LTPspecies_Arrhenius(const LTPspecies_Arrhenius &right); //! Assignment operator - LTPspecies_Arrhenius& operator=(const LTPspecies_Arrhenius& right); + /*! + * @param Object to be copied + */ + LTPspecies_Arrhenius& operator=(const LTPspecies_Arrhenius& right); - virtual ~LTPspecies_Arrhenius( ) { } + //! Destructor + virtual ~LTPspecies_Arrhenius(); //! duplication routine /*! @@ -397,16 +410,16 @@ namespace Cantera { * \verbatim \endverbatim node and specifies a type of * transport property (like viscosity) */ - LTPspecies_Poly( const XML_Node &propNode, + LTPspecies_Poly(const XML_Node &propNode, std::string name, TransportPropertyType tp_ind, - thermo_t* thermo ); + const thermo_t * thermo); //! Copy constructor - LTPspecies_Poly( const LTPspecies_Poly &right ); + LTPspecies_Poly(const LTPspecies_Poly &right); //! Assignment operator - LTPspecies_Poly& operator=(const LTPspecies_Poly& right ); + LTPspecies_Poly& operator=(const LTPspecies_Poly& right); //! Destructor virtual ~LTPspecies_Poly() { } @@ -477,7 +490,7 @@ namespace Cantera { LTPspecies_ExpT(const XML_Node &propNode, std::string name, TransportPropertyType tp_ind, - thermo_t* thermo ); + const thermo_t* thermo); //! Copy constructor /*! @@ -486,7 +499,7 @@ namespace Cantera { LTPspecies_ExpT(const LTPspecies_ExpT &right); //! Assignment operator - LTPspecies_ExpT& operator=(const LTPspecies_ExpT& right ); + LTPspecies_ExpT& operator=(const LTPspecies_ExpT& right); virtual ~LTPspecies_ExpT() { }