From ca3057ce08cab667aa34733c4bda98e024a73ace Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Wed, 19 Jun 2013 22:08:58 +0000 Subject: [PATCH] [Doc] Add Transport classes to the tranprops group --- include/cantera/transport/AqueousTransport.h | 1 + include/cantera/transport/DustyGasTransport.h | 1 + include/cantera/transport/GasTransport.h | 1 + include/cantera/transport/MixTransport.h | 2 +- include/cantera/transport/MultiTransport.h | 2 +- include/cantera/transport/SolidTransport.h | 1 + include/cantera/transport/TransportFactory.h | 7 +++---- include/cantera/transport/WaterTransport.h | 1 + src/transport/DustyGasTransport.cpp | 2 -- src/transport/MMCollisionInt.h | 2 +- 10 files changed, 11 insertions(+), 9 deletions(-) diff --git a/include/cantera/transport/AqueousTransport.h b/include/cantera/transport/AqueousTransport.h index f3906aff2..3d0a8e1fa 100644 --- a/include/cantera/transport/AqueousTransport.h +++ b/include/cantera/transport/AqueousTransport.h @@ -101,6 +101,7 @@ class LiquidTransportParams; * In the first part, the viscosity of the pure species are calculated * In the second part, a mixing rule is applied, based on the * Wilkes correlation, to yield the mixture viscosity. + * @ingroup tranprops */ class AqueousTransport : public Transport { diff --git a/include/cantera/transport/DustyGasTransport.h b/include/cantera/transport/DustyGasTransport.h index 115db8690..d3c12f75e 100644 --- a/include/cantera/transport/DustyGasTransport.h +++ b/include/cantera/transport/DustyGasTransport.h @@ -57,6 +57,7 @@ namespace Cantera * (4) J. W. Veldsink, R. M. J. van Damme, G. F. Versteeg, W. P. M. van Swaaij, * "The use of the dusty gas model for the description of mass transport with chemical reaction in porous media," * Chemical Engineering Journal, 57, 115 - 125 (1995). + * @ingroup tranprops */ class DustyGasTransport : public Transport { diff --git a/include/cantera/transport/GasTransport.h b/include/cantera/transport/GasTransport.h index f70d76dca..1add65fa6 100644 --- a/include/cantera/transport/GasTransport.h +++ b/include/cantera/transport/GasTransport.h @@ -12,6 +12,7 @@ namespace Cantera //! Class GasTransport implements some functions and properties that are //! shared by the MixTransport and MultiTransport classes. +//! @ingroup tranprops class GasTransport : public Transport { public: diff --git a/include/cantera/transport/MixTransport.h b/include/cantera/transport/MixTransport.h index c90929fa2..24f59a9fb 100644 --- a/include/cantera/transport/MixTransport.h +++ b/include/cantera/transport/MixTransport.h @@ -51,7 +51,7 @@ class GasTransportParams; * The flux of energy has units of energy (kg m2 /s2) per second per area. * * The units of lambda are W / m K which is equivalent to kg m / s^3 K. - * + * @ingroup tranprops */ class MixTransport : public GasTransport { diff --git a/include/cantera/transport/MultiTransport.h b/include/cantera/transport/MultiTransport.h index 288c56387..8f3cbaa66 100644 --- a/include/cantera/transport/MultiTransport.h +++ b/include/cantera/transport/MultiTransport.h @@ -24,7 +24,7 @@ class GasTransportParams; * Coltrin, and Glarborg, "Theoretical and Practical Aspects of Chemically * Reacting Flow Modeling," Wiley Interscience. * - * @ingroup transportProps + * @ingroup tranprops */ class MultiTransport : public GasTransport { diff --git a/include/cantera/transport/SolidTransport.h b/include/cantera/transport/SolidTransport.h index e69d29bfc..06b20c2b3 100644 --- a/include/cantera/transport/SolidTransport.h +++ b/include/cantera/transport/SolidTransport.h @@ -17,6 +17,7 @@ namespace Cantera { //! Class SolidTransport implements transport properties for solids. +//! @ingroup tranprops class SolidTransport : public Transport { public: diff --git a/include/cantera/transport/TransportFactory.h b/include/cantera/transport/TransportFactory.h index b15a9c196..ec4a62f10 100644 --- a/include/cantera/transport/TransportFactory.h +++ b/include/cantera/transport/TransportFactory.h @@ -33,8 +33,7 @@ class XML_Node; * generating polynomial fits. Transport managers can also be created in * other ways. * - * @ingroup transportgroup - * @ingroup transportProps + * @ingroup tranprops */ class TransportFactory : public FactoryBase { @@ -407,7 +406,7 @@ private: * @param f ptr to the TransportFactory object if it's been malloced. * @param ndim Number of dimensions for transport fluxes * - * @ingroup transportProps + * @ingroup tranprops */ Transport* newTransportMgr(const std::string& transportModel = "", thermo_t* thermo = 0, int loglevel = 0, TransportFactory* f = 0, int ndim=1); @@ -420,7 +419,7 @@ Transport* newTransportMgr(const std::string& transportModel = "", thermo_t* th * allocated. * @return Returns a transport manager for the phase * - * @ingroup transportProps + * @ingroup tranprops */ Transport* newDefaultTransportMgr(thermo_t* thermo, int loglevel = 0, TransportFactory* f = 0); diff --git a/include/cantera/transport/WaterTransport.h b/include/cantera/transport/WaterTransport.h index 2eda6a5e1..7504e0a10 100644 --- a/include/cantera/transport/WaterTransport.h +++ b/include/cantera/transport/WaterTransport.h @@ -27,6 +27,7 @@ class WaterProps; class PDSS_Water; //! Transport Parameters for pure water +//! @ingroup tranprops class WaterTransport : public Transport { public: diff --git a/src/transport/DustyGasTransport.cpp b/src/transport/DustyGasTransport.cpp index 3b56df803..ab396282f 100644 --- a/src/transport/DustyGasTransport.cpp +++ b/src/transport/DustyGasTransport.cpp @@ -1,8 +1,6 @@ /** * @file DustyGasTransport.cpp * Implementation file for class DustyGasTransport - * - * @ingroup transportProps */ /* diff --git a/src/transport/MMCollisionInt.h b/src/transport/MMCollisionInt.h index 9947097fc..3270b22d2 100644 --- a/src/transport/MMCollisionInt.h +++ b/src/transport/MMCollisionInt.h @@ -20,7 +20,7 @@ class XML_Writer; * interpolate the tabulated collision integrals in Monchick and * Mason, "Transport Properties of Polar Gases," J. Chem. Phys. (1961) * - * @ingroup transportgroup + * @ingroup tranprops */ class MMCollisionInt {