From 0e96b3ba34657990d87a9df0ca647cadabd0f6a8 Mon Sep 17 00:00:00 2001 From: Deepak Rangarajan Date: Wed, 12 Feb 2025 09:58:30 -0500 Subject: [PATCH] correct input for EB restart file --- .../inputs/output/checkpointing.rst | 60 +++++++++---------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/output/checkpointing.rst b/docs/source_docs/user_guide/inputs/output/checkpointing.rst index d555842..8e4c718 100644 --- a/docs/source_docs/user_guide/inputs/output/checkpointing.rst +++ b/docs/source_docs/user_guide/inputs/output/checkpointing.rst @@ -5,33 +5,33 @@ Checkpointing The following inputs must be preceded by "mfix." 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 in timesteps number; | Int | -1 | -| | if -1 then no checkpoints will be written | | | -+-------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| check_per_approx | Frequency of checkpoint output in simulation time; | Real | 0 | -| | if 0 then no checkpoints will be written | | | -+-------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| check_walltime_interval | Frequency of checkpoint output in runtime (HH:MM:SS) | String | "" | -+-------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| check_file | Prefix to use for checkpoint output | String | chk | -+-------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| geom_chk_write | When True, writes the EB geometry data into geom_chk_file | bool | False | -| | and additionally, geom_refined_chk_file, if levelset | | | -| | refinement is enabled. | | | -+-------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| geom_chk_read | When True, reads the EB geometry data from geom_chk_file | bool | False | -| | and additionally, geom_refined_chk_file, if levelset | | | -| | refinement is enabled. | | | -+-------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| geom_chk_file | Name of the EB checkpoint file that is used to store or read | String | geom_chk | -| | the unrefined geometry. | | | -+-------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| geom_refined_chk_file | Name of the EB checkpoint file that is used to store or read | String | geom\_ | -| | the refined geometry, i.e. when levelset refinement is enabled. | | refined\_ | -| | | | chk | -+-------------------------+-----------------------------------------------------------------------+-------------+-----------+ ++-------------------------+-----------------------------------------------------------------------+-------------+------------+ +| | Description | Type | Default | ++=========================+=======================================================================+=============+============+ +| restart | If present, then the name of file to restart from | String | None | ++-------------------------+-----------------------------------------------------------------------+-------------+------------+ +| check_int | Frequency of checkpoint output in timesteps number; | Int | -1 | +| | if -1 then no checkpoints will be written | | | ++-------------------------+-----------------------------------------------------------------------+-------------+------------+ +| check_per_approx | Frequency of checkpoint output in simulation time; | Real | 0 | +| | if 0 then no checkpoints will be written | | | ++-------------------------+-----------------------------------------------------------------------+-------------+------------+ +| check_walltime_interval | Frequency of checkpoint output in runtime (HH:MM:SS) | String | "" | ++-------------------------+-----------------------------------------------------------------------+-------------+------------+ +| check_file | Prefix to use for checkpoint output | String | chk | ++-------------------------+-----------------------------------------------------------------------+-------------+------------+ +| geom_chk_write | When True, writes the EB geometry data into geom_chk_file | bool | False | +| | and additionally, geom_levelset_chk_file, if levelset | | | +| | refinement is enabled. | | | ++-------------------------+-----------------------------------------------------------------------+-------------+------------+ +| geom_chk_read | When True, reads the EB geometry data from geom_chk_file | bool | False | +| | and additionally, geom_levelset_chk_file, if levelset | | | +| | refinement is enabled. | | | ++-------------------------+-----------------------------------------------------------------------+-------------+------------+ +| geom_chk_file | Name of the EB checkpoint file that is used to store or read | String | geom_chk | +| | the unrefined geometry. | | | ++-------------------------+-----------------------------------------------------------------------+-------------+------------+ +| geom_levelset_chk_file | Name of the EB checkpoint file that is used to store or read | String | geom\_ | +| | the refined geometry, i.e. when levelset refinement is enabled. | | levelset\_ | +| | | | chk | ++-------------------------+-----------------------------------------------------------------------+-------------+------------+ -- GitLab