Skip to content
Snippets Groups Projects
Commit c73b1f04 authored by Laura Christine Kühle's avatar Laura Christine Kühle
Browse files

Added some generic class documentation.

parent 4929b918
No related branches found
No related tags found
No related merge requests found
......@@ -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)
......
......@@ -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)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment