Commit 1cd38ffb authored by Jordan Musser's avatar Jordan Musser
Browse files

Add new IO keywords

parent 8ef3aaad
Loading
Loading
Loading
Loading
+59 −14
Changes for docs/source/Inputs.rst: 59 added lines, 14 removed lines.
Original line number Diff line number Diff line
@@ -5,33 +5,78 @@ Run-time Inputs

The following inputs must be preceded by "amr."

+-----------------+-----------------------------------------------------------------------+-------------+-----------+
+------------------+-----------------------------------------------------------------------+-------------+-----------+
|                  | Description                                                           |   Type      | Default   |
+=================+=======================================================================+=============+===========+
+==================+=======================================================================+=============+===========+
| max_step         | Maximum number of time steps to take                                  |    Int      | None      |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| stop_time        | Maximum time to reach                                                 |    Real     | None      |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| max_level        | Maximum level of refinement allowed (0 when single-level)             |    Int      | None      |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| n_cell           | Number of cells at level 0 in each coordinate direction               |    Int      | None      |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plot_int         | Frequency of plotfile output                                          |    Int      | None      |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plot_file        | Prefix to use for plotfile output                                     |  String     | plt       |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| check_int        | Frequency of checkpoint output                                        |    Int      | None      |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| chk_file         | Prefix to use for checkpoint output                                   |  String     | chk       |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| restart          | Name of file from which to restart the run                            |  String     | None      |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| max_grid_size_x  | Maximum number of cells at level 0 in each grid in x-direction        |    Int      | 32        |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| max_grid_size_y  | Maximum number of cells at level 0 in each grid in y-direction        |    Int      | 32        |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| max_grid_size_z  | Maximum number of cells at level 0 in each grid in z-direction        |    Int      | 32        |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_ccse_regtest | Save all variables to plot file (overrides all other IO flags)        |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_vel_g        | Save fluid velocity data to plot file                                 |    Int      | 1         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_ep_g         | Save fluid volume fraction to plot file                               |    Int      | 1         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_p_g          | Save fluid pressure to plot file                                      |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_ro_g         | Save fluid density to plot file                                       |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_mu_g         | Save fluid viscosity to plot file                                     |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_diveu        | Save div(ep_g . u) to plot file                                       |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_volfrac      | Save Eulerian grid volume fraction (from cut cells) to plot file      |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_volfrac      | Save Eulerian grid volume fraction (from cut cells) to plot file      |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_gradp_g      | Save gradient of pressure filed to plot file                          |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_vort         | Save vorticity to plot file                                           |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_vel_p        | Save particle velocity to plot file                                   |    Int      | 1         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_radius       | Save particle radius to plot file                                     |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_volume       | Save particle volume to plot file                                     |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_mass         | Save particle mass to plot file                                       |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_ro_p         | Save particle density to plot file                                    |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_omoi         | Save (one divided by the) particle momentum of inertia to plot file   |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_mass         | Save particle mass to plot file                                       |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_omega_p      | Save particle angular velocity to plot file                           |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_drag_p       | Save particle drag force to plot file                                 |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_phase        | Save particle type to plot file                                       |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+
| plt_state        | Save particle state to plot file                                      |    Int      | 0         |
+------------------+-----------------------------------------------------------------------+-------------+-----------+



The following inputs must be preceded by "geometry."