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

Removed typos and added missing parameter description.

parent ba0c0f83
Branches
Tags
No related merge requests found
...@@ -264,7 +264,7 @@ class DGScheme(object): ...@@ -264,7 +264,7 @@ class DGScheme(object):
adjustment: float adjustment: float
Extent of adjustment of each evaluation point in x-direction. Extent of adjustment of each evaluation point in x-direction.
Results Returns
------- -------
np.array np.array
Matrix containing projection of size (N+2, p+1) with N being the number of grid cells Matrix containing projection of size (N+2, p+1) with N being the number of grid cells
......
...@@ -601,7 +601,14 @@ class Theoretical(WaveletDetector): ...@@ -601,7 +601,14 @@ class Theoretical(WaveletDetector):
""" """
def _reset(self, config): def _reset(self, config):
"""Resets instance variables.""" """Resets instance variables.
Parameters
----------
config : dict
Additional parameters for detector.
"""
super()._reset(config) super()._reset(config)
# Unpack necessary configurations # Unpack necessary configurations
......
...@@ -2,10 +2,8 @@ ...@@ -2,10 +2,8 @@
""" """
@author: Laura C. Kühle @author: Laura C. Kühle
TODO: Discuss description of matrices TODO: Discuss descriptions (matrices, cfl number, right-hand side, etc.)
TODO: Discuss description for cfl number
TODO: Discuss referencing info on SSPRK3 TODO: Discuss referencing info on SSPRK3
TODO: Discuss description of right-hand side
""" """
import numpy as np import numpy as np
...@@ -22,7 +20,6 @@ class UpdateScheme(object): ...@@ -22,7 +20,6 @@ class UpdateScheme(object):
boundary_matrix : np.array boundary_matrix : np.array
Matrix Matrix
Methods Methods
------- -------
get_name() get_name()
...@@ -217,8 +214,8 @@ class SSPRK3(UpdateScheme): ...@@ -217,8 +214,8 @@ class SSPRK3(UpdateScheme):
def _apply_first_step(self, original_projection, cfl_number): def _apply_first_step(self, original_projection, cfl_number):
"""Apply first step of SSPRK3. """Apply first step of SSPRK3.
Parameter Parameters
--------- ----------
original_projection : np.array original_projection : np.array
Matrix of original projection for each polynomial degree. Matrix of original projection for each polynomial degree.
cfl_number : float cfl_number : float
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment