From 9562268796c253071c7e2d5227ce054b2b2687dc 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, 14 Sep 2021 17:15:15 +0200
Subject: [PATCH] Added parameter documentation to 'build_training_data().'
---
DG_Approximation.py | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/DG_Approximation.py b/DG_Approximation.py
index 7cf7338..5adaef2 100644
--- a/DG_Approximation.py
+++ b/DG_Approximation.py
@@ -305,6 +305,15 @@ class DGScheme(object):
Initializes projection and calculates cell averages and reconstructions for it.
+ Parameters
+ ----------
+ adjustment : float
+ Extent of adjustment of each evaluation point in x-direction.
+ stencil_length : int
+ Size of training data array.
+ initial_condition : InitialCondition object, optional
+ Initial condition used for calculation. Default: None (i.e. instance variable).
+
Returns
-------
np.array
--
GitLab