From 3004250606a51b1ada7de321653f89142896953b Mon Sep 17 00:00:00 2001 From: William Fullmer <william.fullmer@netl.doe.gov> Date: Tue, 30 Jul 2019 12:44:03 -0400 Subject: [PATCH] move max_step to mfix prefix too --- docs/source/InputsTimeStepping.rst | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/docs/source/InputsTimeStepping.rst b/docs/source/InputsTimeStepping.rst index 5d2be8e..74b7d1d 100644 --- a/docs/source/InputsTimeStepping.rst +++ b/docs/source/InputsTimeStepping.rst @@ -3,25 +3,19 @@ Time Stepping ============= -The following inputs must be preceded by "amr." Note that if both are specified, both criteria +The following inputs must be preceded by "mfix." Note that if both are specified, both criteria are used and the simulation still stop when the first criterion is hit. In the case of unsteady flow, the simulation will stop when either the number of steps reaches max_step or time reaches stop_time. In the case of unsteady flow, the simulation will stop when either the tolerance (difference between subsequent steps) is reached or the number of iterations reaches the maximum number specified. -+------------------+-----------------------------------------------------------------------+-------------+-----------+ -| | Description | Type | Default | -+==================+=======================================================================+=============+===========+ -| max_step | Maximum number of time steps to take | Int | -1 | -+------------------+-----------------------------------------------------------------------+-------------+-----------+ -| stop_time | Maximum time to reach | Real | -1.0 | -+------------------+-----------------------------------------------------------------------+-------------+-----------+ - -The following inputs must be preceded by "mfix." - +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | | Description | Type | Default | +======================+=======================================================================+=============+==============+ +| max_step | Maximum number of time steps to take | Int | -1 | ++----------------------+-----------------------------------------------------------------------+-------------+--------------+ +| stop_time | Maximum time to reach | Real | -1.0 | ++----------------------+-----------------------------------------------------------------------+-------------+--------------+ | fixed_dt | Should we use a fixed timestep? | Int | 0 | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | cfl | CFL constraint (dt < cfl * dx / u) if fixed_dt not 1 | Real | 0.5 | -- GitLab