From 262732d3b0f3830bb28a09e12eaea713841ec392 Mon Sep 17 00:00:00 2001 From: Ann Almgren Date: Fri, 10 May 2019 10:44:47 -0700 Subject: [PATCH] Adding more detail about defaults and usage --- docs/source/InputsTimeStepping.rst | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/source/InputsTimeStepping.rst b/docs/source/InputsTimeStepping.rst index 4c92e07..6d82138 100644 --- a/docs/source/InputsTimeStepping.rst +++ b/docs/source/InputsTimeStepping.rst @@ -37,7 +37,11 @@ Currently, the criterion for setting "steady_state" to true is if "dt" is undefi +-----------------------+-----------------------------------------------------------------------+-------------+------------+ | | Description | Type | Default | +=======================+=======================================================================+=============+============+ -| steady_state_tol | Tolerance for checking if we have reached steady state | Real | 1.e-5 | +| steady_state | Are we running a steady-state calculation? | Int | 0 | ++-----------------------+-----------------------------------------------------------------------+-------------+------------+ +| steady_state_tol | Tolerance for checking if we have reached steady state | Real | None | +| | | | | +| | (Must be set if steady_state_tol = 1) | | | +-----------------------+-----------------------------------------------------------------------+-------------+------------+ | steady_state_max_iter | Maximum number of allowed iterations to converge to steady state | Int | 100000000 | +-----------------------+-----------------------------------------------------------------------+-------------+------------+ @@ -50,8 +54,15 @@ There are several ways that the inputs are used to determine what time step is used in the evolution of the fluid-particle system in MFiX-Exa. 1) In a pure particle case, the "mfix.fixed_dt", if specified, is only used to determine the frequency -of outputs, it has no effect on the dt used in the particle evaluation. [WHAT HAPPENS IF FIXED_DT -NOT SPECIFIED?] +of outputs, it has no effect on the dt used in the particle evaluation. If you do not specify a positive +value of "mfix.fixed_dt" then the code will abort. + +.. highlight:: c++ + +:: + + amrex::Abort::0::If running particle-only must specify fixed_dt in the inputs file !!! + That is determined by the following calculation: -- GitLab