From f0c49f2b1742a684d4052ef7c460b6821a37172b Mon Sep 17 00:00:00 2001 From: Adam Dempsey Date: Fri, 23 Aug 2024 14:56:23 -0600 Subject: [PATCH] Update parthenon/time parameters --- doc/sphinx/src/inputs.rst | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/doc/sphinx/src/inputs.rst b/doc/sphinx/src/inputs.rst index c68c89c7b95a..6d83ffceed7e 100644 --- a/doc/sphinx/src/inputs.rst +++ b/doc/sphinx/src/inputs.rst @@ -21,8 +21,8 @@ General parthenon options such as problem name and parameter handling. +---------------------+---------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Option | Default | Type | Description | +=====================+=========+=========+========================================================================================================================================================================================================+ -|| name || none || string || Name of this problem or initialization, prefixed to output files. | || archive_parameters || false || string || Produce a parameter file containing all parameters known to Parthenon. Set to `true` for an output file named `parthinput.archive`. Set to `timestamp` for a file with a name containing a timestamp. | +|| name || none || string || Name of this problem or initialization, prefixed to output files. | +---------------------+---------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -34,12 +34,23 @@ Options related to time-stepping and printing of diagnostic data. +------------------------------+---------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Option | Default | Type | Description | +==============================+=========+========+=======================================================================================================================================================================+ -|| tlim || none || float || Stop criterion on simulation time. | -|| nlim || -1 || int || Stop criterion on total number of steps taken. Ignored if < 0. | -|| perf_cycle_offset || 0 || int || Skip the first N cycles when calculating the final performance (e.g., zone-cycles/wall_second). Allows to hide the initialization overhead in Parthenon. | +|| dt_ceil || none || Real || The maximum allowed timestep. | +|| dt_factor || 2.0 || Real || The maximum allowed relative increase of the timestep over the previous value. | +|| dt_floor || none || Real || The minimum allowed timestep. | +|| dt_force || none || Real || Force the timestep to this value, ignoring all other conditions. | +|| dt_init || none || Real || The maximum allowed timestep during the first cycle. | +|| dt_init_force || none || bool || If set to true, force the first cycle's timestep to the value given by dt_init. | +|| dt_min || none || Real || If the timestep falls below dt_min for dt_min_cycle_limit cycles, Parthenon fatals. | +|| dt_min_cycle_limit || 10 || int || The maximum number of cycles the timestep can be below dt_min. | +|| dt_max || none || Real || If the timestep falls below dt_max for dt_max_cycle_limit cycles, Parthenon fatals. | +|| dt_max_cycle_limit || 1 || int || The maximum number of cycles the timestep an be above dt_max. | +|| dt_user || none || Real || Set a global timestep limit. | +|| ncrecv_bdry_buf_timeout_sec || -1.0 || Real || Timeout in seconds for the `ReceiveBoundaryBuffers` tasks. Disabed (negative) by default. Typically no need in production runs. Useful for debugging MPI calls. | || ncycle_out || 1 || int || Number of cycles between short diagnostic output to standard out containing, e.g., current time, dt, zone-update/wsec. Default: 1 (i.e, every cycle). | || ncycle_out_mesh || 0 || int || Number of cycles between printing the mesh structure to standard out. Use a negative number to also print every time the mesh was modified. Default: 0 (i.e, off). | -|| ncrecv_bdry_buf_timeout_sec || -1.0 || Real || Timeout in seconds for the `ReceiveBoundaryBuffers` tasks. Disabed (negative) by default. Typically no need in production runs. Useful for debugging MPI calls. | +|| nlim || -1 || int || Stop criterion on total number of steps taken. Ignored if < 0. | +|| perf_cycle_offset || 0 || int || Skip the first N cycles when calculating the final performance (e.g., zone-cycles/wall_second). Allows to hide the initialization overhead in Parthenon. | +|| tlim || none || Real || Stop criterion on simulation time. | +------------------------------+---------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -64,9 +75,9 @@ See the :ref:`sparse impl` documentation for details. +--------------------+---------+--------+----------------------------------------------------------------------------------------------------------------------------------------------+ | Option | Default | Type | Description | +====================+=========+========+==============================================================================================================================================+ -|| enable_sparse || `true` || bool || If set to false, sparse variables will always be allocated, see also :ref:`sparse run-time` | || alloc_threshold || 1e-12 || float || Global (for all sparse variables) threshold to trigger allocation of a variable if cells in the receiving ghost cells are above this value. | -|| dealloc_threshold || 1e-14 || float || Global (for all sparse variables) threshold to trigger deallocation if all active cells of a variable in a block are below this value. | || dealloc_count || 5 || int || First deallocate a sparse variable if the `dealloc_threshold` has been met in this number of consecutive cycles. | +|| dealloc_threshold || 1e-14 || float || Global (for all sparse variables) threshold to trigger deallocation if all active cells of a variable in a block are below this value. | +|| enable_sparse || `true` || bool || If set to false, sparse variables will always be allocated, see also :ref:`sparse run-time` | +--------------------+---------+--------+----------------------------------------------------------------------------------------------------------------------------------------------+