Info on test case in README

joeatodd · Jun 13, 2018 · 7933633 · 7933633
1 parent b7f9755
commit 7933633
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -4,6 +4,7 @@
 	- 'Run Name' parameter, appended to all output data
 	- 'Restart from Run Name' to make restarting easier
 	- 'Work Directory' and 'Results Directory' for organising output
+	- Synthetic test case
 
 ### Changed
 	- Format of input file (now specified as "Param Name = Value" rather than ordered list)

diff --git a/README.md b/README.md
@@ -71,6 +71,12 @@ Do something to the restitution coefficient
 
 Point to the input file (e.g. testinp.dat) using HIDEM_STARTINFO
 
+## Test Case ##
+
+A test case is provided in the `test` directory. This is a simple rectangular domain with a sloping upper surface. This simulation will produce fracturing behaviour within a 6 hour simulation on 130 CPUs. The user should edit `example.job` to provide a valid PBS budget account, and the correct number of nodes and cores (currently 6, 130) depending on system architecture (cores per node).
+
+The behaviour of the test case can be changed by modifying `Max Load` and `Friction Scale` in inp.dat.
+
 ## Running the model ##
 
 The model runs in parallel using MPI, so the simulation should be started using `mpirun` or `aprun`: