diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt index a8fa86509657c4865906429562c72190fae32b05..68a81248f5b76af7e9efe7225b56106f7993d59a 100644 --- a/doc/doxygen/modules.txt +++ b/doc/doxygen/modules.txt @@ -135,7 +135,7 @@ * \brief Model that adds nonequilibrium equations to another porous medium flow model (only used in MPNCModel currently) * \copydetails ./porousmediumflow/nonequilibrium/model.hh */ - /*! + /*! * \ingroup PorousmediumNonEquilibriumModel * \defgroup PorousmediumThermalNonEquilibriumModel ThermalNonEquilibrium * \brief Model that adapts the energy localresidual to thermal nonequilibrium @@ -172,7 +172,7 @@ * \defgroup FreeflowModels Free Flow Models * \brief Single-phase Navier Stokes / Stokes model */ - /*! + /*! * \ingroup FreeflowModels * \defgroup NavierStokesModel NavierStokes * \brief Single-phase Navier Stokes flow @@ -196,69 +196,110 @@ * \defgroup BenchmarksAndTests Benchmarks and Tests * \brief Benchmarks and tests used for (automated) testing and demonstration purposes */ - /*! \ingroup BenchmarksAndTests - * \defgroup OnePTests 1p (one phase) benchmarks and tests - * \brief Various tests using a OnePModel. The files are listed below. - */ - /*! \ingroup BenchmarksAndTests - * \defgroup OnePNCTests 1pnc (one phase, multi-component) benchmarks and tests - * \brief Various tests using a OnePNCModel. The files are listed below. - */ - /*! \ingroup BenchmarksAndTests - * \defgroup OnePNCMinTests 1pncmin (one phase, multi-component mineralization) benchmarks and tests - * \brief Various tests using the OnePNCMinModel. The files are listed below. - */ - /*! \ingroup BenchmarksAndTests - * \defgroup TwoPTests 2p (two phase) benchmarks and tests - * \brief Various tests using a TwoPModel. The files are listed below. - */ - /*! \ingroup BenchmarksAndTests - * \defgroup TwoPOneCTests 2p1c (two phase, one component) benchmarks and tests - * \brief Various tests using the TwoPOneCModel. The files are listed below. - */ - /*! \ingroup BenchmarksAndTests - * \defgroup TwoPTwoCTests 2p2c (two phase, two component) benchmarks and tests - * \brief Various tests using a TwoPTwoCModel. The files are listed below. - */ - /*! \ingroup BenchmarksAndTests - * \defgroup TwoPNCTests 2pnc (two phase, multi-component) benchmarks and tests - * \brief A fuel cell test problem using the TwoPNCModel. The files are listed below. - */ - /*! \ingroup BenchmarksAndTests - * \defgroup TwoPNCMinTests 2pncmin (two phase, multi-component mineralization) benchmarks and tests - * \brief A salt dissolution test problem using the TwoPNCMinModel. The files are listed below. - */ - /*! \ingroup BenchmarksAndTests - * \defgroup ThreePTests 3p (three phase) benchmarks and tests - * \brief Various tests using a ThreePModel. The files are listed below. - */ - /*! \ingroup BenchmarksAndTests - * \defgroup ThreePThreeCTests 3p3c (three phase, three component) benchmarks and tests - * \brief Various tests using a ThreePThreeCModel. The files are listed below. + /*! + * \ingroup BenchmarksAndTests + * \defgroup PorousmediumflowTests Porous-Medium Flow Tests + * \brief Single and multi-phase tests for flow and transport in porous materials */ - /*! \ingroup BenchmarksAndTests - * \defgroup ThreePWaterOilTests 3pwateroil (three phase, water oil) benchmarks and tests - * \brief A SAGD test problem using the ThreePWaterOilModel. The files are listed below. + /*! + * \ingroup PorousmediumflowTests + * \defgroup OnePTests 1p (one phase) benchmarks and tests + * \brief Various tests using a OnePModel. The files are listed below. + */ + /*! + * \ingroup PorousmediumflowTests + * \defgroup OnePNCTests 1pnc (one phase, multi-component) benchmarks and tests + * \brief Various tests using a OnePNCModel. The files are listed below. + */ + /*! + * \ingroup PorousmediumflowTests + * \defgroup OnePNCMinTests 1pncmin (one phase, multi-component mineralization) benchmarks and tests + * \brief Various tests using the OnePNCMinModel. The files are listed below. + */ + /*! + * \ingroup PorousmediumflowTests + * \defgroup TwoPTests 2p (two phase) benchmarks and tests + * \brief Various tests using a TwoPModel. The files are listed below. + */ + /*! + * \ingroup PorousmediumflowTests + * \defgroup TwoPOneCTests 2p1c (two phase, one component) benchmarks and tests + * \brief Various tests using the TwoPOneCModel. The files are listed below. + */ + /*! + * \ingroup PorousmediumflowTests + * \defgroup TwoPTwoCTests 2p2c (two phase, two component) benchmarks and tests + * \brief Various tests using a TwoPTwoCModel. The files are listed below. + */ + /*! + * \ingroup PorousmediumflowTests + * \defgroup TwoPNCTests 2pnc (two phase, multi-component) benchmarks and tests + * \brief A fuel cell test problem using the TwoPNCModel. The files are listed below. + */ + /*! + * \ingroup PorousmediumflowTests + * \defgroup TwoPNCMinTests 2pncmin (two phase, multi-component mineralization) benchmarks and tests + * \brief A salt dissolution test problem using the TwoPNCMinModel. The files are listed below. + */ + /*! + * \ingroup PorousmediumflowTests + * \defgroup ThreePTests 3p (three phase) benchmarks and tests + * \brief Various tests using a ThreePModel. The files are listed below. + */ + /*! + * \ingroup PorousmediumflowTests + * \defgroup ThreePThreeCTests 3p3c (three phase, three component) benchmarks and tests + * \brief Various tests using a ThreePThreeCModel. The files are listed below. + */ + /*! + * \ingroup PorousmediumflowTests + * \defgroup ThreePWaterOilTests 3pwateroil (three phase, water oil) benchmarks and tests + * \brief A SAGD test problem using the ThreePWaterOilModel. The files are listed below. + */ + /*! + * \ingroup PorousmediumflowTests + * \defgroup CO2Tests CO2 (two phase, two component) benchmarks and tests + * \brief A CO2 injection test problem using the TwoPTwoCModel and heterogeneous spatial parameters. The files are listed below. + */ + /*! + * \ingroup PorousmediumflowTests + * \defgroup MPNCTests MPNC (multi-phase, multi-component) benchmarks and tests + * \brief Various tests using the MPNCModel. The files are listed below. + */ + /*! + * \ingroup PorousmediumflowTests + * \defgroup RichardsTests Richards benchmarks and tests + * \brief Various tests using a RichardsModel. The files are listed below. + */ + /*! + * \ingroup PorousmediumflowTests + * \defgroup RichardsNCTests Richards multi-component benchmarks and tests + * \brief A multi-component transport problem in the unsaturated zone using the RichardsNCModel. The files are listed below. + */ + /*! + * \ingroup PorousmediumflowTests + * \defgroup TracerTests Tracer benchmarks and tests + * \brief Various tests using a TracerModel. The files are listed below. + */ + /*! + * \ingroup BenchmarksAndTests + * \defgroup FreeflowTests Free Flow Tests + * \brief Varios tests for single-phase Navier Stokes / Stokes tests */ - /*! \ingroup BenchmarksAndTests - * \defgroup CO2Tests CO2 (two phase, two component) benchmarks and tests - * \brief A CO2 injection test problem using the TwoPTwoCModel and heterogeneous spatial parameters. The files are listed below. - */ - /*! \ingroup BenchmarksAndTests - * \defgroup MPNCTests MPNC (multi-phase, multi-component) benchmarks and tests - * \brief Various tests using the MPNCModel. The files are listed below. - */ - /*! \ingroup BenchmarksAndTests - * \defgroup RichardsTests Richards benchmarks and tests - * \brief Various tests using a RichardsModel. The files are listed below. - */ - /*! \ingroup BenchmarksAndTests - * \defgroup RichardsNCTests Richards multi-component benchmarks and tests - * \brief A multi-component transport problem in the unsaturated zone using the RichardsNCModel. The files are listed below. - */ - /*! \ingroup BenchmarksAndTests - * \defgroup TracerTests Tracer benchmarks and tests - * \brief Various tests using a TracerModel. The files are listed below. + /*! + * \ingroup FreeflowTests + * \defgroup NavierStokesTests Single-phase Navier Stokes tests + * \brief Various tests using a Single-phase Navier Stokes flow. The files are listed below. + */ + /*! + * \ingroup FreeflowTests + * \defgroup NavierStokesNCTests Single-phase Navier Stokes nc tests + * \brief Various tests using a Single-phase Navier Stokes flow. The files are listed below. + */ + /*! + * \ingroup BenchmarksAndTests + * \defgroup MaterialTests Material system tests + * \brief Benchmarks and Test(s) for the material system. */ /* ***************** Discretization ******************/ @@ -275,13 +316,13 @@ * \ingroup Discretization * \defgroup CCDiscretization Cell-centered FV scheme * \brief Finite volume schemes with degrees of freedom located at grid cell centers. - */ - /*! + */ + /*! * \ingroup CCDiscretization * \defgroup CCTpfaDiscretization Two-point flux approximation (Tpfa) * \brief A cell-centered finite volume scheme with two-point flux approximation. */ - /*! + /*! * \ingroup CCDiscretization * \defgroup CCMpfaDiscretization Multi-point flux approximation (Mpfa) * \brief A cell-centered finite volume scheme with multi-point flux approximation. @@ -309,7 +350,7 @@ * - __Fluid system:__ <br> @copydoc Fluidsystems * - __Spatial Parameters:__ <br> @copydoc SpatialParameters */ - /*! + /*! * \ingroup Material * \defgroup Binarycoefficients Binary Coefficients * \brief Binary coefficients @@ -342,12 +383,12 @@ * full-fledged fluid systems. Components are not supposed to be used * by models directly. */ - /*! + /*! * \ingroup Components * \defgroup IAPWS IAPWS * \brief Tabulated values according to the International Association for the Properties of Water and Steam (IAPWS) */ - /*! + /*! * \ingroup Material * \defgroup ConstraintSolver Constraint Solver * \brief Constraint solvers converting primary to secondary variables