From 5e7efa2ac3979941cfe18d3c6907a67f21d7dee8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?K=C3=BChle=2C=20Laura=20Christine=20=28lakue103=29?=
<laura.kuehle@uni-duesseldorf.de>
Date: Sun, 19 Sep 2021 21:40:22 +0200
Subject: [PATCH] Removed typos and added missing parameter description.
---
DG_Approximation.py | 2 +-
Troubled_Cell_Detector.py | 9 ++++++++-
Update_Scheme.py | 9 +++------
3 files changed, 12 insertions(+), 8 deletions(-)
diff --git a/DG_Approximation.py b/DG_Approximation.py
index 5adaef2..3d64716 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 7bd7a69..e558187 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 1081c85..f5dc8d8 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
--
GitLab