From 22dff230436db02408566b8c6ae8f5182b7002b5 Mon Sep 17 00:00:00 2001 From: Deepak Rangarajan <deepak.rangarajan@netl.doe.gov> Date: Wed, 7 Sep 2022 14:40:47 +0000 Subject: [PATCH] documenation update to support EB checkpoint files --- docs/source/inputs/InputsCheckpoint.rst | 33 +++++++++++-------- .../source/inputs/InputsProblemDefinition.rst | 2 ++ 2 files changed, 21 insertions(+), 14 deletions(-) diff --git a/docs/source/inputs/InputsCheckpoint.rst b/docs/source/inputs/InputsCheckpoint.rst index e6c08cb..cdef4f6 100644 --- a/docs/source/inputs/InputsCheckpoint.rst +++ b/docs/source/inputs/InputsCheckpoint.rst @@ -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 | | | ++-------------------------+-----------------------------------------------------------------------+-------------+-----------+ diff --git a/docs/source/inputs/InputsProblemDefinition.rst b/docs/source/inputs/InputsProblemDefinition.rst index bdcd848..abbbf98 100644 --- a/docs/source/inputs/InputsProblemDefinition.rst +++ b/docs/source/inputs/InputsProblemDefinition.rst @@ -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 | | | +------------------------+-------------------------------------------------------------------+----------+---------------------+ -- GitLab