From 3af3371c39d98dba24438de3ef0f35739d1bf58e Mon Sep 17 00:00:00 2001
From: David Seus <david.seus@ians.uni-stuttgart.de>
Date: Tue, 13 Oct 2020 15:45:59 +0200
Subject: [PATCH] write I/O explanation
---
Usecases/README.md | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/Usecases/README.md b/Usecases/README.md
index 2c8bfd2..3c8a104 100644
--- a/Usecases/README.md
+++ b/Usecases/README.md
@@ -240,6 +240,20 @@ else:
'subsequent_errors': True
}
~~~
+This block sets up several options for outputting data. Control is given over
+how many timesteps are to be analysed and whether every timestep or every kth
+timestep should be written out.
+In this way performance can be optimised and data size can be managed.
+- `plot_timestep_every`: When `number_of_timesteps` is high, i.e. a high number
+of timesteps are to be calculated, writing all data out to disk every timestep
+can be time consuming. Therefore, `plot_timestep_every` sets the simulator to only write data of every plot_timestep_every -th timestep to disk.
+
+- `number_of_timesteps_to_analyse`: Decide how many timesteps you want analysed. Analysed means, that subsequent errors of the L-iteration within the timestep are written out and some processing is done within the timesteps to
+analyse what's going on. This number splits the simulation interval into intervals of equal length such that `number_of_timesteps_to_analyse` timesteps
+are written out.
+
+- `write_to_file`: Dictionary setting which data is to be written out. This can be adjusted depending on the `mesh_study` parameter.
+Various parameters are described in the comment.
### OUTPUT FILE STRING
~~~python
--
GitLab