diff --git a/Usecases/README.md b/Usecases/README.md index 21008e19aeafb6c30259d0a82c4e42df4ff45622..c68bda68ee9ce84e0d57e728ae42177c7c973c56 100644 --- a/Usecases/README.md +++ b/Usecases/README.md @@ -8,3 +8,13 @@ The structure is as follows. only the Richards model. - [Two-Phase-Richards](./Two-Phase-Richards): domain decomposition examples using a flexible combination of the Richards and two-phase flow model. - [Two-Phase-Two-Phase](./Two-Phase-Two-Phase): domain decomposition examples using only the two-phase flow model. + +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. + +## 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).