From 6db1930e39ce7cfa771982cd7d522ef9531a281a 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: Wed, 27 Apr 2022 16:05:19 +0200
Subject: [PATCH] Adapted docstring to uniform standard for colons in
'Basis_Function'.
---
Basis_Function.py | 12 ++++++------
DG_Approximation.py | 8 +++++++-
2 files changed, 13 insertions(+), 7 deletions(-)
diff --git a/Basis_Function.py b/Basis_Function.py
index e423aa8..7efd115 100644
--- a/Basis_Function.py
+++ b/Basis_Function.py
@@ -134,7 +134,7 @@ class Basis:
Matrix of projection for each polynomial degree.
stencil_length : int
Size of data array.
- add_reconstructions: bool, optional
+ add_reconstructions : bool, optional
Flag whether reconstructions of the middle cell are included.
Default: True.
@@ -171,9 +171,9 @@ class Basis:
Returns
-------
- left_reconstruction: ndarray
+ left_reconstruction : ndarray
List containing left reconstructions for given projection.
- right_reconstruction: ndarray
+ right_reconstruction : ndarray
List containing right reconstructions for given projection.
"""
@@ -447,7 +447,7 @@ class OrthonormalLegendre(Legendre):
Matrix of projection for each polynomial degree.
stencil_length : int
Size of data array.
- add_reconstructions: bool, optional
+ add_reconstructions : bool, optional
Flag whether reconstructions of the middle cell are included.
Default: True.
@@ -489,9 +489,9 @@ class OrthonormalLegendre(Legendre):
Returns
-------
- left_reconstruction: list
+ left_reconstruction : list
List containing left reconstructions for given projection.
- right_reconstruction: list
+ right_reconstruction : list
List containing right reconstructions for given projection.
"""
diff --git a/DG_Approximation.py b/DG_Approximation.py
index c506966..85512b9 100644
--- a/DG_Approximation.py
+++ b/DG_Approximation.py
@@ -5,9 +5,15 @@
Discussion:
TODO: Contemplate saving 5-CV split and evaluating models separately
TODO: Contemplate separating cell average and reconstruction calculations
+ completely
Urgent:
-TODO: Hard-code simplification of cell average/reconstruction in basis
+TODO: Hard-code simplification of cell average/reconstruction in basis -> Done
+TODO: Add documentation to _calculate_reconstructions() in Basis -> Done
+TODO: Investigate protected vs. public variables -> Done
+TODO: Adapt docstring to uniform standard for colons -> Done
+TODO: Investigate decorators and properties
+TODO: Investigate how to make variables read-only
TODO: Make basis variables public (if feasible)
TODO: Contain polynomial degree in basis
TODO: Introduce Mesh class
--
GitLab