Doxygen update

-> no source code changed.
This commit is contained in:
Harry Moffat 2009-12-13 17:30:36 +00:00
parent d99352f3d1
commit ccd01f5125
2 changed files with 26 additions and 6 deletions

View file

@ -1,7 +1,10 @@
/**
*
* @file SimpleTransport.h
* Header file defining class SimpleTransport
* Header file for the class SimpleTransport which provides simple
* transport properties for liquids and solids
* (see \ref tranprops and \link Cantera::SimpleTransport SimpleTransport \endlink) .
*/
/*
* $Revision$
@ -123,7 +126,7 @@ namespace Cantera {
* In the second part, a mixing rule is applied, based on the
* Wilkes correlation, to yield the mixture viscosity.
*
*
* @ingroup tranprops
*
*/
class SimpleTransport : public Transport {

View file

@ -1,7 +1,8 @@
/**
* @file TransportBase.h
* Headers for the Transport object, which is the virtual base class
* for all transport property evaluators and also includes the tranprops group definition
* for all transport property evaluators and also includes the
* tranprops group definition
* (see \ref tranprops and \link Cantera::Transport Transport \endlink) .
*
* Provides class Transport.
@ -74,6 +75,10 @@ namespace Cantera {
* Transport is meant to be used as a base class only. It is
* possible to instantiate it, but its methods throw exceptions if
* called.
*
* All member functions are virtual, unless otherwise stated.
*
* @ingroup tranprops
*/
class Transport {
@ -456,9 +461,21 @@ namespace Cantera {
{ err("getMixDiffCoeffs"); }
/**
* Set transport model parameters. This method may be
* overloaded in subclasses to set model-specific parameters.
//! Set transport model parameters.
/*!
* This method may be
* overloaded in subclasses to set model-specific parameters.
* The primary use of this class is to set parameters while in the
* middle of a calculation.
*
* @param type Specifies the type of parameters to set
* 0 : Diffusion coefficient
* 1 : Thermal Conductivity
* The rest are currently unused.
* @param k Species index to set the parameters on
* @param p Vector of parameters. The length of the vector
* varies with the parameterization
*/
virtual void setParameters(const int type, const int k,
const doublereal* const p);