From db598481d6ebbfa2b1cecc871deed59ddd8022b1 Mon Sep 17 00:00:00 2001
From: David Seus <david.seus@mathematik.uni-stuttgart.de>
Date: Tue, 13 Oct 2020 14:25:28 +0200
Subject: [PATCH] Update README.md
---
Usecases/README.md | 19 +++++++------------
1 file changed, 7 insertions(+), 12 deletions(-)
diff --git a/Usecases/README.md b/Usecases/README.md
index 45cb504..61d6cf5 100644
--- a/Usecases/README.md
+++ b/Usecases/README.md
@@ -127,26 +127,22 @@ In detail:
If more than one entry is given in `resolutions`, all pairs are being calculated in parallel. This is usefull if one is interested in the results
of the same usecase but calcuated for different mesh sizes h.
Notably, if `mesh_study` is `True`you should have most of the above commented out, and data for a mesh study is performed. Notably space-time errornorms are put out.
- >>>
+
+ ~~~
**!Warning!**
Notably the last to pairs take a long time to calculate and memory shortage
might be an issue depending on your machine.
- >>>
+ ~~~
- - `starttimes = {0: 0.0}`: `starttimes` is a dictionary containing pairs
- `t0_index: t0` specifying starttimes `t0` along with the number this start time should be given `t0_index`. Usually you will want to have `t0_index`
+- `starttimes = {0: 0.0}`: `starttimes` is a dictionary containing pairs
+ `t0_index: t0` specifying starttimes `t0` along with the number this start time should be given `t0_index`. Usually you will want to have `t0_index`
set to zero because `t0` is the intial timestep.
However, if the simulation stopped for some reason and part of the data is
valid, a later time can be specified along with the index of the timestep
it had in the first attempt of the simulation.
- >>>
- **Example:** Say you wanted start
- the simulation at `t0 = 0.5` and let that be the 87th timestep, you would set
- `starttimes = {87: 0.5}`.
- >>>
-
+**Example:** Say you wanted start the simulation at `t0 = 0.5` and let that be the 87th timestep, you would set
+`starttimes = {87: 0.5}`.
In case more than one element is given parallel simulations are started starting from the specified starttimes.
- >>>
**Example:**
Assume `timestep_size = 0.01` and `number_of_timesteps = 50`
`starttimes = {
@@ -155,7 +151,6 @@ In detail:
}`
yields a simulation over [0.0,1.0] but split into to processes and saved into
two different folders.
- >>>
This is also usefull to test parameters if `number_of_timesteps = 1` and
the behaviour of the solver want to be tested at various timesteps one
could set up an example as
--
GitLab