GreenPolyProducts/cantera
5
0
Fork 0
mirror of https://github.com/Cantera/cantera.git synced 2025-02-25 18:55:29 -06:00
Code Issues Packages Projects Releases Wiki Activity

[transport] simplified docstrings for critical property methods

Browse Source
This commit is contained in:
Christopher Neal 2025-01-22 17:42:16 -05:00
parent b728ea36fa
commit bf3de6e526
1 changed files with 9 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
include/cantera/transport/HighPressureGasTransport.h
View File

@ -342,32 +342,16 @@ protected:
*/
void initializeCriticalProperties();
/**
* Returns the stored value of the critical temperature.
*
* @param i Species index
*/
//! Returns the stored value of the critical temperature for species 'i'.
double Tcrit_i(size_t i);
/**
* Returns the stored value of the critical pressure.
*
* @param i Species index
*/
//! Returns the stored value of the critical pressure for species 'i'.
double Pcrit_i(size_t i);
/**
* Returns the stored value of the critical volume.
*
* @param i Species index
*/
//! Returns the stored value of the critical volume for species 'i'.
double Vcrit_i(size_t i);
/**
* Returns the stored value of the critical compressibility.
*
* @param i Species index
*/
//! Returns the stored value of the critical compressibility for species 'i'.
double Zcrit_i(size_t i);
/**
@ -975,32 +959,16 @@ protected:
//! Computes and stores pure-fluid specific properties each species.
void initializePureFluidProperties();
/**
* Returns the stored value of the critical temperature.
*
* @param i Species index
*/
//! Returns the stored value of the critical temperature for a species 'i'.
double Tcrit_i(size_t i);
/**
* Returns the stored value of the critical pressure.
*
* @param i Species index
*/
//! Returns the stored value of the critical pressure for a species 'i'.
double Pcrit_i(size_t i);
/**
* Returns the stored value of the critical volume.
*
* @param i Species index
*/
//! Returns the stored value of the critical volume for a species 'i'.
double Vcrit_i(size_t i);
/**
* Returns the stored value of the critical compressibility.
*
* @param i Species index
*/
//! Returns the stored value of the critical compressibility for a species 'i'.
double Zcrit_i(size_t i);
/**
@ -1374,7 +1342,7 @@ protected:
* @param acentric_factor Acentric factor [unitless]
* @param mu_r Dipole moment [Debye]
* @param kappa Polar correction factor [unitless]
* @return double
* @return High pressure thermal conductivity [W/m/K]
*/
double highPressureThermalConductivity(double T, double T_star, double MW,
double rho, double Cv, double Vc, double Tc, double sigma,