Merge pull request #21 from drangara/eb_checkpoint_files

documentation update to support EB checkpoint files

docs/source/inputs/InputsCheckpoint.rst

@@ -5,17 +5,19 @@ 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     |
++-------------------------+-----------------------------------------------------------------------+-------------+-----------+

docs/source/inputs/InputsProblemDefinition.rst

@@ -102,6 +102,11 @@ The following inputs must be preceded by "mfix."
 |                        | Description                                                       |   Type   | Default             |
 +========================+===================================================================+==========+=====================+
 | geometry               | Which type of EB geometry are we using?                           |   String |                     |
+|                        |                                                                   |          |                     |
+|                        | To use geometry from EB checkpoint file in current directory      |          |                     |
+|                        | set value to "chkptfile"                                          |          |                     |
++------------------------+-------------------------------------------------------------------+----------+---------------------+
+| 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                                                        |          |                     |