From 0e69e6900c684d3eaaafd2e83e54f874c391e268 Mon Sep 17 00:00:00 2001 From: David Seus <david.seus@ians.uni-stuttgart.de> Date: Mon, 12 Oct 2020 14:50:48 +0200 Subject: [PATCH] add warning about Archived scripts --- Usecases/README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/Usecases/README.md b/Usecases/README.md index c68bda6..b8db00a 100644 --- a/Usecases/README.md +++ b/Usecases/README.md @@ -12,9 +12,23 @@ 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. +>>> +**Waring** +The usecases in the various `Archive` folders are obsolete. +They were used at one point in time in the development +of the LDD code usually for debugging but have been abandoned at one point in +time. +This means that the scripts are not up to date and up to par with the qualtiy +in the non-Archive folders. Most likely, they will not work anymore. + +In some cases these scripts are being kept for reference or because older +simulation datat based on the older scripts have been used. +If you want to revive some of these examples, copy one of the official examples +and update that copy with information in these scripts +>>> ## How to create your own usecases In order to create a new usecase, either modify one of the existing ones, or copy one of the existing cases into a new file and start working on your own. To understand how usecases are set up, let's have a look at the file -[TP-R-2-patch-test.py](./Two-Phase-Richards/two-patch/TP-R-two-patch-test-case/TP-R-2-patch-test.py). +[TP-R-2-patch-test.py](./Two-Phase-Richards/two-patch/TP-R-two-patch-test-case). -- GitLab