From 2820ed3cef7a825bd1d6b922c3bd1b07d19cdb6d Mon Sep 17 00:00:00 2001
From: Robert K <robertk@posteo.org>
Date: Wed, 3 Mar 2021 13:03:51 +0100
Subject: [PATCH] [feature][camc-paper] Added doc strings for parameter output.
---
pydemo/camc-paper/advection.py | 8 ++++++--
pydemo/camc-paper/euler_kh.py | 17 +++++++++--------
pydemo/camc-paper/ns_kh.py | 14 +++++++-------
python/dune/femdg/__main__.py | 6 +++---
4 files changed, 25 insertions(+), 20 deletions(-)
diff --git a/pydemo/camc-paper/advection.py b/pydemo/camc-paper/advection.py
index 51ea004a..667e7268 100644
--- a/pydemo/camc-paper/advection.py
+++ b/pydemo/camc-paper/advection.py
@@ -1,7 +1,12 @@
import os
from argparse import ArgumentParser
parser = ArgumentParser()
-parser.add_argument('problem', type=int)
+parser.add_argument('problem', type=int,
+ help="""
+ Possible choices for problem: \n
+ 1 = without limiting | 2 = minmod | 3 = minmod & physical |
+ 4 = scaling | 5 = adaptive without limiting | 6 = adaptive and limiting
+ """)
parser.add_argument
parser.parse_args()
try:
@@ -17,7 +22,6 @@ from dune.polygongrid import polygonGrid
import dune.fem
dune.fem.parameter.append({"fem.verboserank":0})
-# dune.fem.parameter.append({"fem.parallel.numberofthreads":8})
from advection_model import model
from evolve import evolve
diff --git a/pydemo/camc-paper/euler_kh.py b/pydemo/camc-paper/euler_kh.py
index 0c5ccdfe..b6918fb4 100644
--- a/pydemo/camc-paper/euler_kh.py
+++ b/pydemo/camc-paper/euler_kh.py
@@ -2,14 +2,15 @@ import os, sys
from argparse import ArgumentParser
parser = ArgumentParser()
-parser.add_argument('level', type=int)
-parser.add_argument('--space', type=str, default="onb")
-parser.add_argument('--stepper', type=str, default="ssp3")
-parser.add_argument('--dim', type=int, default=2)
-parser.add_argument('--order', type=int, default=4)
-parser.add_argument('--grid', type=str, default="cube")
-parser.add_argument('--out', type=int, default=50)
-parser.add_argument('--modal', type=str, default='')
+parser.add_argument('level', type=int, help="max refinement level (negative means non-adaptive)")
+parser.add_argument('--space', type=str, default="onb",
+ help="onb|legendre|lagrange|equidistant|lobatto|gauss")
+parser.add_argument('--stepper', type=str, default="ssp3",help="ssp2|ssp3|femdg (default: ssp3)")
+parser.add_argument('--dim', type=int, default=2, help="2|3 (default: 2)")
+parser.add_argument('--order', type=int, default=4,help="[0,...,8] (default: 4)")
+parser.add_argument('--grid', type=str, default="cube", help="cube|simplex|naffine|poly (default: cube)")
+parser.add_argument('--out', type=int, default=50,help="number of output steps (default: 50)")
+parser.add_argument('--modal', type=str, default='',help="switch on modal limiter")
parser.add_argument
parser.parse_args()
try:
diff --git a/pydemo/camc-paper/ns_kh.py b/pydemo/camc-paper/ns_kh.py
index f9129da2..827ef13f 100644
--- a/pydemo/camc-paper/ns_kh.py
+++ b/pydemo/camc-paper/ns_kh.py
@@ -2,13 +2,13 @@ import os, sys
from argparse import ArgumentParser
parser = ArgumentParser()
-parser.add_argument('level', type=int)
-parser.add_argument('--space', type=str, default="onb")
-parser.add_argument('--stepper', type=str, default="femdg")
-parser.add_argument('--order', type=int, default=4)
-parser.add_argument('--grid', type=str, default="cube")
-parser.add_argument('--out', type=int, default=100)
-parser.add_argument('--mu', type=float, default=0.001)
+parser.add_argument('level', type=int, help="max refinement level (negative means non-adaptive)")
+parser.add_argument('--space', type=str, default="onb", help="onb|legendre|lagrange|equidistant|lobatto|gauss")
+parser.add_argument('--stepper', type=str, default="ssp3",help="ssp2|ssp3|femdg (default: femdg)")
+parser.add_argument('--order', type=int, default=4,help="[0,...,8] (default: 4)")
+parser.add_argument('--grid', type=str, default="cube", help="cube|simplex|naffine|poly (default: cube)")
+parser.add_argument('--out', type=int, default=100,help="number of output steps (default: 100)")
+parser.add_argument('--mu', type=float, default=0.001, help="viscosity parameter mu (default: 0.001)")
parser.add_argument
parser.parse_args()
try:
diff --git a/python/dune/femdg/__main__.py b/python/dune/femdg/__main__.py
index f64a870a..9a6ef168 100644
--- a/python/dune/femdg/__main__.py
+++ b/python/dune/femdg/__main__.py
@@ -17,8 +17,8 @@ rm -rf tmp
'''
subprocess.check_output(commands, shell=True)
-print("############################################################")
-print("## The tutorial is now located in the 'femdg_tutorial' folder.")
+print("###################################################################")
+print("## The tutorial is now located in the 'femdg_tutorial' folder. ")
try:
import matplotlib
except ImportError:
@@ -27,4 +27,4 @@ try:
import scipy
except ImportError:
print("## Note: some of the examples require the installation of 'scipy'.")
-print("############################################################")
+print("###################################################################")
--
GitLab