[Doc] Add Transport classes to the tranprops group

This commit is contained in:
Ray Speth 2013-06-19 22:08:58 +00:00
parent d21a6a7be9
commit ca3057ce08
10 changed files with 11 additions and 9 deletions

View file

@ -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
{

View file

@ -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
{

View file

@ -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:

View file

@ -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
{

View file

@ -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
{

View file

@ -17,6 +17,7 @@
namespace Cantera
{
//! Class SolidTransport implements transport properties for solids.
//! @ingroup tranprops
class SolidTransport : public Transport
{
public:

View file

@ -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);

View file

@ -27,6 +27,7 @@ class WaterProps;
class PDSS_Water;
//! Transport Parameters for pure water
//! @ingroup tranprops
class WaterTransport : public Transport
{
public:

View file

@ -1,8 +1,6 @@
/**
* @file DustyGasTransport.cpp
* Implementation file for class DustyGasTransport
*
* @ingroup transportProps
*/
/*

View file

@ -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
{