From b118861a2fc5d4f1681e179d1a4010172a2ca782 Mon Sep 17 00:00:00 2001
From: IvBu <st116086@stud.uni-stuttgart.de>
Date: Sun, 29 Oct 2023 19:20:54 +0100
Subject: [PATCH] [doxygen][parameters] Ignore misgrouped parameters.
---
doc/doxygen/extradoc/parameterlist.txt | 6 +-----
doc/doxygen/extradoc/parameters.json | 19 ++++---------------
2 files changed, 5 insertions(+), 20 deletions(-)
diff --git a/doc/doxygen/extradoc/parameterlist.txt b/doc/doxygen/extradoc/parameterlist.txt
index a54116eb3f..51f49d6401 100644
--- a/doc/doxygen/extradoc/parameterlist.txt
+++ b/doc/doxygen/extradoc/parameterlist.txt
@@ -290,7 +290,7 @@
* | Newton | ResidualReduction | Scalar | 1e-5 | The maximum acceptable residual norm reduction |
* | Newton | RetryTimeStepReductionFactor | Scalar | 0.5 | Factor for reducing the current time-step |
* | Newton | SatisfyResidualAndShiftCriterion | bool | false | declare convergence only if both criteria are met |
- * | Newton | SaturationChangeIsRelative | bool | false | See explanatio of AllowedSaturationChange. |
+ * | Newton | SaturationChangeIsRelative | bool | false | See explanation of AllowedSaturationChange. |
* | Newton | TargetSteps | int | 10 | The number of iterations which are considered "optimal" |
* | Newton | UseLineSearch | bool | false | Whether to use line search |
* | Newton | Verbosity | int | 2 | The verbosity level of the Newton solver |
@@ -299,10 +299,6 @@
* | \b Problem | EnableGravity | bool | - | Whether to enable the gravity term |
* | Problem | EnableInertiaTerms | bool | - | Whether to enable the inertia terms |
* | Problem | Name | std::string | - | Set a name for a problem |
- * | Problem | PoissonRatio | Scalar | - | The poisson ratio. |
- * | Problem | SandGrainRoughness | Scalar | - | The sand grain roughness |
- * | Problem | UsePrimaryVariableSwitch | bool | - | Whether to perform variable switch at a degree of freedom location |
- * | Problem | YoungsModulus | Scalar | - | The value of Young's modulus. |
* | \b RANS | EddyViscosityModel | std::string | "vanDriest" | Choose the eddy viscosity model |
* | RANS | FlowDirectionAxis | int | 0 | The flow direction axis |
* | RANS | IsFlatWallBounded | bool | false | Set to true, if geometry consists of flat walls |
diff --git a/doc/doxygen/extradoc/parameters.json b/doc/doxygen/extradoc/parameters.json
index f809670701..e357c2c87d 100644
--- a/doc/doxygen/extradoc/parameters.json
+++ b/doc/doxygen/extradoc/parameters.json
@@ -2439,27 +2439,16 @@
]
},
"Problem.PoissonRatio": {
- "explanation": [
- "The poisson ratio."
- ]
+ "mode": "ignore"
},
"Problem.SandGrainRoughness": {
- "explanation": [
- "The sand grain roughness"
- ]
+ "mode": "ignore"
},
"Problem.UsePrimaryVariableSwitch": {
- "explanation": [
- "Whether to perform variable switch at a degree of freedom location"
- ]
+ "mode": "ignore"
},
"Problem.YoungsModulus": {
- "explanation": [
- "The value of Young's modulus."
- ],
- "type": [
- "Scalar"
- ]
+ "mode": "ignore"
},
"RANS.EddyViscosityModel": {
"explanation": [
--
GitLab