diff --git a/DG_Approximation.py b/DG_Approximation.py index 5adaef2efd33df4111108938d72502cef2e11f57..3d64716eeb6996305482d80c640a274c59e7054b 100644 --- a/DG_Approximation.py +++ b/DG_Approximation.py @@ -264,7 +264,7 @@ class DGScheme(object): adjustment: float Extent of adjustment of each evaluation point in x-direction. - Results + Returns ------- np.array Matrix containing projection of size (N+2, p+1) with N being the number of grid cells diff --git a/Troubled_Cell_Detector.py b/Troubled_Cell_Detector.py index 7bd7a69f08fa792018377da771f3dff926a59749..e558187f93d846e0cb6ee3455fbefdb882ca749d 100644 --- a/Troubled_Cell_Detector.py +++ b/Troubled_Cell_Detector.py @@ -601,7 +601,14 @@ class Theoretical(WaveletDetector): """ def _reset(self, config): - """Resets instance variables.""" + """Resets instance variables. + + Parameters + ---------- + config : dict + Additional parameters for detector. + + """ super()._reset(config) # Unpack necessary configurations diff --git a/Update_Scheme.py b/Update_Scheme.py index 1081c85d4824d87eb6f889004dde76639adca59e..f5dc8d8b1f2adc4f354a4f060b2a23acefd015a7 100644 --- a/Update_Scheme.py +++ b/Update_Scheme.py @@ -2,10 +2,8 @@ """ @author: Laura C. Kühle -TODO: Discuss description of matrices -TODO: Discuss description for cfl number +TODO: Discuss descriptions (matrices, cfl number, right-hand side, etc.) TODO: Discuss referencing info on SSPRK3 -TODO: Discuss description of right-hand side """ import numpy as np @@ -22,7 +20,6 @@ class UpdateScheme(object): boundary_matrix : np.array Matrix - Methods ------- get_name() @@ -217,8 +214,8 @@ class SSPRK3(UpdateScheme): def _apply_first_step(self, original_projection, cfl_number): """Apply first step of SSPRK3. - Parameter - --------- + Parameters + ---------- original_projection : np.array Matrix of original projection for each polynomial degree. cfl_number : float