Skip to content

Commit

Permalink
[docs] Fix doxygen documentation of physical constants
Browse files Browse the repository at this point in the history
  • Loading branch information
ischoegl authored and speth committed Jul 16, 2023
1 parent ca8ef11 commit b27cb8c
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions include/cantera/base/ct_defs.h
Expand Up @@ -47,13 +47,20 @@ using std::function;
using std::pair;

/*!
* All physical constants are stored here.
*
* @defgroup physConstants Physical Constants
* @brief Physical constants used by %Cantera.
*
* %Cantera uses the MKS system of units. The unit for moles
* is defined to be the kmol. All values of physical constants
* are consistent with the 2018 CODATA recommendations.
* @ingroup globalData
*/

//! @addtogroup physConstants
//! @{

/**
* @name Numerical Constants
* @{
*/

Expand All @@ -66,8 +73,8 @@ const double Sqrt2 = 1.41421356237309504880;
//! @}
//! @name Defined Constants
//!
//! These constants are defined by CODATA to have a particular value.
//! https://physics.nist.gov/cuu/Constants/index.html
//! These constants are defined by CODATA to have a particular value; see
//! [NIST Reference on Constants, Units, and Uncertainty](https://physics.nist.gov/cuu/Constants/index.html).
//! @{

//! Avogadro's Number \f$ N_{\mathrm{A}} \f$ [number/kmol]
Expand Down Expand Up @@ -130,6 +137,9 @@ const double permeability_0 = 2 * fineStructureConstant * Planck / (ElectronChar
const double epsilon_0 = 1.0 / (lightSpeed * lightSpeed * permeability_0);

//! @}

//! @}

//! @name Thermodynamic Equilibrium Constraints
//!
//! Integer numbers representing pairs of thermodynamic variables
Expand Down

0 comments on commit b27cb8c

Please sign in to comment.