Commit f1b76ade authored by Simon Scholz's avatar Simon Scholz
Browse files

Merge branch 'cleanup/restructure-doxygen' into 'master'

[doc][doxygen] add Geomechanics group and supergroup Assembly and Solvers

See merge request !1412
parents 76baa541 a76baac2
......@@ -231,6 +231,22 @@
* \brief An energy equation adaptor for isothermal free-flow models
* \copydetails ./freeflow/nonisothermal/model.hh
*/
/*!
* \defgroup Geomechanics Geomechanics Models
* \brief Models for taking into account solid deformation
*/
/*!
* \ingroup Geomechanics
* \defgroup Elastic Solid mechanics w/o fluid pressure
* \brief Models linear elastic deformation of a solid. Disregards fluid pressure.
* \copydetails ./geomechanics/elastic/model.hh
*/
/*!
* \ingroup Geomechanics
* \defgroup PoroElastic Solid mechanics with fluid pressure
* \brief Models linear elastic deformation of a solid. Takes fluid pressure into account.
* \copydetails ./geomechanics/poroelastic/model.hh
*/
/* ***************** Benchmarks and Tests ******************/
/*!
......@@ -510,13 +526,34 @@
* \brief Adaptive grids
*/
/* ***************** Assembly and Solvers ******************/
/*!
* \defgroup AssemblyAndSolvers Assembly and Solvers
* \brief Assembling matrices and vectors, solvers for linear and nonlinear equations
*/
/* ***************** Assembly ******************/
/*!
* \ingroup AssemblyAndSolvers
* \defgroup Assembly Assembly
* \brief Assembly of linear systems (Jacobian and residual)
*/
/* ***************** Common ******************/
/* ***************** Linear ******************/
/*!
* \ingroup AssemblyAndSolvers
* \defgroup Linear Linear
* \brief Linear solvers and helpers
*/
/* ***************** Nonlinear ******************/
/*!
* \ingroup AssemblyAndSolvers
* \defgroup Nonlinear Nonlinear
* \brief Nonlinear solvers: Newton method
*/
/* ***************** Common ******************/
/*!
* \defgroup Common Common
* \brief Common classes, functions, properties and concepts
......@@ -533,24 +570,6 @@
* \brief Classes and functions dealing with input and output of data and grids
*/
/* ***************** Linear ******************/
/*!
* \defgroup Linear Linear
* \brief Linear solvers and helpers
*/
/* ***************** Nonlinear ******************/
/*!
* \defgroup Nonlinear Nonlinear
* \brief Nonlinear solvers: Newton method
*/
/* ***************** Parallel ******************/
/*!
* \defgroup Parallel Parallel
* \brief Helpers for parallel runs with MPI
*/
/* ***************** MultiDomain ******************/
/*!
* \defgroup MultiDomain Multidomain simulations
......
......@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup Parallel
* \ingroup Assembly
* \brief Provides data handles for parallel communication which operate on vertices
* \note This is useful for schemes with degrees of freedom on vertices (box scheme)
*/
......@@ -31,7 +31,7 @@
namespace Dumux {
/*!
* \ingroup Parallel
* \ingroup Assembly
* \brief Data handle for parallel communication which sums up all
* values are attached to vertices
*/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment