From c419d757a58521e686361e3b8d179f79d4e2e014 Mon Sep 17 00:00:00 2001
From: David Seus <david.seus@ians.uni-stuttgart.de>
Date: Wed, 14 Oct 2020 11:21:31 +0200
Subject: [PATCH] forgot to save

---
 LDDsimulation/README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/LDDsimulation/README.md b/LDDsimulation/README.md
index 680e6d0..e1f87cf 100644
--- a/LDDsimulation/README.md
+++ b/LDDsimulation/README.md
@@ -4,5 +4,23 @@ This folder contains the actual LDD simulation code. To facilitate development,
 we give a briefe description of the files.
 
 ## `LDDsimulation.py`
+If you want to read the code, this is where you should
+start.
+This file defines the core and soul of the LDD simulation code.
+It defines the class `LDDsimulation` that contains methods to setup the
+simulation and run it. Each usecase file in `../Usecases` essentially
+sets up an instance of this class and defines
+all parameters needed by the `LDDsimulation.set_parameters(kwrgs**)` function
+which gets called 
 
-##
+## `domainPatch.py`
+
+## `boundary_and_interface.py`
+
+## `solutionFile.py`
+
+## `domainSubstructuring.py`
+
+##  `functions.py`
+
+## `helpers.py`
-- 
GitLab