Commit 5e98f8e1 authored by Charles G Waldman's avatar Charles G Waldman
Browse files

update docs for doc_scanner

parent db6fbb9e
Loading
Loading
Loading
Loading
+6 −6
Original line number Diff line number Diff line
@@ -10,18 +10,18 @@ They must be defined with the prefix ``mfix``:
+----------------------+-----------------------------------------------------------------------+-------------+--------------+
|                      | Description                                                           |   Type      | Default      |
+======================+=======================================================================+=============+==============+
| do_initial_proj      | Perform an initial projection                                         |  Bool       |  true        |
| do_initial_proj      | Perform an initial projection.                                        |  Bool       |  true        |
+----------------------+-----------------------------------------------------------------------+-------------+--------------+
| initial_iterations   | Number of pressure iterations to execute before time-marching         |  Int        |    3         |
| 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                                                |             |              |
+----------------------+-----------------------------------------------------------------------+-------------+--------------+
| restart              | If set, then restart from this file rather than from scratch          |  String     |   None       |
| restart              | If set, then restart from this file rather than from scratch.         |  String     |   None       |
+----------------------+-----------------------------------------------------------------------+-------------+--------------+
| repl_x               | Replicate initial data by this factor in the x-direction              |   Int       |    1         |
| repl_x               | Replicate initial data by this factor in the x-direction.             |   Int       |    1         |
+----------------------+-----------------------------------------------------------------------+-------------+--------------+
| repl_y               | Replicate initial data by this factor in the y-direction              |   Int       |    1         |
| repl_y               | Replicate initial data by this factor in the y-direction.             |   Int       |    1         |
+----------------------+-----------------------------------------------------------------------+-------------+--------------+
| repl_z               | Replicate initial data by this factor in the z-direction              |   Int       |    1         |
| repl_z               | Replicate initial data by this factor in the z-direction.             |   Int       |    1         |
+----------------------+-----------------------------------------------------------------------+-------------+--------------+