From 3dc0d96051fdac5ad1ddf428161f7251b0ea608d Mon Sep 17 00:00:00 2001 From: Ingmar Schoegl Date: Fri, 7 Jul 2023 07:37:51 -0600 Subject: [PATCH] [docs] Consolidate chemical equilibrium documentation --- include/cantera/equil/ChemEquil.h | 5 +++-- include/cantera/equil/MultiPhase.h | 13 +++++-------- include/cantera/equil/MultiPhaseEquil.h | 2 +- include/cantera/equil/vcs_MultiPhaseEquil.h | 2 +- include/cantera/equil/vcs_solve.h | 4 ++-- include/cantera/thermo/ThermoPhase.h | 4 ++-- src/equil/MultiPhase.cpp | 2 +- 7 files changed, 15 insertions(+), 17 deletions(-) diff --git a/include/cantera/equil/ChemEquil.h b/include/cantera/equil/ChemEquil.h index d51e9785e9..4ec1889f8f 100644 --- a/include/cantera/equil/ChemEquil.h +++ b/include/cantera/equil/ChemEquil.h @@ -52,7 +52,8 @@ class EquilOpt }; /** - * @defgroup equil Chemical Equilibrium + * @defgroup equilGroup Chemical Equilibrium + * @details Classes and functions used for calculating chemical equilibrium. */ /** @@ -72,7 +73,7 @@ class EquilOpt * non-zero mole fractions, precisely stoichiometric compositions (for example, * 2 H2 + O2). In general, if speed is important, this solver should be tried first, * and if it fails then use MultiPhaseEquil. - * @ingroup equil + * @ingroup equilGroup */ class ChemEquil { diff --git a/include/cantera/equil/MultiPhase.h b/include/cantera/equil/MultiPhase.h index 5b1410ac37..5f33f743e2 100644 --- a/include/cantera/equil/MultiPhase.h +++ b/include/cantera/equil/MultiPhase.h @@ -1,7 +1,7 @@ /** * @file MultiPhase.h * Headers for the \link Cantera::MultiPhase MultiPhase\endlink - * object that is used to set up multiphase equilibrium problems (see \ref equilfunctions). + * object that is used to set up multiphase equilibrium problems (see \ref equilGroup). */ // This file is part of Cantera. See License.txt in the top-level directory or @@ -17,9 +17,6 @@ namespace Cantera class ThermoPhase; -//! @defgroup equilfunctions Classes and functions used for calculating -//! chemical equilibrium. - //! A class for multiphase mixtures. The mixture can contain any //! number of phases of any type. /*! @@ -54,7 +51,7 @@ class ThermoPhase; * of the species in all the phases that comprise the MultiPhase. The ordering * of species is contiguous with respect to the phase id. * - * @ingroup equilfunctions + * @ingroup equilGroup */ class MultiPhase { @@ -359,7 +356,7 @@ class MultiPhase * log_level=0 suppresses diagnostics, and increasingly-verbose * messages are written as loglevel increases. * - * @ingroup equilfunctions + * @ingroup equilGroup */ void equilibrate(const std::string& XY, const std::string& solver="auto", double rtol=1e-9, int max_steps=50000, int max_iter=100, @@ -698,7 +695,7 @@ std::ostream& operator<<(std::ostream& s, MultiPhase& x); * @param[out] formRxnMatrix * @return The number of components. * - * @ingroup equilfunctions + * @ingroup equilGroup */ size_t BasisOptimize(int* usedZeroedSpecies, bool doFormRxn, MultiPhase* mphase, std::vector& orderVectorSpecies, @@ -741,7 +738,7 @@ size_t BasisOptimize(int* usedZeroedSpecies, bool doFormRxn, * @param[out] orderVectorElements Output vector containing the order of the * elements that is necessary for calculation of the formula matrix. * - * @ingroup equilfunctions + * @ingroup equilGroup */ void ElemRearrange(size_t nComponents, const vector_fp& elementAbundances, MultiPhase* mphase, diff --git a/include/cantera/equil/MultiPhaseEquil.h b/include/cantera/equil/MultiPhaseEquil.h index 7ef7087877..1474f0076e 100644 --- a/include/cantera/equil/MultiPhaseEquil.h +++ b/include/cantera/equil/MultiPhaseEquil.h @@ -27,7 +27,7 @@ namespace Cantera * method of class MultiPhase, although there is no reason it cannot be used * directly in application programs if desired. * - * @ingroup equil + * @ingroup equilGroup */ class MultiPhaseEquil { diff --git a/include/cantera/equil/vcs_MultiPhaseEquil.h b/include/cantera/equil/vcs_MultiPhaseEquil.h index 7acf963d03..08ce92f588 100644 --- a/include/cantera/equil/vcs_MultiPhaseEquil.h +++ b/include/cantera/equil/vcs_MultiPhaseEquil.h @@ -25,7 +25,7 @@ namespace Cantera * argument, and the return parameters are contained in underlying ThermoPhase * objects. * - * @ingroup equilfunctions + * @ingroup equilGroup */ class vcs_MultiPhaseEquil { diff --git a/include/cantera/equil/vcs_solve.h b/include/cantera/equil/vcs_solve.h index 016361cbbd..8bcb1d13b2 100644 --- a/include/cantera/equil/vcs_solve.h +++ b/include/cantera/equil/vcs_solve.h @@ -1,7 +1,7 @@ /** * @file vcs_solve.h Header file for the internal object that holds the vcs * equilibrium problem (see Class \link Cantera::VCS_SOLVE - * VCS_SOLVE\endlink and \ref equilfunctions ). + * VCS_SOLVE\endlink and \ref equilGroup ). */ // This file is part of Cantera. See License.txt in the top-level directory or @@ -527,7 +527,7 @@ class VCS_SOLVE * in the private data structure. All references to the species * properties must employ the ind[] index vector. * 4. Initialization of arrays to zero. - * 5. Check to see if the problem is well posed (If all the element + * 5. Check to see if the problem is well posed (If all the element * abundances are zero, the algorithm will fail) * * @param printLvl Print level of the routine diff --git a/include/cantera/thermo/ThermoPhase.h b/include/cantera/thermo/ThermoPhase.h index 3697560a40..084a5df5e4 100644 --- a/include/cantera/thermo/ThermoPhase.h +++ b/include/cantera/thermo/ThermoPhase.h @@ -294,7 +294,7 @@ class ThermoPhase : public Phase //! Return the speed of sound. Units: m/s. /*! - * The speed of sound is defined as + * The speed of sound is defined as * \f[ * c = \sqrt{\left(\frac{\partial P}{\partial\rho}\right)_s} * \f] @@ -1493,7 +1493,7 @@ class ThermoPhase : public Phase * log_level=0 suppresses diagnostics, and increasingly-verbose * messages are written as loglevel increases. * - * @ingroup equilfunctions + * @ingroup equilGroup */ void equilibrate(const std::string& XY, const std::string& solver="auto", double rtol=1e-9, int max_steps=50000, int max_iter=100, diff --git a/src/equil/MultiPhase.cpp b/src/equil/MultiPhase.cpp index ad2749dfbf..69ae292bcf 100644 --- a/src/equil/MultiPhase.cpp +++ b/src/equil/MultiPhase.cpp @@ -1,7 +1,7 @@ /** * @file MultiPhase.cpp * Definitions for the \link Cantera::MultiPhase MultiPhase\endlink - * object that is used to set up multiphase equilibrium problems (see \ref equilfunctions). + * object that is used to set up multiphase equilibrium problems (see \ref equilGroup). */ // This file is part of Cantera. See License.txt in the top-level directory or