From 82518f1751baac2c85e57df351ac3a38d965c822 Mon Sep 17 00:00:00 2001 From: Ned Coltman <edward.coltman@iws.uni-stuttgart.de> Date: Wed, 22 Apr 2020 12:57:05 +0200 Subject: [PATCH] [parameterlist] cleanup parameterlist.txt for release 3.2 --- bin/doc/compareparameters.sh | 6 ++--- doc/doxygen/extradoc/parameterlist.txt | 34 ++++++++++++++------------ 2 files changed, 22 insertions(+), 18 deletions(-) diff --git a/bin/doc/compareparameters.sh b/bin/doc/compareparameters.sh index 920c910db6..3b95867353 100755 --- a/bin/doc/compareparameters.sh +++ b/bin/doc/compareparameters.sh @@ -114,7 +114,7 @@ sort -u old_parameters.csv -o old_parameters.csv # 3. compare lists of old and new parameters # treat additions diff -u old_parameters.csv new_parameters.csv | grep -E "^\+" | grep -v "\++" >added.csv -if [[ -s added.csv ]]; then +if [ -s "added.csv" ]; then echo "" echo "Compared to parameterlist.txt, the following parameters have been _added_:" echo "" @@ -131,7 +131,7 @@ if [[ -s added.csv ]]; then fi # treat deletions diff -u old_parameters.csv new_parameters.csv | grep -E "^\-" | grep -v "\--" >deleted.csv -if [[ -s deleted.csv ]]; then +if [ -s "deleted.csv" ]; then echo "" echo "Compared to parameterlist.txt, the following parameters have been _deleted_:" echo "" @@ -146,7 +146,7 @@ if [[ -s deleted.csv ]]; then echo "their name. If so, delete the corresponding rows in doc/doxygen/extradoc/parameterlist.txt." fi # final remark -if [[ ! -s added.csv && ! -s deleted.csv ]]; then +if [ ! -s "added.csv" && ! -s "deleted.csv" ]; then echo "" echo "Compared to parameterlist.txt, no parameters have been added or deleted." echo "" diff --git a/doc/doxygen/extradoc/parameterlist.txt b/doc/doxygen/extradoc/parameterlist.txt index 48a55c6b2c..57ac8ab96c 100644 --- a/doc/doxygen/extradoc/parameterlist.txt +++ b/doc/doxygen/extradoc/parameterlist.txt @@ -12,10 +12,9 @@ * | :- | :- | :- | :- | :- | * | - | ParameterFile | std::string| executable.input | name of the parameter file | * | \b Adaptive | BCRefinementThreshold | Scalar | 1e-10 | | -Adaptive | MaxLevel | std::size_t | 0 | | +* | | MaxLevel | std::size_t | 0 | | * | \b Assembly | NumericDifference.BaseEpsilon | Scalar | 1e-10 | | * | | NumericDifferenceMethod | int | | | -* | | NumericDifferenceMethod | int | | | * | | NumericDifference.PriVarMagnitude | NumEqVector(-1) | | | * | \b BinaryCoefficients | GasDiffCoeff | Scalar | | | * | | LiquidDiffCoeff | Scalar | | | @@ -47,9 +46,14 @@ Adaptive | MaxLevel | std::size_t | 0 | | * | | ThermoneutralVoltage | Scalar | | | * | | TransferCoefficient | Scalar | | | * | | TransportNumberH20 | Scalar | | | +* | \b FacetCoupling | Xi | Scalar | 1.0 | | * | \b Flux | DifferencingScheme | std::string | Minmod | | * | | TvdApproach | std::string | Uniform | | * | | UpwindWeight | Scalar | | | +* | \b FluxLimiterLET | LowerWaterDepth | Scalar | 1e-5 | | +* | | UpperWaterDepth | Scalar | 1e-3 | | +* | | UpwindFluxLimiting | bool | false | | +* | \b FluxOverSurface | Verbose | bool | false | | * | \b Forchheimer | MaxIterations | std::size_t | 30 | | * | | NewtonTolerance | Scalar | 1e-12 | | * | \b FreeFlow | EnableUnsymmetrizedVelocityGradient | bool | false | | @@ -101,8 +105,6 @@ Adaptive | MaxLevel | std::size_t | 0 | | * | | UpperRight | GlobalPosition | | | * | | Verbosity | bool | false | | * | | WellRadius | Scalar | | | -* | | WriteSubGridToDGF | bool | false) | | -* | | WriteSubGridToVtk | bool | false) | | * | \b Impet | CFLFactor | Scalar | | | * | | DtVariationRestrictionFactorstd::numeric_limits<Scalar | | | | * | | EnableVolumeIntegral | bool | | | @@ -120,20 +122,25 @@ Adaptive | MaxLevel | std::size_t | 0 | | * | | SwitchNormals | bool | | | * | \b KEpsilon | EnableKinematicViscosity | bool | true | | * | | EnableZeroEqScaling | bool | true | | -* | |YPlusThreshold | Scalar | 30 | | +* | | YPlusThreshold | Scalar | 30 | | * | \b KOmega | EnableDissipationLimiter | bool | true | | * | | EnableProductionLimiter | bool | false | | * | \b LinearSolver | GMResRestart | double | | | -* | | GMResRestart | int | | | -* | | MaxIterations | int | | | -* | | PreconditionerIterations | int | | | +* | | GMResRestart | int | 10 | | +* | | MaxIterations | int | 250 | | +* | | PreconditionerIterations | int | 1 | | * | | PreconditionerRelaxation | double | | | -* | | ResidualReduction | double | | | -* | | ResidualReduction | Scalar | 1e-6) | | -* | | Verbosity | int | | | +* | | PreconditionerVerbosity | int | | | +* | | Preconditioner.DetermineRelaxationFactor | bool | true | | +* | | Preconditioner.PowerLawIterations | std::size_t | 5 | | +* | | Preconditioner.Relaxation | double | 1 | | +* | | ResidualReduction | double | 1e-13| | +* | | ResidualReduction | Scalar | 1e-6 | | +* | | Verbosity | int | 0 | | * | \b LoadSolution | CellCenterPriVarNames | std::vector<std::string> | | | * | | FacePriVarNames | std::vector<std::string> | | | * | | PriVarNames | std::vector<std::string> | | | +* | \b MatrixConverter | DeletePatternEntriesBelowAbsThreshold | Scalar | -1.0 | | * | \b MixedDimension | IntegrationOrder | int | 1 | | * | | KernelWidth | Scalar | | | * | | NumCircleSegments | int | | | @@ -165,11 +172,10 @@ Adaptive | MaxLevel | std::size_t | 0 | | * | | TargetSteps | int | | | * | | UseLineSearch | bool | | | * | | Verbosity | int | 2 | | +* | \b PrimaryVariableSwitch | Verbosity | int | 1 | | * | \b Problem | EnableGravity | bool | | | -* | | EnableGravity | bool | | | * | | EnableInertiaTerms | bool | | | * | | Name | std::string | | | -* | | Name | std::string | | | * | | UsePrimaryVariableSwitch | bool | | | * | \b RANS | EddyViscosityModel | std::string | vanDriest | | * | | FlowNormalAxis | int | -1 | | @@ -190,8 +196,6 @@ Adaptive | MaxLevel | std::size_t | 0 | | * | | SubTimestepVerbosity | int | | | * | | TEnd | Scalar | | | * | \b Vtk | AddProcessRank | bool | | | -* | | AddProcessRank | bool | | | -* | | AddVelocity | bool | | | * | | AddVelocity | bool | true | | * | | OutputLevel | int | | | * | | WriteFaceData | bool | false | | -- GitLab