From 19e76e1bf1c075e712cf16ecb9080415f76384bf Mon Sep 17 00:00:00 2001
From: Timo Koch <timokoch@math.uio.no>
Date: Sat, 25 Mar 2023 13:22:26 +0000
Subject: [PATCH] Merge branch 'feature/update-paramlist-3.7' into 'master'
[doc] update the parameter list
Closes #1236
See merge request dumux-repositories/dumux!3492
(cherry picked from commit c680ca8d1b74468176542ba0fd6893f83024a72f)
4bd19c01 [doc] update the parameter list
eab2a9d1 [bin/doc] deprecate some parameters
---
.../extradoc/known_parameter_warnings.json | 10 +++++
doc/doxygen/extradoc/parameterlist.txt | 9 +++--
doc/doxygen/extradoc/parameters.json | 38 ++++++++++++++++++-
3 files changed, 52 insertions(+), 5 deletions(-)
diff --git a/doc/doxygen/extradoc/known_parameter_warnings.json b/doc/doxygen/extradoc/known_parameter_warnings.json
index 67800a6547..11d79dae3a 100644
--- a/doc/doxygen/extradoc/known_parameter_warnings.json
+++ b/doc/doxygen/extradoc/known_parameter_warnings.json
@@ -68,5 +68,15 @@
],
"dumux/assembly/pq1bubblelocalassembler.hh": [
"static const bool updateAllVolVars = getParamFromGroup<bool>("
+ ],
+ "dumux/flux/shallowwaterviscousflux.hh": [
+ "static const auto useMixingLengthTurbulenceModel = getParamFromGroup<bool>(",
+ "static const auto backgroundKinematicViscosity = getParamFromGroup<Scalar>("
+ ],
+ "dumux/linear/stokes_solver.hh": [
+ "const auto mode = getParamFromGroup<std::string>("
+ ],
+ "dumux/assembly/cvfelocalassembler.hh": [
+ "static const bool updateAllVolVars = getParamFromGroup<bool>("
]
}
diff --git a/doc/doxygen/extradoc/parameterlist.txt b/doc/doxygen/extradoc/parameterlist.txt
index ede44f0769..35a50e295a 100644
--- a/doc/doxygen/extradoc/parameterlist.txt
+++ b/doc/doxygen/extradoc/parameterlist.txt
@@ -24,7 +24,8 @@
* | Adaptive | RefineAtDirichletBC | bool | true | Whether to refine at Dirichlet boundaries |
* | Adaptive | RefineAtFluxBC | bool | true | Whether to refine at Neumann/Robin boundaries |
* | Adaptive | RefineAtSource | bool | true | Whether to refine where source terms are specified |
- * | \b Assembly | FCDiamondVolVarsDependOnAllElementDofs | bool | false | Whether to update all volvars in the stencil or only those of the associated scv |
+ * | \b Assembly | BoxVolVarsDependOnAllElementDofs | bool | false | Whether to update all volvars in the stencil or only update the volVars for the scv whose associated dof has been deflected. |
+ * | Assembly | FCDiamondVolVarsDependOnAllElementDofs | bool | false | Whether to update all volvars in the stencil or only those of the associated scv |
* | Assembly | Multithreading | bool | true | Whether to enable multi-threaded assembly |
* | Assembly | NumericDifference.BaseEpsilon | Scalar | 1e-10 | The basic numeric epsilon used in the differentiation for deflecting primary variables |
* | Assembly | NumericDifference.PriVarMagnitude | NumEqVector | NumEqVector(-1) | The magnitude of the primary variables used for finding a good numeric epsilon for deflecting primary variables. |
@@ -285,12 +286,12 @@
* | RANS | SSTModelVersion | std::string | "SST" | the model version of the SST model |
* | RANS | TurbulentPrandtlNumber | Scalar | 1.0 | The turbulent Prandtl number |
* | RANS | TurbulentSchmidtNumber | Scalar | 1.0 | The turbulent Schmidt number |
- * | RANS | UseStoredEddyViscosity | bool | true | Whether to use the stored eddy viscosity |
+ * | 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 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 | 1.0e-6 | The (constant) background turbulent viscosity. |
+ * | ShallowWater | TurbulentViscosity | Scalar | the fluid viscosity | The (constant) background turbulent viscosity. |
* | ShallowWater | UseMixingLengthTurbulenceModel | bool | false | Whether the mixing-length turbulence model is used. |
* | ShallowWater | VerticalCoefficientOfMixingLengthModel | Scalar | 1.0 | For the turbulence model base on the mixing length: The Elder-like vertical turbulence coefficient. |
* | \b SimpleH2O | ReferenceTemperature | Scalar | 293.15 | The reference temperature in \f$\mathrm{[K]}\f$ for calculating the (liquid or gas) enthalpy of simple H2O. |
@@ -305,7 +306,7 @@
* | \b TimeLoop | Restart | double | 0.0 | The restart time stamp for a previously interrupted simulation |
* | \b Transmissibility | ConsiderPoreResistance | bool | true | Whether or not the pore resistance should be considered on runtime. |
* | \b Vtk | AddProcessRank | bool | true | Whether to add a process rank |
- * | Vtk | AddVelocity | bool | true | Whether to enable velocity output |
+ * | Vtk | AddVelocity | bool | false | Whether to enable velocity output |
* | Vtk | CoordPrecision | std::string | precisionString | The output precision of coordinates. |
* | Vtk | Precision | std::string | "Float32" | Precision of the vtk output |
* | Vtk | WriteFaceData | bool | false | For the staggered grid approach, write face-related data into vtp files. |
diff --git a/doc/doxygen/extradoc/parameters.json b/doc/doxygen/extradoc/parameters.json
index 1c352df424..dfa418b43e 100644
--- a/doc/doxygen/extradoc/parameters.json
+++ b/doc/doxygen/extradoc/parameters.json
@@ -341,6 +341,18 @@
"Whether to refine where source terms are specified"
]
},
+ "Assembly.BoxVolVarsDependOnAllElementDofs": {
+ "defaultValue": [
+ "false"
+ ],
+ "explanation": [
+ "Whether to update all volvars in the stencil or only update the volVars for the scv whose associated dof has been deflected."
+ ],
+ "mode": "manual",
+ "type": [
+ "bool"
+ ]
+ },
"Assembly.FCDiamondVolVarsDependOnAllElementDofs": {
"defaultValue": [
"false"
@@ -1509,6 +1521,9 @@
"Whether to enable the production limiter"
]
},
+ "LinearSolver.DirectSolverForVelocity": {
+ "mode": "ignore"
+ },
"LinearSolver.GMResRestart": {
"defaultValue": [
"10"
@@ -1821,6 +1836,9 @@
"bool"
]
},
+ "LinearSolver.Preconditioner.MassMatrixWeight": {
+ "mode": "ignore"
+ },
"LinearSolver.Preconditioner.ILUOrder": {
"defaultValue": [
"0"
@@ -1929,6 +1947,9 @@
"int"
]
},
+ "LinearSolver.SymmetrizeDirichlet": {
+ "mode": "ignore"
+ },
"LinearSolver.Type": {
"defaultValue": [
"-"
@@ -2287,11 +2308,25 @@
"ShallowWater.TurbulentViscosity": {
"explanation": [
"The (constant) background turbulent viscosity."
+ ],
+ "mode": "manual",
+ "type": [
+ "Scalar"
+ ],
+ "defaultValue": [
+ "the fluid viscosity "
]
},
"ShallowWater.UseMixingLengthTurbulenceModel": {
"explanation": [
"Whether the mixing-length turbulence model is used."
+ ],
+ "mode": "manual",
+ "defaultValue": [
+ "false"
+ ],
+ "type": [
+ "bool"
]
},
"ShallowWater.VerticalCoefficientOfMixingLengthModel": {
@@ -2368,7 +2403,8 @@
"Vtk.AddVelocity": {
"explanation": [
"Whether to enable velocity output"
- ]
+ ],
+ "defaultValue" :["false"]
},
"Vtk.CoordPrecision": {
"explanation": [
--
GitLab