From 0f8f808ba7360a7d92ce654424cc9cea1bdf78fb 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: Tue, 26 Apr 2022 13:42:02 +0200
Subject: [PATCH] Added documentation to '_calculate_reconstructions()' in
 Basis.

---
 Basis_Function.py | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/Basis_Function.py b/Basis_Function.py
index 1563cf8..e423aa8 100644
--- a/Basis_Function.py
+++ b/Basis_Function.py
@@ -162,6 +162,21 @@ class Basis:
         return np.array(list(map(np.float64, cell_averages)))
 
     def _calculate_reconstructions(self, projection):
+        """Calculate left and right reconstructions for a given projection.
+
+        Parameters
+        ----------
+        projection : ndarray
+            Matrix of projection for each polynomial degree.
+
+        Returns
+        -------
+        left_reconstruction: ndarray
+            List containing left reconstructions for given projection.
+        right_reconstruction: ndarray
+            List containing right reconstructions for given projection.
+
+        """
         left_reconstructions = calculate_approximate_solution(
             projection, np.array([-1]), self._polynomial_degree, self._basis)
         right_reconstructions = calculate_approximate_solution(
-- 
GitLab