Loading docs/source/InputsLoadBalancing.rst +2 −0 Original line number Diff line number Diff line Loading @@ -54,4 +54,6 @@ The following inputs must be preceded by "mfix" and determine how we load balanc | knapsack_weight_type | What weighting function to use if using Knapsack load balancing | String | RunTimeCosts | | | Options are "RunTimeCosts" or "NumParticles"" | | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | knapsack_nmax | Maximum number of grids per MPI process if using knapsack algorithm | | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ docs/source/InputsPlotFiles.rst +21 −3 Original line number Diff line number Diff line .. _Chap:InputsPlotfiles: Plotfiles ========= Plotfiles and Other Output ========================== 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. as whether the EB geometry or level set should be written out, and if the particles should be written out in Ascii format (for debugging). +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | Loading @@ -16,6 +17,23 @@ as which variables will be written out. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | plot_file | Prefix to use for plotfile output | String | plt | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | write_ls | Should we write a plotfile holding the level set and volfrac? | Bool | False | | | If true, it will only be written once,after initialization or restart | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | write_eb_surface | Should we write out the EB geometry in vtp format | Bool | False | | | If true, it will only be written once,after initialization or restart | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | par_ascii_file | Prefix to use for ascii particle output | String | par | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | par_ascii_int | Frequency of ascii particle output; | Int | -1 | | | if -1 then no plotfiles will be written | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ The following inputs must be preceded by "amr" and control what variables will be written in plotfiles. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | 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 docs/source/InputsProblemDefinition.rst +7 −5 Original line number Diff line number Diff line Loading @@ -6,10 +6,10 @@ 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 Int Int | None | +-------------------+-----------------------------------------------------------------------+-------------+-----------+ | max_level | Maximum level of refinement allowed (0 when single-level) | Int | None | +-------------------+-----------------------------------------------------------------------+-------------+-----------+ The following inputs must be preceded by "geometry." Loading @@ -27,11 +27,13 @@ The following inputs must be preceded by "geometry." The following inputs must be preceded by "mfix." +----------------------+-----------------------------------------------------------------------+-------------+--------------+ +----------------------+-------------------------------------------------------------------------+-------------+--------+ | | Description | Type | Default | +======================+=======================================================================+=============+==============+ +======================+=========================================================================+==========+===========+ | geometry | Which type of EB geometry are we using? | String | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ +----------------------+-------------------------------------------------------------------------+----------+-----------+ | levelset__refinement | Refinement factor of levelset resolution relative to level 0 resolution | Int | 1 ! +----------------------+-------------------------------------------------------------------------+----------+-----------+ Setting basic EB walls can be specified by inputs preceded by "xlo", "xhi", "ylo", "yhi", "zlo", and "zhi" Loading docs/source/InputsTimeStepping.rst +11 −0 Original line number Diff line number Diff line Loading @@ -26,3 +26,14 @@ The following inputs must be preceded by "mfix." +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | cfl | CFL constraint (dt < cfl * dx / u) if fixed_dt not 1 | Real | 0.5 | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ The following inputs must be preceded by "mfix" and are only relevant if running a problem to steady state. Currently, the criterion for setting "steady_state" to true is if "dt" is undefined in mfix.dat +-----------------------+-----------------------------------------------------------------------+-------------+------------+ | | Description | Type | Default | +======================-+=======================================================================+=============+============+ | steady_state_tol | Tolerance for checking if we have reached steady state | Real | 1.e-5 | +-----------------------+-----------------------------------------------------------------------+-------------+------------+ | steady_state_max_iter | Maximum number of allowed iterations to converge to steady state | Int | 100000000 | +-----------------------+-----------------------------------------------------------------------+-------------+------------+ Loading
docs/source/InputsLoadBalancing.rst +2 −0 Original line number Diff line number Diff line Loading @@ -54,4 +54,6 @@ The following inputs must be preceded by "mfix" and determine how we load balanc | knapsack_weight_type | What weighting function to use if using Knapsack load balancing | String | RunTimeCosts | | | Options are "RunTimeCosts" or "NumParticles"" | | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | knapsack_nmax | Maximum number of grids per MPI process if using knapsack algorithm | | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+
docs/source/InputsPlotFiles.rst +21 −3 Original line number Diff line number Diff line .. _Chap:InputsPlotfiles: Plotfiles ========= Plotfiles and Other Output ========================== 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. as whether the EB geometry or level set should be written out, and if the particles should be written out in Ascii format (for debugging). +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | Loading @@ -16,6 +17,23 @@ as which variables will be written out. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | plot_file | Prefix to use for plotfile output | String | plt | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | write_ls | Should we write a plotfile holding the level set and volfrac? | Bool | False | | | If true, it will only be written once,after initialization or restart | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | write_eb_surface | Should we write out the EB geometry in vtp format | Bool | False | | | If true, it will only be written once,after initialization or restart | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | par_ascii_file | Prefix to use for ascii particle output | String | par | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | par_ascii_int | Frequency of ascii particle output; | Int | -1 | | | if -1 then no plotfiles will be written | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ The following inputs must be preceded by "amr" and control what variables will be written in plotfiles. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | 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
docs/source/InputsProblemDefinition.rst +7 −5 Original line number Diff line number Diff line Loading @@ -6,10 +6,10 @@ 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 Int Int | None | +-------------------+-----------------------------------------------------------------------+-------------+-----------+ | max_level | Maximum level of refinement allowed (0 when single-level) | Int | None | +-------------------+-----------------------------------------------------------------------+-------------+-----------+ The following inputs must be preceded by "geometry." Loading @@ -27,11 +27,13 @@ The following inputs must be preceded by "geometry." The following inputs must be preceded by "mfix." +----------------------+-----------------------------------------------------------------------+-------------+--------------+ +----------------------+-------------------------------------------------------------------------+-------------+--------+ | | Description | Type | Default | +======================+=======================================================================+=============+==============+ +======================+=========================================================================+==========+===========+ | geometry | Which type of EB geometry are we using? | String | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ +----------------------+-------------------------------------------------------------------------+----------+-----------+ | levelset__refinement | Refinement factor of levelset resolution relative to level 0 resolution | Int | 1 ! +----------------------+-------------------------------------------------------------------------+----------+-----------+ Setting basic EB walls can be specified by inputs preceded by "xlo", "xhi", "ylo", "yhi", "zlo", and "zhi" Loading
docs/source/InputsTimeStepping.rst +11 −0 Original line number Diff line number Diff line Loading @@ -26,3 +26,14 @@ The following inputs must be preceded by "mfix." +----------------------+-----------------------------------------------------------------------+-------------+--------------+ | cfl | CFL constraint (dt < cfl * dx / u) if fixed_dt not 1 | Real | 0.5 | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ The following inputs must be preceded by "mfix" and are only relevant if running a problem to steady state. Currently, the criterion for setting "steady_state" to true is if "dt" is undefined in mfix.dat +-----------------------+-----------------------------------------------------------------------+-------------+------------+ | | Description | Type | Default | +======================-+=======================================================================+=============+============+ | steady_state_tol | Tolerance for checking if we have reached steady state | Real | 1.e-5 | +-----------------------+-----------------------------------------------------------------------+-------------+------------+ | steady_state_max_iter | Maximum number of allowed iterations to converge to steady state | Int | 100000000 | +-----------------------+-----------------------------------------------------------------------+-------------+------------+
