From b629fe1df2dea9e1ac452d8b1f5333eb196cda4e Mon Sep 17 00:00:00 2001
From: Yue Wang <yue.wang@iws.uni-stuttgart.de>
Date: Wed, 13 Dec 2023 15:27:04 +0100
Subject: [PATCH] [doc] update SandGrainRoughness 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 24031f8ff0..8bd9307682 100644
--- a/doc/doxygen/extradoc/parameterlist.txt
+++ b/doc/doxygen/extradoc/parameterlist.txt
@@ -303,6 +303,7 @@
* | RANS | FlowDirectionAxis | int | 0 | The flow direction axis |
* | RANS | IsFlatWallBounded | bool | false | Set to true, if geometry consists of flat walls |
* | RANS | SSTModelVersion | std::string | "SST" | the model version of the SST model |
+ * | RANS | SandGrainRoughness | Scalar | - | The roughness of a sand grain |
* | RANS | TurbulentPrandtlNumber | Scalar | 1.0 | The turbulent Prandtl number |
* | RANS | TurbulentSchmidtNumber | Scalar | 1.0 | The turbulent Schmidt number |
* | RANS | UseStoredEddyViscosity | bool | false | Whether to use the stored eddy viscosity |
diff --git a/doc/doxygen/extradoc/parameters.json b/doc/doxygen/extradoc/parameters.json
index 88f76eb0dc..ff0d28635d 100644
--- a/doc/doxygen/extradoc/parameters.json
+++ b/doc/doxygen/extradoc/parameters.json
@@ -2438,9 +2438,6 @@
"Set a name for a problem"
]
},
- "Problem.SandGrainRoughness": {
- "mode": "ignore"
- },
"RANS.EddyViscosityModel": {
"explanation": [
"Choose the eddy viscosity model"
@@ -2456,6 +2453,11 @@
"Set to true, if geometry consists of flat walls"
]
},
+ "RANS.SandGrainRoughness": {
+ "explanation": [
+ "The roughness of a sand grain"
+ ]
+ },
"RANS.SSTModelVersion": {
"explanation": [
"the model version of the SST model"
--
GitLab