diff --git a/DG_Approximation.py b/DG_Approximation.py index d2da85372da8a0cb9731e63821d7042270ef2fe4..c7c892abac9d86f98a8592c7a977e08362ed76cf 100644 --- a/DG_Approximation.py +++ b/DG_Approximation.py @@ -3,7 +3,7 @@ @author: Laura C. Kühle Plotter: -TODO: Contemplate using Seaborn instead of matplotlib +TODO: Contemplate using Seaborn instead of matplotlib -> Done (used now) TODO: Double-check everything! TODO: Replace loops with list comprehension if feasible @@ -12,11 +12,8 @@ TODO: Write documentation for all methods TODO: Restructure Vectors_of_Polynomials -> Done TODO: Rename Vectors_of_Polynomials -> Done (Basis_Function) -TODO: Ask about Legendre as scaling vector -TODO: Ask whether basis and wavelet should both depend on x (or x and z) -TODO: Ask about renaming ModifiedMinMod to Cockburn-Shu (like Gerhard et al.) TODO: Contemplate how to make shock tubes comparable -TODO: Implement type check for all kwargs and configs +TODO: Implement type check for all kwargs and configs -> Done (not recommended for Python) """ import numpy as np @@ -36,6 +33,12 @@ xi = Symbol('z') class DGScheme(object): + """ + Do documentation here. + + Here come some parameter. + """ + def __init__(self, detector, **kwargs): # Unpack keyword arguments self._wave_speed = kwargs.pop('wave_speed', 1) diff --git a/Limiter.py b/Limiter.py index 22e0189f31484e23be8064c6db876fe01be2babd..6397bbc4329508782fc78a863cd1d68582eb8243 100644 --- a/Limiter.py +++ b/Limiter.py @@ -63,6 +63,12 @@ class MinMod(Limiter): class ModifiedMinMod(MinMod): + """ + Do documentation here. Also called Cockburn-Shu limiter. + + Here come some parameter. + """ + def _reset(self, config): super()._reset(config)