Skip to content
Snippets Groups Projects
Commit 22dff230 authored by Deepak Rangarajan's avatar Deepak Rangarajan
Browse files

documenation update to support EB checkpoint files

parent 9f2390cd
No related branches found
No related tags found
1 merge request!21documentation update to support EB checkpoint files
......@@ -5,17 +5,22 @@ Checkpoint/Restart
The following inputs must be preceded by "amr" and control checkpoint/restart.
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| | Description | Type | Default |
+==================+=======================================================================+=============+===========+
| restart | If present, then the name of file to restart from | String | None |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| check_int | Frequency of checkpoint output; | Int | -1 |
| | if -1 then no checkpoints will be written | | |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| check_file | Prefix to use for checkpoint output | String | chk |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| check_walltime | Write a check point file after the specified walltime (HH:MM:SS) | String | None |
| | has lapsed. For example, if amr.check_waltime = 00:10:00, then a | | |
| | checkpoint file is after a job has run for ten minutes. | | |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
+-------------------------+-----------------------------------------------------------------------+-------------+-----------+
| | Description | Type | Default |
+=========================+=======================================================================+=============+===========+
| restart | If present, then the name of file to restart from | String | None |
+-------------------------+-----------------------------------------------------------------------+-------------+-----------+
| check_int | Frequency of checkpoint output; | Int | -1 |
| | if -1 then no checkpoints will be written | | |
+-------------------------+-----------------------------------------------------------------------+-------------+-----------+
| check_file | Prefix to use for checkpoint output | String | chk |
+-------------------------+-----------------------------------------------------------------------+-------------+-----------+
| check_walltime | Write a check point file after the specified walltime (HH:MM:SS) | String | None |
| | has lapsed. For example, if amr.check_waltime = 00:10:00, then a | | |
| | checkpoint file is after a job has run for ten minutes. | | |
+-------------------------+-----------------------------------------------------------------------+-------------+-----------+
| write_geom_chk | When True, writes the EB geometry data into a checkpoint file. | bool | False |
+-------------------------+-----------------------------------------------------------------------+-------------+-----------+
| use_geom_chk_if_present | When True, looks for the EB geometry checkpoint file in the | bool | True |
| | current direcotry and uses it, overriding any EB geometry in inputs | | |
+-------------------------+-----------------------------------------------------------------------+-------------+-----------+
......@@ -103,6 +103,8 @@ The following inputs must be preceded by "mfix."
+========================+===================================================================+==========+=====================+
| geometry | Which type of EB geometry are we using? | String | |
+------------------------+-------------------------------------------------------------------+----------+---------------------+
| geometry_filename | The CSG file that defines the EB geometry | String | |
+------------------------+-------------------------------------------------------------------+----------+---------------------+
| levelset__refinement | Refinement factor of levelset resolution relative to level 0 | Int | 1 |
| | resolution | | |
+------------------------+-------------------------------------------------------------------+----------+---------------------+
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment