From 64b6fac09a409f9ed67f245224af05fb1922e3f5 Mon Sep 17 00:00:00 2001
From: Yue Wang <yue.wang@iws.uni-stuttgart.de>
Date: Wed, 13 Dec 2023 15:18:29 +0100
Subject: [PATCH] [doc] update UsePrimaryVariableSwitch in parameters list
---
doc/doxygen/extradoc/parameterlist.txt | 1 +
doc/doxygen/extradoc/parameters.json | 8 +++++---
2 files changed, 6 insertions(+), 3 deletions(-)
diff --git a/doc/doxygen/extradoc/parameterlist.txt b/doc/doxygen/extradoc/parameterlist.txt
index e6cfe5b828..24031f8ff0 100644
--- a/doc/doxygen/extradoc/parameterlist.txt
+++ b/doc/doxygen/extradoc/parameterlist.txt
@@ -308,6 +308,7 @@
* | RANS | UseStoredEddyViscosity | bool | false | Whether to use the stored eddy viscosity |
* | RANS | WallNormalAxis | int | 1 | The normal wall axis of a flat wall bounded flow |
* | RANS | WriteFlatWallBoundedFields | bool | isFlatWallBounded | Whether to write output fields for flat wall geometries |
+ * | \b Richards | UsePrimaryVariableSwitch | bool | - | Whether to use primary variable switch in richards model |
* | \b ShallowWater | EnableViscousFlux | bool | false | Whether to include a viscous flux contribution. |
* | ShallowWater | HorizontalCoefficientOfMixingLengthModel | Scalar | 0.1 | For the turbulence model base on the mixing length: The Smagorinsky-like horizontal turbulence coefficient. |
* | ShallowWater | TurbulentViscosity | Scalar | the fluid viscosity | The (constant) background turbulent viscosity. |
diff --git a/doc/doxygen/extradoc/parameters.json b/doc/doxygen/extradoc/parameters.json
index 2e22898452..88f76eb0dc 100644
--- a/doc/doxygen/extradoc/parameters.json
+++ b/doc/doxygen/extradoc/parameters.json
@@ -2441,9 +2441,6 @@
"Problem.SandGrainRoughness": {
"mode": "ignore"
},
- "Problem.UsePrimaryVariableSwitch": {
- "mode": "ignore"
- },
"RANS.EddyViscosityModel": {
"explanation": [
"Choose the eddy viscosity model"
@@ -2489,6 +2486,11 @@
"Whether to write output fields for flat wall geometries"
]
},
+ "Richards.UsePrimaryVariableSwitch": {
+ "explanation": [
+ "Whether to use primary variable switch in richards model"
+ ]
+ },
"ShallowWater.EnableViscousFlux": {
"explanation": [
"Whether to include a viscous flux contribution."
--
GitLab