Loading docs/source/Inputs.rst +52 −20 Original line number Diff line number Diff line Loading @@ -16,13 +16,7 @@ The following inputs must be preceded by "amr." +------------------+-----------------------------------------------------------------------+-------------+-----------+ | 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 | | 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 | +------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading @@ -32,6 +26,26 @@ The following inputs must be preceded by "amr." +------------------+-----------------------------------------------------------------------+-------------+-----------+ | 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 | Loading Loading @@ -78,7 +92,6 @@ The following inputs must be preceded by "amr." +------------------+-----------------------------------------------------------------------+-------------+-----------+ The following inputs must be preceded by "geometry." +-----------------+-----------------------------------------------------------------------+-------------+-----------+ Loading @@ -95,27 +108,46 @@ The following inputs must be preceded by "geometry." 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 | | +--------------------+-----------------------------------------------------------------------+-------------+-----------+ | explicit_diffusion | Should we use explicit or implicit diffusion? | Int | 0 | +--------------------+-----------------------------------------------------------------------+-------------+-----------+ +----------------------+-----------------------------------------------------------------------+-------------+--------------+ 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." Loading Loading
docs/source/Inputs.rst +52 −20 Original line number Diff line number Diff line Loading @@ -16,13 +16,7 @@ The following inputs must be preceded by "amr." +------------------+-----------------------------------------------------------------------+-------------+-----------+ | 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 | | 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 | +------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading @@ -32,6 +26,26 @@ The following inputs must be preceded by "amr." +------------------+-----------------------------------------------------------------------+-------------+-----------+ | 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 | Loading Loading @@ -78,7 +92,6 @@ The following inputs must be preceded by "amr." +------------------+-----------------------------------------------------------------------+-------------+-----------+ The following inputs must be preceded by "geometry." +-----------------+-----------------------------------------------------------------------+-------------+-----------+ Loading @@ -95,27 +108,46 @@ The following inputs must be preceded by "geometry." 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 | | +--------------------+-----------------------------------------------------------------------+-------------+-----------+ | explicit_diffusion | Should we use explicit or implicit diffusion? | Int | 0 | +--------------------+-----------------------------------------------------------------------+-------------+-----------+ +----------------------+-----------------------------------------------------------------------+-------------+--------------+ 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." Loading
