Doxygen update

This commit is contained in:
Harry Moffat 2010-08-14 01:44:28 +00:00
parent 61efb6ec90
commit 15608ed25d
3 changed files with 35 additions and 20 deletions

View file

@ -491,7 +491,6 @@ namespace Cantera {
* These in turn employ subclasses of LTPspecies to
* determine the individual species ionic conductivities.
*/
doublereal LiquidTransport:: ionConductivity() {
update_T();
@ -550,10 +549,10 @@ namespace Cantera {
// LiquidTranInteraction method
if (!m_mobRat_mix_ok) {
for (int k = 0; k < m_nsp2; k++){
if(m_mobRatMixModel[k]){
if (m_mobRatMixModel[k]) {
m_mobRatMix[k] = m_mobRatMixModel[k]->getMixTransProp(m_mobRatTempDep_Ns[k]);
if (m_mobRatMix[k] > 0) {
m_mobRatMix[k/m_nsp+m_nsp*(k%m_nsp)] = 1.0/m_mobRatMix[k]; // Also must be off diagonal: k%(1+n)!=0, but then m_mobRatMixModel[k] shouldn't be initialized anyway
if (m_mobRatMix[k] > 0.0) {
m_mobRatMix[k / m_nsp + m_nsp * (k % m_nsp)] = 1.0 / m_mobRatMix[k]; // Also must be off diagonal: k%(1+n)!=0, but then m_mobRatMixModel[k] shouldn't be initialized anyway
}
}
}
@ -577,8 +576,8 @@ namespace Cantera {
if (!m_mobRat_temp_ok) {
updateMobilityRatio_T();
}
for (int k=0; k < m_nsp2; k++) {
for (int j=0; j < m_nsp; j++) {
for (int k = 0; k < m_nsp2; k++) {
for (int j = 0; j < m_nsp; j++) {
mobRat[k][j] = m_mobRatSpecies(k,j);
}
}
@ -1513,7 +1512,7 @@ namespace Cantera {
return;
}
//====================================================================================================================
/*
*
* Solve for the diffusional velocities in the Stefan-Maxwell equations
@ -1782,20 +1781,18 @@ namespace Cantera {
}
}
}
/**
* Throw an exception if this method is invoked.
* This probably indicates something is not yet implemented.
//====================================================================================================================
// Throw an exception indicating something is not yet implemented.
/*
* @param msg String with an informative message
*/
doublereal LiquidTransport::err(std::string msg) const {
throw CanteraError("Liquid Transport Class",
throw CanteraError("LiquidTransport::err()",
"\n\n\n**** Method "+ msg +" not implemented in model "
+ int2str(model()) + " ****\n"
"(Did you forget to specify a transport model?)\n\n\n");
return 0.0;
}
//====================================================================================================================
}
//======================================================================================================================

View file

@ -1441,7 +1441,7 @@ namespace Cantera {
/*!
* This probably indicates something is not yet implemented.
*
* @pram msg Indicates the member function which is not implemented
* @param msg Indicates the member function which is not implemented
*/
doublereal err(std::string msg) const;

View file

@ -72,7 +72,7 @@ namespace Cantera {
* <speciesB> Cl- </speciesB>
* <Dij units="m2/s"> 1.2 </Dij>
* </interaction>
* </compositionDependence>
* </compositionDependence>
* </speciesDiffusivity>
* <thermalConductivity>
* <compositionDependence model="massFractions"/>
@ -124,9 +124,27 @@ namespace Cantera {
//! Object that specifes the ionic Conductivity of the mixture
LiquidTranInteraction* ionConductivity;
std::vector<LiquidTranInteraction*> mobilityRatio;
std::vector<LiquidTranInteraction*> selfDiffusion;
//! Vector of pointer to the LiquidTranInteraction object which handles the calculation of
//! each species' mobility ratios for the phase
/*!
* mobRat(i,j) = mu_i / mu_j
*
* It is returned in fortran-ordering format. ie. it is returned as mobRat[k], where
*
* k = j * nsp + i
*/
std::vector<LiquidTranInteraction *> mobilityRatio;
//! Vector of pointer to the LiquidTranInteraction object which handles the calculation of
//! each species' self diffusion coefficient for the phase
std::vector<LiquidTranInteraction *> selfDiffusion;
//! Pointer to the LiquidTranInteraction object which handles the calculation of the
//! mixture thermal conductivity for the phase
LiquidTranInteraction* thermalCond;
//! Pointer to the LiquidTranInteraction object which handles the calculation of the
//! species diffusivity for the phase
LiquidTranInteraction* speciesDiffusivity;
//! Pointer to the LiquidTranInteraction object which handles the calculation of the