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

Separate the inputs into separate sections

parent f803d6d8

docs/source/InputsCheckpoint.rstw

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



Run-time Inputs

===============



The following inputs must be preceded by "amr" and control checkpoint/restart.



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

|                  | Description                                                           |   Type      | Default   |

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

| restart          | If present, then the name of file to restart from                     |    String   | None      |

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

| check_int        | Frequency of checkpoint output                                        |    Int      | None      |

|                  | If -1 then no checkpoints will be written                             |             |           |

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

| chk_file         | Prefix to use for checkpoint output                                   |  String     | chk       |

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

docs/source/InputsInitialization.rst

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



Initialization

==============



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



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

|                    | Description                                                               |   Type      | Default   |

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

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

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

docs/source/InputsLoadBalancing.rst

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



Load Balancing

==============



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

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

docs/source/InputsPlotFiles.rst

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



Plotfiles

=========



The following inputs must be preceded by "amr" and control frequency and naming of plotfile generation as well

as which variables will be written out.



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

|                  | Description                                                           |   Type      | Default   |

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

| plot_int         | Frequency of plotfile output                                          |    Int      | None      |

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

| plot_file        | Prefix to use for plotfile output                                     |  String     | plt       |

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

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

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

docs/source/InputsProblemDefinition.rst

0 → 100644
+78 −0
Original line number Diff line number Diff line 
Problem Definition

==================



The following inputs must be preceded by "amr."



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

|                   | Description                                                           |   Type      | Default   |

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

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

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

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

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

| blocking_factor_x | Each grid must be divisible by blocking_factor_x in x-direction       |    Int      |  8        |

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

| blocking_factor_y | Each grid must be divisible by blocking_factor_y in y-direction       |    Int      |  8        |

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

| blocking_factor_: | Each grid must be divisible by blocking_factor_z in z-direction       |    Int      |  8        |

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



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      |

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

| geometry             | Which type of EB geometry are we using?                               |   String    |              |

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



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