From 04818d510ccbe6716069fed3c7e07648cd867dbe Mon Sep 17 00:00:00 2001 From: Deepak Rangarajan Date: Thu, 5 Sep 2024 15:01:59 -0400 Subject: [PATCH] rename init_shrink and move it to initialization --- docs/source_docs/user_guide/inputs/initialization.rst | 3 +++ docs/source_docs/user_guide/inputs/time-stepping.rst | 2 -- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/initialization.rst b/docs/source_docs/user_guide/inputs/initialization.rst index cd8a24a..7f279e9 100644 --- a/docs/source_docs/user_guide/inputs/initialization.rst +++ b/docs/source_docs/user_guide/inputs/initialization.rst @@ -12,6 +12,9 @@ The following inputs must be preceded by ``mfix`` and determine how we initializ +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | initial_iterations | Number of pressure iterations to execute before time-marching | Int | 3 | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ +| scale_init_dt | Factor by which ``dt`` is scaled in the initial iterations and step. | Real | 1.0 | +| | Must be a value <= 1.0 | | | ++----------------------+-----------------------------------------------------------------------+-------------+--------------+ +----------------------+-----------------------------------------------------------------------+-------------+--------------+ diff --git a/docs/source_docs/user_guide/inputs/time-stepping.rst b/docs/source_docs/user_guide/inputs/time-stepping.rst index eb306dc..97dc7ea 100644 --- a/docs/source_docs/user_guide/inputs/time-stepping.rst +++ b/docs/source_docs/user_guide/inputs/time-stepping.rst @@ -121,8 +121,6 @@ The following inputs are defined using the ``mfix`` prefix. | 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 | | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ -| init_shrink | Factor by which ``dt`` is shrunk in the initial iterations and step | Real | 1.0 | -+----------------------+-----------------------------------------------------------------------+-------------+--------------+ In the case of unsteady flow, the simulation will stop when either the number of steps reaches ``max_step`` or time reaches ``stop_time``. -- GitLab