From 6f2abc1fe7bf52e764fb4447670faa4e56b2e724 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, 4 Oct 2022 16:58:20 +0200
Subject: [PATCH] Added method and error info to Mesh.

---
 projection_utils.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/projection_utils.py b/projection_utils.py
index 9df5830..d159bd8 100644
--- a/projection_utils.py
+++ b/projection_utils.py
@@ -40,6 +40,13 @@ class Mesh:
     cells : ndarray
         Array of cell centers in mesh.
 
+    Methods
+    -------
+    create_data_dict()
+        Return dictionary with data necessary to construct mesh.
+    random_stencil(stencil_len)
+        Return random stencil.
+
     """
 
     def __init__(self, num_cells: int, num_ghost_cells: int,
@@ -62,6 +69,11 @@ class Mesh:
             Flag indicating whether the mesh is used for training data
             generation. Default: False.
 
+        Raises
+        ------
+        ValueError
+            If number of cells is not exponential of 2.
+
         """
         self._num_cells = num_cells
         self._mode = 'training' if training_data_mode else 'evaluation'
-- 
GitLab