Commit fcb01cad authored by Ann Almgren's avatar Ann Almgren
Browse files

Add inputs file

parent 8f606af2
Loading
Loading
Loading
Loading
+1 −0
Original line number Diff line number Diff line
@@ -11,4 +11,5 @@ Getting Started
   BuildingGMake
   RunningTestSuite
   RegressionTesting
   Inputs

docs/source/Inputs.rst

0 → 100644
+56 −0
Original line number Diff line number Diff line
.. _Chap:Inputs:

Run-time Inputs
==================

The following inputs must be preceded by "amr."
+-----------------+-----------------------------------------------------------------------+-------------+
| File            | Description                                                           |   Default   |
+=================+=======================================================================+=============+
| max_step        | Maximum number of time steps to take                                  |    None     |
+-----------------+-----------------------------------------------------------------------+-------------+
| stop_time       | Maximum time to reach                                                 |    None     |
+-----------------+-----------------------------------------------------------------------+-------------+
| max_level       | Maximum level of refinement allowed (0 when single-level)             |    None     |
+-----------------+-----------------------------------------------------------------------+-------------+
| n_cell          | Number of cells at level 0 in each coordinate direction               |    None     |
+-----------------+-----------------------------------------------------------------------+-------------+
| plot_int        | Frequency of plotfile output                                          |    None     |
+-----------------+-----------------------------------------------------------------------+-------------+
| plot_file       | Prefix to use for plotfile output                                     |    plt      |
+-----------------+-----------------------------------------------------------------------+-------------+
| check_int       | Frequency of checkpoint output                                        |    None     |
+-----------------+-----------------------------------------------------------------------+-------------+
| chk_file        | Prefix to use for checkpoint output                                   |    chk      |
+-----------------+-----------------------------------------------------------------------+-------------+
| restart         | Name of file from which to restart the run                            |   None      |
+-----------------+-----------------------------------------------------------------------+-------------+
| max_grid_size_x | Maximum number of cells at level 0 in each grid in x-direction        |    32       | 
+-----------------+-----------------------------------------------------------------------+-------------+
| max_grid_size_y | Maximum number of cells at level 0 in each grid in y-direction        |    32       |
+-----------------+-----------------------------------------------------------------------+-------------+
| max_grid_size_z | Maximum number of cells at level 0 in each grid in z-direction        |    32       |
+-----------------+-----------------------------------------------------------------------+-------------+


The following inputs must be preceded by "geometry."

+-----------------+-----------------------------------------------------------------------+-------------+
| File            | Description                                                           |   Default   |
+=================+=========================================================================+=============+
| coord_sys       | 0 for Cartesian                                                       |     0     |
+-----------------+-----------------------------------------------------------------------+-------------+
| is_periodic     | 1 for true, 0 for false (one value for each coordinate direction)     |     0     |
+-----------------+-----------------------------------------------------------------------+-------------+


The following inputs must be preceded by "mfix."
+-----------------+-----------------------------------------------------------------------+-------------+
| File            | Description                                                           |   Default   |
+=================+=======================================================================+=============+
| fixed_dt        | Should we use a fixed timestep?                                       |    None     |
+-----------------+-----------------------------------------------------------------------+-------------+
| dt_max          | Maximum value of dt if calculating with cfl                           |    None     |
+-----------------+-----------------------------------------------------------------------+-------------+
| cfl             | CFL constraint (dt < cfl * dx / u) if fixed_dt not 1                  |    None     |
+-----------------+-----------------------------------------------------------------------+-------------+
+1 −0
Original line number Diff line number Diff line
@@ -22,6 +22,7 @@ the master branch at the beginning of each month.

   Introduction
   GettingStarted
   Inputs
   Fluids
   Particles