Commit 4bdcbd14 authored by Charles G Waldman's avatar Charles G Waldman
Browse files

fixed_dt is Real not Int (exa/docs!156)

parent cc791813
Loading
Loading
Loading
Loading
+1 −4
Original line number Diff line number Diff line
@@ -60,7 +60,7 @@ flows), only buoyancy (pressure gradient) and steady drag are considered:
where :math:`\boldsymbol{V}_{ig} = \boldsymbol{V}_i - \boldsymbol{U}_g ( \boldsymbol{X}_i )`
is the velocity of ith particle relative to the fluid-phase (at the particle position
:math:`\boldsymbol{X}_i`). :math:`F_{gi}` is closed by the specification of a drag
coefficient, :math:`C_D`. Currently, MFIX-Exa includes Wen-Yu, Gidaspow and BVK2 drag laws.
coefficient, :math:`C_D`. Currently, MFIX-Exa includes Wen-Yu, Gidaspow, BVK2, and Syamlal-O'Brien drag laws.

.. wdf todo
   gidaspow form: C_D^{Gidaspow} = \chi C_D^{(Wen-Yu)} + \left(1 - \chi \right)  C_D^{(Ergun)}
@@ -78,6 +78,3 @@ the fluid momentum takes the more convenient form:
.. math:: \frac{ \partial (\varepsilon_g \rho_g U_g)}{\partial t}
   + \nabla \cdot (\varepsilon_g \rho_g U_g U_g) + \varepsilon_g \nabla p_g
   = \nabla \cdot \tau + \sum_p \beta_p (V_p - U_g) + \varepsilon_g \rho_g g


+1 −1
Original line number Diff line number Diff line
@@ -318,7 +318,7 @@ The following input is defined using the prefix ``mfix.drag``:
|                          | * ``WenYu`` :cite:p:`Wen66`                                                   |             |           |
|                          | * ``Gidaspow`` :cite:p:`ding90,Lat00`                                         |             |           |
|                          | * ``BVK2`` :cite:p:`Bee07,Bee071,tenneti11,tang15`                            |             |           |
|                          | * ``SyamOBrien`` :cite:p:`syam88`                                             |             |           |
|                          | * ``SyamOBrien`` -- Syamlal-O'Brien :cite:p:`syam88`                          |             |           |
|                          | * ``UserDrag``                                                                |             |           |
|                          |                                                                               |             |           |
+--------------------------+-------------------------------------------------------------------------------+-------------+-----------+
+1 −1
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@
Porous media definitions
========================

Homogeneous porous media are modeled by the addition of a momentum
Homogeneous porous media are modeled by the introduction of a momentum
source term, :math:`\boldsymbol{S}_{pm}`, to the fluid momentum equation.

.. math::
+8 −8
Original line number Diff line number Diff line
@@ -95,11 +95,11 @@ The following inputs are defined using the prefix ``mfix``:
+----------------------+-----------------------------------------------------------------------+-------------+--------------+
| Key                  | Description                                                           |   Type      | Default      |
+======================+=======================================================================+=============+==============+
| max_step             | Maximum number of time steps to take                                  |    Int      |  -1          |
| max_step             | Maximum number of time steps to take.                                 |    Int      |  -1          |
+----------------------+-----------------------------------------------------------------------+-------------+--------------+
| stop_time            | Maximum time to reach (s)                                             |    Real     | -1.0         |
| stop_time            | Maximum time to reach (s).                                            |    Real     | -1.0         |
+----------------------+-----------------------------------------------------------------------+-------------+--------------+
| fixed_dt             | Use a fixed time step                                                 |    Int      |   0          |
| fixed_dt             | If > 0, use a fixed time step.                                        |    Real     |   0          |
+----------------------+-----------------------------------------------------------------------+-------------+--------------+
| cfl                  | CFL constraint (dt < cfl * dx / u)                                    |    Real     |  See note    |
|                      |                                                                       |             |              |
@@ -107,16 +107,16 @@ The following inputs are defined using the prefix ``mfix``:
|                      | * Defaults to 0.9 if ``mfix.advection_type = Godunov``                |             |              |
|                      | * ignored if ``mfix.fixed_dt = 1``                                    |             |              |
+----------------------+-----------------------------------------------------------------------+-------------+--------------+
| dt_min               | Abort if ``dt`` gets smaller than this value                          |    Real     |  1.e-6       |
| dt_min               | Abort if ``dt`` gets smaller than this value.                         |    Real     |  1.e-6       |
+----------------------+-----------------------------------------------------------------------+-------------+--------------+
| dt_max               | Maximum value of ``dt`` if ``fixed_dt`` is not set                    |    Real     |  1.e14       |
| dt_max               | Maximum value of ``dt`` if ``fixed_dt`` is not set.                   |    Real     |  1.e14       |
+----------------------+-----------------------------------------------------------------------+-------------+--------------+
| tcoll_ratio          | DEM time step equals the min collision time divided by this value     |    Real     |   50.0       |
| tcoll_ratio          | DEM time step equals the min collision time divided by this value.    |    Real     |   50.0       |
+----------------------+-----------------------------------------------------------------------+-------------+--------------+
| walltime_limit       | Runtime limit specified with format HH:MM:SS. When the runtime has    |    String   |   ""         |
|                      | almost reached the limit (approaching is computed by considering the  |             |              |
|                      | average runtime needed for each step), then the simulation ends and   |             |              |
|                      | a clean exit is performed                                             |             |              |
|                      | a clean exit is performed.                                            |             |              |
+----------------------+-----------------------------------------------------------------------+-------------+--------------+
| clean_exit           | The name of a file that, if found in the run                          |    String   |   ""         |
|                      | folder, makes the solver stop and perform a clean exit.               |             |              |
@@ -136,5 +136,5 @@ The following inputs are defined using the prefix ``mfix`` and are only relevant
| steady_state_tol      | Tolerance for checking if steady state has been reached.              |   Real      | None       |
|                       | (Must be set if steady_state is enabled)                              |             |            |
+-----------------------+-----------------------------------------------------------------------+-------------+------------+
| steady_state_maxiter  | Maximum number of allowed iterations to converge to steady state      |   Int       | 100000000  |
| steady_state_maxiter  | Maximum number of allowed iterations to converge to steady state.     |   Int       | 100000000  |
+-----------------------+-----------------------------------------------------------------------+-------------+------------+