Doxygen update
This commit is contained in:
parent
8af154e295
commit
4a1b09fd58
3 changed files with 24 additions and 27 deletions
|
|
@ -14,9 +14,9 @@ using namespace std;
|
|||
|
||||
namespace Cantera {
|
||||
|
||||
//====================================================================================================================
|
||||
/**
|
||||
* Exception thrown if an error is encountered while reading the
|
||||
* transport database.
|
||||
* Exception thrown if an error is encountered while reading the transport database.
|
||||
*/
|
||||
class LTPError : public CanteraError {
|
||||
public:
|
||||
|
|
@ -25,12 +25,18 @@ namespace Cantera {
|
|||
"error parsing transport data: "
|
||||
+ msg + "\n") {}
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* getArrhenius() parses the xml element called Arrhenius.
|
||||
//====================================================================================================================
|
||||
//! getArrhenius() parses the xml element called Arrhenius.
|
||||
/*!
|
||||
* The Arrhenius expression is
|
||||
* \f[ k = A T^(b) exp (-E_a / RT). \f]
|
||||
* \f[
|
||||
* k = A T^(b) exp (-E_a / RT)
|
||||
* \f]
|
||||
*
|
||||
* @param node XML_Node to be read
|
||||
* @param A Output pre-exponential factor. The units are variable.
|
||||
* @param b output temperature power
|
||||
* @param E Output activation energy in units of Kelvin
|
||||
*/
|
||||
static void getArrhenius(const XML_Node& node,
|
||||
doublereal& A, doublereal& b, doublereal& E) {
|
||||
|
|
@ -41,15 +47,15 @@ namespace Cantera {
|
|||
E = getFloat(node, "E", "actEnergy");
|
||||
E /= GasConstant;
|
||||
}
|
||||
|
||||
//====================================================================================================================
|
||||
// Copy constructor
|
||||
LTPspecies::LTPspecies( const LTPspecies &right )
|
||||
LTPspecies::LTPspecies(const LTPspecies &right)
|
||||
{
|
||||
*this = right; //use assignment operator to do other work
|
||||
}
|
||||
|
||||
//====================================================================================================================
|
||||
// Assignment operator
|
||||
LTPspecies& LTPspecies::operator=(const LTPspecies& right )
|
||||
LTPspecies& LTPspecies::operator=(const LTPspecies& right)
|
||||
{
|
||||
if (&right != this) {
|
||||
m_speciesName = right.m_speciesName;
|
||||
|
|
@ -98,7 +104,7 @@ namespace Cantera {
|
|||
{
|
||||
*this = right; //use assignment operator to do other work
|
||||
}
|
||||
//====================================================================================================================
|
||||
//====================================================================================================================
|
||||
// Assignment operator
|
||||
LTPspecies_Const& LTPspecies_Const::operator=(const LTPspecies_Const& right )
|
||||
{
|
||||
|
|
@ -129,7 +135,6 @@ namespace Cantera {
|
|||
return m_coeffs[0];
|
||||
}
|
||||
//====================================================================================================================
|
||||
|
||||
// Construct an LTPspecies object for a liquid tranport property
|
||||
// expressed in extended Arrhenius form.
|
||||
/* The transport property is constructed from the XML node,
|
||||
|
|
@ -318,11 +323,7 @@ namespace Cantera {
|
|||
//cout << "m_prop = " << m_prop << endl;
|
||||
return m_prop;
|
||||
}
|
||||
|
||||
//====================================================================================================================
|
||||
|
||||
///////////////////////////////////////////////////////////////
|
||||
|
||||
// Construct an LTPspecies object for a liquid tranport property
|
||||
// expressed as an exponential in temperature.
|
||||
/* The transport property is constructed from the XML node,
|
||||
|
|
@ -339,8 +340,6 @@ namespace Cantera {
|
|||
m_model = LTR_MODEL_EXPT;
|
||||
m_temp = 0.0;
|
||||
m_prop = 0.0;
|
||||
|
||||
|
||||
getFloatArray(propNode, m_coeffs, "true", "toSI");
|
||||
|
||||
/* if (m_coeffs[0] <= 0.0) {
|
||||
|
|
@ -402,6 +401,5 @@ namespace Cantera {
|
|||
//cout << "m_prop = " << m_prop << endl;
|
||||
return m_prop;
|
||||
}
|
||||
|
||||
//====================================================================================================================
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1467,12 +1467,11 @@ namespace Cantera {
|
|||
m_selfDiff_temp_ok = true;
|
||||
m_selfDiff_mix_ok = false;
|
||||
}
|
||||
|
||||
//=============================================================================================================
|
||||
void LiquidTransport::updateHydrodynamicRadius_C() {
|
||||
m_radi_conc_ok = true;
|
||||
}
|
||||
|
||||
|
||||
//=============================================================================================================
|
||||
// Update the temperature-dependent hydrodynamic radius terms
|
||||
// for each species internally using calls to the
|
||||
// appropriate LTPspecies subclass
|
||||
|
|
|
|||
|
|
@ -877,7 +877,7 @@ namespace Cantera {
|
|||
* @internal
|
||||
*/
|
||||
void updateHydrodynamicRadius_C();
|
||||
|
||||
|
||||
//! Update the binary Stefan-Maxwell diffusion coefficients
|
||||
//! wrt T using calls to the appropriate LTPspecies subclass
|
||||
void updateDiff_T();
|
||||
|
|
@ -1025,14 +1025,14 @@ namespace Cantera {
|
|||
DenseMatrix m_diff_Dij;
|
||||
|
||||
|
||||
//!Hydrodynamic radius for each species expressed as an
|
||||
//! appropriate subclass of LTPspecies
|
||||
//! Hydrodynamic radius for each species expressed as an appropriate subclass of LTPspecies
|
||||
/*!
|
||||
* These subclasses of LTPspecies evaluate the species-specific
|
||||
* transport properties according to the parameters parsed in
|
||||
* TransportFactory::getLiquidSpeciesTransportData().
|
||||
* length = nsp
|
||||
*/
|
||||
std::vector<LTPspecies*> m_radiusTempDep_Ns;
|
||||
std::vector<LTPspecies *> m_radiusTempDep_Ns;
|
||||
|
||||
//! (Not used in LiquidTransport)
|
||||
//! Hydrodynamic radius of the mixture expressed as a subclass of
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue