[Doc] Fix a few Doxygen warnings
This commit is contained in:
parent
147d630f48
commit
63dd02073c
5 changed files with 13 additions and 8 deletions
|
|
@ -15,7 +15,7 @@ namespace Cantera
|
|||
*
|
||||
* This struct stores the value of some property evaluated at a particular
|
||||
* thermodynamic state. The #value can be either a real scalar or an array,
|
||||
* depending on the template parameter #T. The exact meaning of #state1,
|
||||
* depending on the template parameter `T`. The exact meaning of #state1,
|
||||
* #state2, and #stateNum is determined by the function using the cached value,
|
||||
* which can check any combination of these variables before deciding whether
|
||||
* to recompute the cached values.
|
||||
|
|
|
|||
|
|
@ -132,7 +132,7 @@ public:
|
|||
* @param useThermoPhaseElementPotentials get the initial estimate for the
|
||||
* chemical potentials from the ThermoPhase object (true) or create
|
||||
* our own estimate (false)
|
||||
* @param loglvel Specify amount of debug logging (0 to disable)
|
||||
* @param loglevel Specify amount of debug logging (0 to disable)
|
||||
* @return Successful returns are indicated by a return value of 0.
|
||||
* Unsuccessful returns are indicated by a return value of -1 for lack
|
||||
* of convergence or -3 for a singular jacobian.
|
||||
|
|
|
|||
|
|
@ -140,7 +140,7 @@ public:
|
|||
*
|
||||
* @return standard state free energy in Kelvin.
|
||||
*/
|
||||
virtual double G0_R_calc(size_t kspec, double TKelvin);
|
||||
virtual double G0_R_calc(size_t kglob, double TKelvin);
|
||||
|
||||
/**
|
||||
* This function calculates the standard state molar volume
|
||||
|
|
|
|||
|
|
@ -183,8 +183,10 @@ public:
|
|||
|
||||
//! Solve the matrix problem Ax = b
|
||||
/*!
|
||||
* @param b INPUT rhs of the problem
|
||||
* OUTPUT solution to the problem
|
||||
* @param b INPUT rhs of the problem
|
||||
* OUTPUT solution to the problem
|
||||
* @param nrhs Number of right hand sides to solve
|
||||
* @param ldb Leading dimension of `b`. Default is nColumns()
|
||||
*
|
||||
* @return Return a success flag
|
||||
* 0 indicates a success
|
||||
|
|
|
|||
|
|
@ -180,11 +180,14 @@ protected:
|
|||
//! Pointer to the homogeneous Kinetics object that handles the reactions
|
||||
Kinetics* m_kin;
|
||||
|
||||
//! Tolerance on the temperature
|
||||
doublereal m_vdot, m_Q;
|
||||
doublereal m_vdot; //!< net rate of volume change from moving walls [m^3/s]
|
||||
doublereal m_Q; //!< net heat transfer through walls [W]
|
||||
doublereal m_mass; //!< total mass
|
||||
vector_fp m_work;
|
||||
vector_fp m_sdot; // surface production rates
|
||||
|
||||
//! Production rates of gas phase species on surfaces [kmol/s]
|
||||
vector_fp m_sdot;
|
||||
|
||||
vector_fp m_wdot; //!< Species net molar production rates
|
||||
vector_fp m_uk; //!< Species molar internal energies
|
||||
bool m_chem;
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue