From df6c840c22a20bfef3122dd3f870e3ef03b3ce2b Mon Sep 17 00:00:00 2001 From: Timo Koch <timokoch@math.uio.no> Date: Wed, 17 Jul 2024 14:35:17 +0000 Subject: [PATCH] [doc] Add link to parameter list in the doc page on runtime parameters --- doc/doxygen/pages/parameters.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/doxygen/pages/parameters.md b/doc/doxygen/pages/parameters.md index 45854e3bc1..826ccf17c2 100644 --- a/doc/doxygen/pages/parameters.md +++ b/doc/doxygen/pages/parameters.md @@ -175,3 +175,14 @@ Parameters are parsed into the parameter tree in the following precedence: 2. Input file arguments overwrite 3. User-default arguments overwrite 4. Global defaults + +## Parameter list + +We curate a list of available pre-defined parameters here: @ref parameterlist.txt. + +Note that not all listed parameters will be available in all types of simulations. For example, naturally, the Newton +solver can only be configured (via parameters in the group `[Newton]`) for +simulations that actually use a Newton solver. Model-specific parameters are only +read and used when the corresponding model is in use. + + -- GitLab