Skip to content

Commit

Permalink
[Doc] Move Phase and ThermoPhase into base 'thermoprops' group
Browse files Browse the repository at this point in the history
  • Loading branch information
speth committed Aug 16, 2023
1 parent e6a1e0d commit 04a7721
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 14 deletions.
14 changes: 1 addition & 13 deletions include/cantera/thermo/Phase.h
Expand Up @@ -19,18 +19,6 @@ namespace Cantera
class Solution;
class Species;

/**
* @defgroup phases Models of Phases of Matter
*
* These classes are used to represent the composition and state of a single
* phase of matter. Together these classes form the basis for describing the
* species and element compositions of a phase as well as the stoichiometry
* of each species, and for describing the current state of the phase. They do
* not in themselves contain Thermodynamic equation of state information.
* However, they do comprise all of the necessary background functionality to
* support thermodynamic calculations (see @ref thermoprops).
*/

//! Class Phase is the base class for phases of matter, managing the species and
//! elements in a phase, as well as the independent variables of temperature,
//! mass density (compressible substances) or pressure (incompressible
Expand Down Expand Up @@ -101,7 +89,7 @@ class Species;
* Jacobian and some analytical Jacobians use non-conforming calculations.
* These can easily be changed to the set mole number setState functions.
*
* @ingroup phases
* @ingroup thermoprops
*/
class Phase
{
Expand Down
1 change: 0 additions & 1 deletion include/cantera/thermo/ThermoPhase.h
Expand Up @@ -385,7 +385,6 @@ enum class ThermoBasis
* the reverse rate constant.
*
* @ingroup thermoprops
* @ingroup phases
*/
class ThermoPhase : public Phase
{
Expand Down

0 comments on commit 04a7721

Please sign in to comment.