Skip to content
Snippets Groups Projects
Commit adfbb27f authored by Ann Almgren's avatar Ann Almgren
Browse files

Add some more inputs parameters

parent 2dc74f29
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 53 additions and 43 deletions
docs/source/Inputs.rst
+ 53
− 43
View file @ adfbb27f
......@@ -5,54 +5,64 @@ 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 |
+-----------------+-----------------------------------------------------------------------+-------------+
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
| File | 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 |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
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 0 0 |
+-----------------+-----------------------------------------------------------------------+-------------+
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
| File | Description | Type | Default |
+=================+=======================================================================+=============+===========+
| coord_sys | 0 for Cartesian | Int | 0 |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
| is_periodic | 1 for true, 0 for false (one value for each coordinate direction) | Ints | 0 0 0 |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
| prob_lo | Low corner of physical domain (physical not index space) | Reals | None |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
| prob_hi | High corner of physical domain (physical not index space) | Reals | None |
+-----------------+-----------------------------------------------------------------------+-------------+-----------+
The following inputs must be preceded by "mfix."
+-----------------+-----------------------------------------------------------------------+-------------+
| File | Description | Default |
+=================+=======================================================================+=============+
| fixed_dt | Should we use a fixed timestep? | 0 |
+-----------------+-----------------------------------------------------------------------+-------------+
| dt_max | Maximum value of dt if calculating with cfl | 1.e14 |
+-----------------+-----------------------------------------------------------------------+-------------+
| cfl | CFL constraint (dt < cfl * dx / u) if fixed_dt not 1 | 0.5 |
+-----------------+-----------------------------------------------------------------------+-------------+
+--------------------+-----------------------------------------------------------------------+-------------+-----------+
| File | Description | Type | Default |
+====================+=======================================================================+=============+===========+
| fixed_dt | Should we use a fixed timestep? | Int | 0 |
+--------------------+-----------------------------------------------------------------------+-------------+-----------+
| dt_max | Maximum value of dt if calculating with cfl | Real | 1.e14 |
+--------------------+-----------------------------------------------------------------------+-------------+-----------+
| cfl | CFL constraint (dt < cfl * dx / u) if fixed_dt not 1 | Real | 0.5 |
+--------------------+-----------------------------------------------------------------------+-------------+-----------+
| geometry | Which type of geometry are we using? | String | |
+--------------------+-----------------------------------------------------------------------+-------------+-----------+
| explicit_diffusion | Should we use explicit or implicit diffusion? | Int | 1 |
+--------------------+-----------------------------------------------------------------------+-------------+-----------+
| particle_init_type | How do we initialize the particles? "Auto" vs AsciiFile | String | AsciiFile |
+--------------------+-----------------------------------------------------------------------+-------------+-----------+
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment