From 81516dbed481f963fc180877fb9588195d7c32d7 Mon Sep 17 00:00:00 2001 From: Sina Ackermann <sina.ackermann@iws.uni-stuttgart.de> Date: Thu, 22 Sep 2016 08:18:55 +0200 Subject: [PATCH] [doxygen][featurelist] Add links to model descriptions Testing links for implicit models --- doc/doxygen/extradoc/featurelist.txt | 33 ++++++++++++++-------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/doc/doxygen/extradoc/featurelist.txt b/doc/doxygen/extradoc/featurelist.txt index 6389997bc3..b7bad1a96a 100644 --- a/doc/doxygen/extradoc/featurelist.txt +++ b/doc/doxygen/extradoc/featurelist.txt @@ -13,8 +13,9 @@ * \section Freeflow * |Tests | |Fluidsystem | Gridmanager | Mass-/Molefractionfraction | Non-/Isothermal | Discretization | linearSolver | AdaptiveGrid | Gravity | TurbulenceModels | Comments | * | :- | :- | :- | :- | :- | :- | :- | :- | :- | :- | :- |:- | + * | \c navierstokes | \ref Dumux::IMPETProblem2P2C "test" | - | ALUGrid/UGGrid/YaspGrid | - | i | box | SuperLU, UMFPack | - | TRUE | - | uses constant, runtime-specified fluidproperties | * | \c navierstokes | navierstokes | - | ALUGrid/UGGrid/YaspGrid | - | i | box | SuperLU, UMFPack | - | TRUE | - | uses constant, runtime-specified fluidproperties | - * | \c stokes | stokes | - | YaspGrid | - | i | box | SuperLU, UMFPack | - | TRUE | - | | + * | \c stokes | \ref BoxStokesModel "stokes" | - | YaspGrid | - | i | box | SuperLU, UMFPack | - | TRUE | - | | * | \c stokes2c | stokes2c | H2OAir | YaspGrid | Mole | i | box | SuperLU, UMFPack | - | TRUE | - | two tests: diffusion and diffusion+advection | * | \c stokes2cni | stokes2cni | H2OAir | YaspGrid | Mole | ni | box | Pardiso, UMFPack | - | TRUE | - | two tests: conduction and conduction+convection | * | \c zeroeq | zeroeq | - | UGGrid/YaspGrid | - | i | box | SuperLU, UMFPack | - | FALSE | BaldwinLomax | | @@ -30,35 +31,35 @@ * \section Implicit * | Tests | | Fluidsystem | Gridmanager | Mass/Mole | Non-/Isothermal | Discretization | linearSolver | AdaptiveGrid | BoundaryCondition | Homogeneity | MaterialLaw | Permeability | Gravity | JacobianRecycling | PartialReassemble | Comments | * | :- | :- | :- | :- | :- | :- | :- | :- | :- | :- | :- | :- | :- | :- | :- | :- | :- | - * | 1p | test | - | YaspGrid | - | ni | box/cc | AMGbackend | - | dirichletAtPos, neumannAtPos | Lense-Problem | - | Scalar | TRUE | - | - | - | + * | \ref OnePModel "1p" |test | - | YaspGrid | - | ni | box/cc | AMGbackend | - | dirichletAtPos, neumannAtPos | Lense-Problem | - | Scalar | TRUE | - | - | - | * | | convection | - | YaspGrid | - | ni | box/cc | AMGbackend | - | dirichletAtPos, neumannAtPos | Lense-Problem | - | Scalar | TRUE | - | - | - | * | | conduction | - | YaspGrid | - | ni | box/cc | AMGbackend | - | dirichletAtPos, neumannAtPos | Lense-Problem | - | Scalar | TRUE | - | - | - | - * | 1p2c | outflow | H2ON2LiquidPhase | UGGrid/YaspGrid | Mole/Mass | i/ni | box/cc | - | - | dirichletAtPos, neumann | homogeneous | - | Scalar | FALSE | - | - | - | + * | \ref OnePTwoCModel "1p2c" | outflow | H2ON2LiquidPhase | UGGrid/YaspGrid | Mole/Mass | i/ni | box/cc | - | - | dirichletAtPos, neumann | homogeneous | - | Scalar | FALSE | - | - | - | * | | convection | H2ON2LiquidPhase | YaspGrid | Mole | ni | box/cc | - | - | dirichletAtPos, neumann, sourceAtPos | homogeneous | - | Scalar | FALSE | - | - | - | * | | conduction | H2ON2LiquidPhase | YaspGrid | Mole | ni | box/cc | - | - | dirichletAtPos, neumann, sourceAtPos | homogeneous | - | Scalar | FALSE | - | - | - | - * | 2p | injection | H2ON2, SimpleH2O | UGGrid/YaspGrid | - | i/ni | box/cc | - | TRUE | dirichletAtPos, neumannAtPos | Lense-Problem | Brooks-Corey | Scalar | TRUE | - | - | - | + * | \ref TwoPModel "2p" | injection | H2ON2, SimpleH2O | UGGrid/YaspGrid | - | i/ni | box/cc | - | TRUE | dirichletAtPos, neumannAtPos | Lense-Problem | Brooks-Corey | Scalar | TRUE | - | - | - | * | | generalizeddirichlet | H2O, LNAPL | YaspGrid | - | i/ni | box/cc | - | TRUE | dirichletAtPos, neumannAtPos | homogeneous | Brooks-Corey | Matrix | FALSE | TRUE | TRUE | - | * | | cc2pcornerpoint | SimpleH2O | CpGrid | - | i/ni | box/cc | AMGbackend | TRUE | dirichletAtPos, neumannAtPos | homogeneous | van Genuchten | Matrix | FALSE | TRUE | TRUE | - | * | | lens | SimpleH2O, DNAPL | UGGrid/YaspGrid/ALUGrid | - | i/ni | box/cc | SuperLuBackend | TRUE | dirichletAtPos, neumannAtPos | Lense-Problem | Brooks-Corey | Scalar | TRUE | TRUE | TRUE | - | - * | 2p2c | injection | H2ON2 | YaspGrid | Mole | i/ni | box/cc | - | - | dirichletAtPos,solDependentNeumann | Lense-Problem | Brooks-Corey | Scalar | TRUE | TRUE | - | - | + * | \ref TwoPTwoCModel "2p2c" | injection | H2ON2 | YaspGrid | Mole | i/ni | box/cc | - | - | dirichletAtPos,solDependentNeumann | Lense-Problem | Brooks-Corey | Scalar | TRUE | TRUE | - | - | * | | waterair | H2ON2 | YaspGrid | Mole | i/ni | box/cc | - | - | diricheltAtPos, neumann, sourceAtPos | Lense-Problem | Brooks-Corey | Scalar | FALSE | TRUE | - | - | - * | 2pdfm | - | SimpleH2O, DNAPL | UGGrid/YaspGrid | - | ni | - | BoxBiCGStabILU0Solver | - | dirichletAtPos, neumannAtPos | Fracture/Matrix | regularizedbrookscorey | Scalar | FALSE | TRUE | TRUE | - | - * | 2pminc | - | SimpleH2O, DNAPL | YaspGrid | - | i | box | - | FALSE | neumannAtPos, dirichletAtPos | Fracture | Brooks-Corey | Matrix | TRUE | TRUE | TRUE | 2D-Problem | - * | 2pnc | fuelcell | H2ON2O2 | UGGrid | - | ni | box | - | FALSE | dirichletAtPos, solDependentNeumann | homogeneous | Brooks-Corey/Van Genuchten| Matrix | FALSE | FALSE | FALSE | water management in PEM-fuel cells | - * | 2pncminc | dissolution | BrineAir | YaspGrid | Mole/Mass | ni | box | - | FALSE | dirichlet, neumann | homogeneous | Brooks-Corey| Scalar | TRUE | FALSE | FALSE | flushing precipitated salt | - * | 3p | infiltration | H2OAirMesitylene | YaspGrid | - | i | cc | - | - | dirichletAtPos, neumann, sourceAtPos | Lense-Problem | van Genuchten | Scalar | FALSE | - | - | - | - * | | convection | H2OAirMesitylene | YaspGrid | - | ni | box/cc | - | - | diricheltAtPos, solDependentNeumann, sourceAtPos | homogeneous | van Genuchten | Scalar | FALSE | - | - | - | + * | \ref TwoPDFMModel "2pdfm" | - | SimpleH2O, DNAPL | UGGrid/YaspGrid | - | ni | - | BoxBiCGStabILU0Solver | - | dirichletAtPos, neumannAtPos | Fracture/Matrix | regularizedbrookscorey | Scalar | FALSE | TRUE | TRUE | - | + * | \ref TwoPMincModel "2pminc" | - | SimpleH2O, DNAPL | YaspGrid | - | i | box | - | FALSE | neumannAtPos, dirichletAtPos | Fracture | Brooks-Corey | Matrix | TRUE | TRUE | TRUE | 2D-Problem | + * | \ref TwoPNCModel "2pnc" | fuelcell | H2ON2O2 | UGGrid | - | ni | box | - | FALSE | dirichletAtPos, solDependentNeumann | homogeneous | Brooks-Corey/Van Genuchten| Matrix | FALSE | FALSE | FALSE | water management in PEM-fuel cells | + * | \ref TwoPNCMinModel "2pncmin" | dissolution | BrineAir | YaspGrid | Mole/Mass | ni | box | - | FALSE | dirichlet, neumann | homogeneous | Brooks-Corey| Scalar | TRUE | FALSE | FALSE | flushing precipitated salt | + * | \ref ThreePModel "3p" | infiltration | H2OAirMesitylene | YaspGrid | - | i | cc | - | - | dirichletAtPos, neumann, sourceAtPos | Lense-Problem | van Genuchten | Scalar | FALSE | - | - | - | + * | | convection | H2OAirMesitylene | YaspGrid | - | ni | box/cc | - | - | dirichletAtPos, solDependentNeumann, sourceAtPos | homogeneous | van Genuchten | Scalar | FALSE | - | - | - | * | | conduction | H2OAirMesitylene | YaspGrid | - | ni | box/cc | - | - | dirichletAtPos, neumann, sourceAtPos | homogeneous | van Genuchten | Scalar | FALSE | - | - | - | - * | 3p3c | infiltration | H2OAirMesitylene | YaspGrid | - | ni | box/cc | - | - | dirichletAtPos, neumann | Lense-Problem | van Genuchten | Scalar | FALSE | - | - | backward/central/forward differences | + * | \ref ThreePThreeCModel "3p3c" | infiltration | H2OAirMesitylene | YaspGrid | - | ni | box/cc | - | - | dirichletAtPos, neumann | Lense-Problem | van Genuchten | Scalar | FALSE | - | - | backward/central/forward differences | * | | columnxylol | H2OAirXylene | YaspGrid | - | ni | box/cc | - | - | dirichletAtPos, neumann | Lense-Problem | van Genuchten | Scalar | FALSE | - | - | backward/central/forward differences | * | | kuevette | H2OAirMesitylene | YaspGrid | - | ni | box/cc | - | - | dirichletAtPos, neumann | Lense-Problem | van Genuchten | Scalar | FALSE | - | - | backward/central/forward differences | - * | co2 | heterogeneous | BrineCO2FluidSystem | ALUGrid/YaspGrid | Mole/Mass | i/ni | box/cc | - | - | dirichletAtPos, neumann | layered system | van Genuchten | Scalar | TRUE | - | - | - | - * | mpnc | combustion | PureWaterSimpleFluidSystem | OneDGrid | Mole | ni | box/cc | SuperLuBackend | - | dirichletAtPos, solDependentNeumann, source | homogeneous | van Genuchten | Scalar | TRUE | - | - | - | + * | \ref CO2Model "co2" | heterogeneous | BrineCO2FluidSystem | ALUGrid/YaspGrid | Mole/Mass | i/ni | box/cc | - | - | dirichletAtPos, neumann | layered system | van Genuchten | Scalar | TRUE | - | - | - | + * | \ref MPNCModel "mpnc" | combustion | PureWaterSimpleFluidSystem | OneDGrid | Mole | ni | box/cc | SuperLuBackend | - | dirichletAtPos, solDependentNeumann, source | homogeneous | van Genuchten | Scalar | TRUE | - | - | - | * | | evaporationatmosphere | H2ON2Kinetic | UGGrid/ALUGrid/YaspGrid | - | ni | box/cc | - | - | dirichletAtPos, neumann | homogeneous | Brooks-Corey | Scalar | FALSE | - | - | - | * | | forchheimer1p | SimpleH2O | YaspGrid | - | ni | box/cc | - | - | dirichletAtPos, neumann, sourceAtPos | homogeneous | linear law | Scalar | FALSE | - | TRUE | - | * | | forchheimer2p | H2ON2 | YaspGrid | - | ni | box/cc | - | - | dirichletAtPos, neumann, sourceAtPos | homogeneous | linear law | Scalar | TRUE | - | TRUE | - | * | | obstacle | H2ON2 | YaspGrid | - | ni | box/cc | - | - | dirichletAtPos, neumann, sourceAtPos | Lense-Problem | linear law | Scalar | TRUE | - | TRUE | smoothUpwinding | - * | richards | lens | SimpleH2O | YaspGrid | - | i | box/cc | - | - | dirichletAtPos, neumannAtPos | Lense-Problem | van Genuchten | Scalar | TRUE | - | TRUE | - | + * | \ref RichardsModel "richards" | lens | SimpleH2O | YaspGrid | - | i | box/cc | - | - | dirichletAtPos, neumannAtPos | Lense-Problem | van Genuchten | Scalar | TRUE | - | TRUE | - | * | | conduction | H2ON2 | YaspGrid | - | ni | box/cc | - | - | dirichletAtPos, neumannAtPos | Lense-Problem | van Genuchten | Scalar | TRUE | - | TRUE | - | * | | convection | H2ON2 | YaspGrid | - | ni | box/cc | - | - | dirichletAtPos, neumannAtPos | Lense-Problem | van Genuchten | Scalar | TRUE | - | TRUE | - | * @@ -87,7 +88,7 @@ * \section Multidomain * |Tests | | Fluidsystem | Gridmanager | Mass/Mole | Non-/Isothermal | Discretization | linearSolver | Gravity | MaterialLaws | StokesStabilization | Comments | * | :- | :- | :- | :- | :- | :- | :- | :- | :- | :- | :- |:- | - * | \c 2cstokes2p2c |2cstokes2p2c | H2OAir | UGGrid/ALUGrid/YaspGrid | Mass | i | box | Pardiso, SuperLU | TRUE/FALSE | RegularizedVanGenuchten | FALSE | | + * | \c 2cstokes2p2c | 2cstokes2p2c | H2OAir | UGGrid/ALUGrid/YaspGrid | Mass | i | box | Pardiso, SuperLU | TRUE/FALSE | RegularizedVanGenuchten | FALSE | | * | \c 2cnistokes2p2cni|2cnistokes2p2cni | H2OAir | UGGrid/ALUGrid/YaspGrid | Mass | ni | box | Pardiso, SuperLU | TRUE/FALSE | RegularizedVanGenuchten, ThermalConductivitySomerton | FALSE | uses the gnuplotinterface for graphical live output | * | \c 2cnistokes2p2cni| boundarylayer | H2OAir | UGGrid/ALUGrid/YaspGrid | Mass | ni | box | Pardiso, SuperLU | TRUE/FALSE | RegularizedVanGenuchten, ThermalConductivitySomerton | FALSE | uses boundarylayer models to calculate the interface fluxes | * | \c 2czeroeq2p2c |2czeroeq2p2c | H2OAir | UGGrid/ALUGrid | Mass | i | box | SuperLU, UMFPack | TRUE/FALSE | RegularizedVanGenuchten | FALSE | | -- GitLab