From 57a2ca965ddaa3bbb77b8d7506f3bfc640584f88 Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Sat, 14 Aug 2010 18:02:39 +0000 Subject: [PATCH] doxygen update --- Cantera/src/transport/LTPspecies.cpp | 12 +++--- Cantera/src/transport/LTPspecies.h | 58 +++++++++++++++------------ Cantera/src/transport/TransportBase.h | 18 +++++---- 3 files changed, 49 insertions(+), 39 deletions(-) diff --git a/Cantera/src/transport/LTPspecies.cpp b/Cantera/src/transport/LTPspecies.cpp index c9d37f4c4..de0325347 100644 --- a/Cantera/src/transport/LTPspecies.cpp +++ b/Cantera/src/transport/LTPspecies.cpp @@ -331,11 +331,11 @@ namespace Cantera { * \verbatim \endverbatim node and specifies a type of * transport property (like viscosity) */ - LTPspecies_ExpT::LTPspecies_ExpT( const XML_Node &propNode, - std::string name, - TransportPropertyList tp_ind, - thermo_t* thermo ) : - LTPspecies( propNode, name, tp_ind, thermo) + LTPspecies_ExpT::LTPspecies_ExpT(const XML_Node &propNode, + std::string name, + TransportPropertyList tp_ind, + thermo_t* thermo) : + LTPspecies(propNode, name, tp_ind, thermo) { m_model = LTR_MODEL_EXPT; m_temp = 0.0; @@ -388,7 +388,7 @@ namespace Cantera { doublereal t = m_thermo->temperature(); if (t != m_temp) { - m_prop = 0; + m_prop = 0.0; m_temp=t; m_prop=m_coeffs[0]; double tempN = 1.0; diff --git a/Cantera/src/transport/LTPspecies.h b/Cantera/src/transport/LTPspecies.h index 00a1b9507..72d033623 100644 --- a/Cantera/src/transport/LTPspecies.h +++ b/Cantera/src/transport/LTPspecies.h @@ -67,14 +67,14 @@ namespace Cantera { }; //==================================================================================================================== - //! Class LTPspecies holds transport parameters for a - //! specific liquid-phase species. + //! Class LTPspecies holds transport parameters for a specific liquid-phase species. /*! * Subclasses handle different means of specifying transport properties * like constant, %Arrhenius or polynomial fits. In its current state, * it is primarily suitable for specifying temperature dependence, but * the adjustCoeffsForComposition() method can be implemented to * adjust for composition dependence. + * * Mixing rules for computing mixture transport properties are handled * separately in LiquidTranInteraction subclasses. */ @@ -83,15 +83,16 @@ namespace Cantera { public: //! Construct an LTPspecies object for a liquid tranport property. - /** 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) + /*! + * 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) */ LTPspecies(const XML_Node &propNode = 0, std::string name = "-", TransportPropertyList tp_ind = TP_UNKNOWN, - thermo_t* thermo = 0 ) : + const thermo_t* const thermo = 0) : m_speciesName(name), m_model(LTR_MODEL_NOTSET), m_property(tp_ind), @@ -99,7 +100,7 @@ namespace Cantera { m_mixWeight(1.0) { if (propNode.hasChild("mixtureWeighting") ) { - m_mixWeight = getFloat(propNode,"mixtureWeighting"); + m_mixWeight = getFloat(propNode, "mixtureWeighting"); } } @@ -145,11 +146,11 @@ namespace Cantera { //! Model temperature-dependence ceofficients vector_fp m_coeffs; - //! pointer to thermo object to get current temperature - thermo_t* m_thermo; + //! Pointer to a const thermo object to get current temperature + const thermo_t * m_thermo; //! Weighting used for mixing. - /** + /*! * This weighting can be employed to allow salt transport * properties to be represented by specific ions. * For example, to have Li+ and Ca+ represent the mixing @@ -163,9 +164,10 @@ namespace Cantera { doublereal m_mixWeight; //! Internal model to adjust species-specific properties for composition. - /** Currently just a place holder, but this method could take - * the composition from the thermo object and adjust coefficients - * accoding to some unspecified model. + /*! + * Currently just a place holder, but this method could take + * the composition from the thermo object and adjust coefficients + * accoding to some unspecified model. */ virtual void adjustCoeffsForComposition() { } }; @@ -427,14 +429,15 @@ namespace Cantera { }; //==================================================================================================================== - //! Class LTPspecies_ExpT holds transport parameters for a - //! specific liquid-phase species (LTPspecies) when the transport - //! property is expressed as a exponential in temperature. + //! Class LTPspecies_ExpT holds transport parameters for a specific liquid-phase species (LTPspecies) + //! when the transport property is expressed as a exponential in temperature. /** * Used for pure species properties with equations of the form - * \f[ - * x = f[0] \exp( f[1] T + ... + f[N] T ) - * \f] + * + * \f[ + * x = f[0] \exp( f[1] T + ... + f[N] T^{N} ) + * \f] + * * where f[i] are elements of the float array passed in. * * As an example of the input required for LTPspecies_ExpT @@ -459,18 +462,21 @@ namespace Cantera { //! Construct an LTPspecies object for a liquid tranport property //! expressed as an exponential in temperature. /*! - * 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) + * 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). + * + * @param propNode */ - LTPspecies_ExpT( const XML_Node &propNode, + LTPspecies_ExpT(const XML_Node &propNode, std::string name, TransportPropertyList tp_ind, thermo_t* thermo ); //! Copy constructor - LTPspecies_ExpT( const LTPspecies_ExpT &right ); + /*! + * @param right Object to be copied + */ + LTPspecies_ExpT(const LTPspecies_ExpT &right); //! Assignment operator LTPspecies_ExpT& operator=(const LTPspecies_ExpT& right ); diff --git a/Cantera/src/transport/TransportBase.h b/Cantera/src/transport/TransportBase.h index 667190ccc..4e42258ff 100644 --- a/Cantera/src/transport/TransportBase.h +++ b/Cantera/src/transport/TransportBase.h @@ -222,13 +222,16 @@ namespace Cantera { // Note ->need working copy constructors and operator=() functions for all first virtual Transport *duplMyselfAsTransport() const; - /** - * Transport model. The transport model is the set of - * equations used to compute the transport properties. This + + //! Transport model. + /*! + * The transport model is the set of equations used to compute the transport properties. This * virtual method returns an integer flag that identifies the * transport model implemented. The base class returns 0. */ - virtual int model() const {return 0;} + virtual int model() const { + return 0; + } /** * Phase object. Every transport manager is designed to compute @@ -237,7 +240,9 @@ namespace Cantera { * returns a reference to the object representing the phase * itself. */ - thermo_t& thermo() { return *m_thermo; } + thermo_t& thermo() { + return *m_thermo; + } /** @@ -495,8 +500,7 @@ namespace Cantera { * @param grad_X The gradient of the mole fraction * @param ldf Leading dimension of the grad_V and current vectors. * @param grad_V The electrostatic potential gradient. - * @param current The electric current in A/m^2. this is a vector - * of length ndim + * @param current The electric current in A/m^2. This is a vector of length ndim */ virtual void getElectricCurrent(int ndim, const doublereal* grad_T,