This file has been replaced by smaller files

.. _Chap:Inputs:

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      |

+------------------+-----------------------------------------------------------------------+-------------+-----------+

| dual_grid        | If true then use the "dual_grid" approach for load balancing          |   Bool      | False     |

+------------------+-----------------------------------------------------------------------+-------------+-----------+

| 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 "amr" and control frequency and naming of plotfile and checkpoint generation

+------------------+-----------------------------------------------------------------------+-------------+-----------+

|                  | Description                                                           |   Type      | Default   |

+==================+=======================================================================+=============+===========+

| 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       |

+------------------+-----------------------------------------------------------------------+-------------+-----------+

The following inputs must be preceded by "amr" and determine which variables are written in a plotfile.

+------------------+-----------------------------------------------------------------------+-------------+-----------+

|                  | Description                                                           |   Type      | Default   |

+==================+=======================================================================+=============+===========+

| plt_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."

+-----------------+-----------------------------------------------------------------------+-------------+-----------+

|                 | 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."

+----------------------+-----------------------------------------------------------------------+-------------+--------------+

|                      | Description                                                           |   Type      | Default      |

+======================+=======================================================================+=============+==============+

| fixed_dt             | Should we use a fixed timestep?                                       |    Int      |   0          |

+----------------------+-----------------------------------------------------------------------+-------------+--------------+

| dt_min               | Abort if dt gets smaller than this value                              |    Real     |  1.e-6       |

+----------------------+-----------------------------------------------------------------------+-------------+--------------+

| 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    |              |

+----------------------+-----------------------------------------------------------------------+-------------+--------------+

The following inputs must be preceded by "mfix" and determine how we initialize a calculation:

+----------------------+-----------------------------------------------------------------------+-------------+--------------+

|                      | Description                                                           |   Type      | Default      |

+======================+=======================================================================+=============+==============+

+----------------------+-----------------------------------------------------------------------+-------------+--------------+

| particle_init_type   | How do we initialize the particles?   "Auto" vs AsciiFile             |   String    | AsciiFile    |

+----------------------+-----------------------------------------------------------------------+-------------+--------------+

| do_initial_proj      | Should we do the initial projection?                                  |    Bool     |  True        |

+----------------------+-----------------------------------------------------------------------+-------------+--------------+

| initial_iterations   | How many pressure iterations before starting the first timestep       |  Int        | 3            |

+----------------------+-----------------------------------------------------------------------+-------------+--------------+

The following inputs must be preceded by "mfix" and determine how we create grids and do load balancing:

+----------------------+-----------------------------------------------------------------------+-------------+--------------+

|                      | Description                                                           |   Type      | Default      |

+======================+=======================================================================+=============+==============+

| load_balance_fluid   | Only relevant if (dual_grid); if so do we also regrid mesh data       |  Int        | 1            |

+----------------------+-----------------------------------------------------------------------+-------------+--------------+

| load_balance_type    | What strategy to use for load balancing                               |  String     | FixedSize    |

|                      | Options are "FixedSize", "KDTree" or "Knapsack"                       |             |              |

+----------------------+-----------------------------------------------------------------------+-------------+--------------+

| knapsack_weight_type | What weighting function to use if using Knapsack load balancing       |  String     | RunTimeCosts |

|                      | Options are "RunTimeCosts" or "NumParticles""                         |             |              |

+----------------------+-----------------------------------------------------------------------+-------------+--------------+

The following inputs must be preceded by "particles."

+--------------------+---------------------------------------------------------------------------+-------------+-----------+

|                    | Description                                                               |   Type      | Default   |

+====================+===========================================================================+=============+===========+

| removeOutOfRange   |   Should we remove particles at initialization that are touching the wall |    Int      |   1       |

+--------------------+---------------------------------------------------------------------------+-------------+-----------+

Setting basic EB walls can be specified by inputs preceded by "xlo", "xhi", "ylo", "yhi", "zlo", and "zhi"

+--------------------+---------------------------------------------------------------------------+-------------+-----------+

|                    | Description                                                               |   Type      | Default   |

+====================+===========================================================================+=============+===========+

| type               | Used to define boundary type. Available options include:                  |  String     |  None     |

|                    |                                                                           |             |           |

|                    | * 'pi'  or 'pressure_inflow'                                              |             |           |

|                    | * 'po'  or 'pressure_outflow'                                             |             |           |

|                    | * 'mi'  or 'mass_inflow'                                                  |             |           |

|                    | * 'nsw' or 'no_slip_wall'                                                 |             |           |

+--------------------+---------------------------------------------------------------------------+-------------+-----------+

| pressure           | Sets boundary pressure for pressure inflows, outflows and mass inflows    |    Real     |  None     |

+--------------------+---------------------------------------------------------------------------+-------------+-----------+

| velocity           | Sets boundary velocity for mass inflows                                   |    Real     |  None     |

+--------------------+---------------------------------------------------------------------------+-------------+-----------+

| location           | Specifies an offset from the domain boundary for no-slip walls            |    Real     |  None     |

+--------------------+---------------------------------------------------------------------------+-------------+-----------+

To specify multiple mass inflows (e.g., define a jet and uniform background flow), provide multiple velocities for the region and define the physical extents of the sub-region. The first velocity is applied to the entire flow plane. Subsequent velocities are successively applied to the specified sub-regions. If multiple sub-regions overlap, the velocity of last specified region is used. An example of a uniform mass inflow with a square-jet centered at (0.5x0.5) is given below.

.. code-block:: none

   xlo.type = "mi"

   xlo.velocity = 0.01  0.10

   xlo.ylo =            0.25

   xlo.yhi =            0.75

   xlo.zlo =            0.25

   xlo.zhi =            0.75