From 88767050063f0158ceb6aedefdbc225123b4ea44 Mon Sep 17 00:00:00 2001 From: David Seus <david.seus@ians.uni-stuttgart.de> Date: Wed, 14 Oct 2020 15:49:34 +0200 Subject: [PATCH] explain what a usecase is. --- Usecases/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Usecases/README.md b/Usecases/README.md index 09472b9..03ab25a 100644 --- a/Usecases/README.md +++ b/Usecases/README.md @@ -12,6 +12,12 @@ The structure is as follows. Each of the folders contains subfolders such as `one-patch`, `two-patch` and `multi-patch` holding domain decomposition examples featuriing one-patch, two-patch or multi-patch substructurings. This ordering has been introduced to keep things tidy. You may introduce your own ordering, of course. +Each usecase is a python script making use of the code in `../LDDsimulation` +to setup and run a simulation. +The different usecases could have been distilled in a usecase class to increase +maintainability. This was desided against mostely due to time contstraints. +If you plan on expand on this code, it might be a good idea to think about +a usecase class to tidy up the usecases even further. >>> **!Waring!** The usecases in the various `Archive` folders are obsolete. -- GitLab