diff --git a/Basis_Function.py b/Basis_Function.py index e423aa8b8876851c301822e69be9e0df5347bf1d..7efd115cb0970fa9969248ab3fdcc499495909d7 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 c50696680470da37c4426fe9fe8c2cbf29cc5cb7..85512b9f079571d19a541d9ecc6c13f8ec326c29 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