diff --git a/docs/source_docs/inputs/InputsCheckpoint.rst b/docs/source_docs/inputs/InputsCheckpoint.rst index 33ce629d4a71f24f46e7d96b6a6e5bd998f8c013..6bd0a6d60c400581fc5d83ff234d6c85e28c23d7 100644 --- a/docs/source_docs/inputs/InputsCheckpoint.rst +++ b/docs/source_docs/inputs/InputsCheckpoint.rst @@ -16,15 +16,9 @@ The following inputs must be preceded by "mfix." and control checkpoint/restart. | check_per_approx | Frequency of checkpoint output in simulation time; | Real | 0 | | | if 0 then no checkpoints will be written | | | +-------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| check_file | Prefix to use for checkpoint output | String | chk | -+-------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| check_walltime_limit | Write a check point file before the specified walltime (HH:MM:SS) | Real | -1 | -| | has been reached. For example, if mfix.check_walltime_limit = 0:10:00 | | | -| | then a checkpoint file is written a little time before the job has | | | -| | reached 10 minutes of runtime | | | +| check_walltime_interval | Frequency of checkpoint output in runtime (HH:MM:SS) | String | "" | +-------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| check_walltime_buffer | This is time subtracted to check_walltime_limit to avoid the job is | Real | 300 | -| | killed before mfix has completed writing the checkpoint file | | | +| 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 | | | diff --git a/docs/source_docs/inputs/InputsTimeStepping.rst b/docs/source_docs/inputs/InputsTimeStepping.rst index 888c4f067cd3b98193055cb14a82af09a636f0c7..9dcb6e908264fb7652ddd2c05a34549b76e3cf60 100644 --- a/docs/source_docs/inputs/InputsTimeStepping.rst +++ b/docs/source_docs/inputs/InputsTimeStepping.rst @@ -28,6 +28,19 @@ The following inputs must be preceded by "mfix.": +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | tcoll_ratio | DEM timestep equals the min collision time divided by this value | Real | 50.0 | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ +| walltime_limit | Write a check point file before the specified walltime (HH:MM:SS) | String | "" | +| | has been reached. For example, if mfix.walltime_limit = 0:10:00, then | | | +| | timestepping is terminated just before runtime has reached the fixed | | | +| | walltime, and the code performs a clean exit | | | ++----------------------+-----------------------------------------------------------------------+-------------+--------------+ +| walltime_buffer | This time value, specified as HH:MM:SS, is used to determine whether | String | "" | +| | to plot a checkpoint file before the job is terminated by the value | | | +| | in walltime_limit. If job is terminated, a checkpoint file is written | | | +| | starting at time walltime_limit minus walltime_buffer | | | ++----------------------+-----------------------------------------------------------------------+-------------+--------------+ +| clean_exit | This input represents the name of a file that, if found in the run | String | "" | +| | folder, makes the code stop and perform a clean exit | | | ++----------------------+-----------------------------------------------------------------------+-------------+--------------+ The following inputs must be preceded by "mfix." and are only relevant if running a problem to steady state. Currently, the criterion for setting "steady_state" to true is if "dt" is undefined in mfix.dat