Skip to content

Commit

Permalink
[docs] Restructure surface problem solver documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ischoegl committed Jul 18, 2023
1 parent 17d8303 commit c3bcf37
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
4 changes: 3 additions & 1 deletion include/cantera/kinetics/ImplicitSurfChem.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
namespace Cantera
{

//! @defgroup surfSolverGroup Surface Problem Solver

//! Advances the surface coverages of the associated set of SurfacePhase
//! objects in time
/*!
Expand Down Expand Up @@ -51,7 +53,7 @@ namespace Cantera
* phase with \f$ N_s \f$ surface sites, it consists of the surface coverages
* \f$ \theta_k \f$ for \f$ k = 0, N_s - 1 \f$
*
* @ingroup chemkinetics
* @ingroup surfSolverGroup
*/
class ImplicitSurfChem : public FuncEval
{
Expand Down
10 changes: 8 additions & 2 deletions include/cantera/kinetics/solveSP.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
#include "cantera/kinetics/InterfaceKinetics.h"
#include "cantera/numerics/DenseMatrix.h"

//! @addtogroup surfSolverGroup
//! @{

//! @defgroup solvesp_methods Surface Problem Solver Methods
//! @{

Expand Down Expand Up @@ -39,7 +42,7 @@ const int SFLUX_JACOBIAN = 3;
//! whether it's converged to a steady state or not. This is a poor man's time
//! stepping algorithm.
const int SFLUX_TRANSIENT = 4;
//! @}
//! @} End of solvesp_method

//! @defgroup solvesp_bulkFunc Surface Problem Bulk Phase Mode
//! Functionality expected from the bulk phase. This changes the equations
Expand All @@ -54,7 +57,7 @@ const int BULK_DEPOSITION = 1;
//! constant, and given by the initial conditions. This is also used whenever
//! the condensed phase is part of the larger solution.
const int BULK_ETCH = 2;
//! @}
//! @} End of solvesp_bulkFunc

namespace Cantera
{
Expand Down Expand Up @@ -486,5 +489,8 @@ class solveSP
public:
int m_ioflag = 0;
};

//! @} End of surfSolverGroup

}
#endif

0 comments on commit c3bcf37

Please sign in to comment.