Loading docs/source_docs/user_guide/inputs/geometry.rst +2 −2 Original line number Diff line number Diff line Loading @@ -8,7 +8,7 @@ The following inputs are defined using the prefix ``mfix``: +------------------------+-------------------------------------------------------------------------------+----------+---------------------+ | | Description | Type | Default | +========================+===============================================================================+==========+=====================+ | geometry | Simulation geometry type. | String | 'box' | | geometry | Simulation geometry type. | String | | | | Options (case-insensitive): | | | | | | | | | | * ``box`` - predefined :ref:`box geometry<InputsGeometry_box>` | | | Loading @@ -19,7 +19,7 @@ The following inputs are defined using the prefix ``mfix``: | | * ``None`` - no embedded boundary -- all domain faces must be specified | | | | | | | | +------------------------+-------------------------------------------------------------------------------+----------+---------------------+ | levelset__refinement | Refinement factor of levelset resolution relative to level 0 | Int | 1 | | levelset_refinement | Refinement factor of levelset resolution relative to level 0 | Int | 1 | | | resolution | | | +------------------------+-------------------------------------------------------------------------------+----------+---------------------+ Loading docs/source_docs/user_guide/inputs/initial_conditions.rst +1 −1 Original line number Diff line number Diff line Loading @@ -79,7 +79,7 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut +========================+=======================================================================+=============+===========+ | volfrac | Volume fraction | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | temperature | temperature | Real | 0 | | temperature | Temperature | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | species.[species_name] | Mass fraction of `species_name`. Must be a solid species. | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading docs/source_docs/user_guide/inputs/mesh_and_gridding.rst +15 −9 Original line number Diff line number Diff line Loading @@ -110,7 +110,7 @@ Cells intersected by the embedded boundary are always tagged for refinement, reg | | the specified value. | | | | | | | | | | * To tag cells when density is **less than** the specified value, | | | | | set ``mfix.rho.less_than = true``. | | | | | set ``mfix.tag.rho.less_than = true``. | | | | | * Values may be specified per level. If fewer than ``amr.max_level`` | | | | | values are provided, the last value is used for all higher levels. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading @@ -121,7 +121,7 @@ Cells intersected by the embedded boundary are always tagged for refinement, reg | | two adjacent cells is greater than the specified value. | | | | | | | | | | * To tag cells when the difference is less than the specified value, | | | | | set ``mfix.grad_rho.less_than = true``. | | | | | set ``mfix.tag.grad_rho.less_than = true``. | | | | | * Values may be specified per level. If fewer than ``amr.max_level`` | | | | | values are provided, the last value is used for all higher levels. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading @@ -133,7 +133,7 @@ Cells intersected by the embedded boundary are always tagged for refinement, reg | | specified value. | | | | | | | | | | * To tag cells when the difference is less than the specified value, | | | | | set ``mfix.grad_vel.less_than = true``. | | | | | set ``mfix.tag.vel.less_than = true``. | | | | | * Values may be specified per level. If fewer than ``amr.max_level`` | | | | | values are provided, the last value is used for all higher levels. | | | | | | | | Loading @@ -148,7 +148,7 @@ Cells intersected by the embedded boundary are always tagged for refinement, reg | | specified value. | | | | | | | | | | * To tag cells when the difference is less than the specified value, | | | | | set ``mfix.grad_vel.less_than = true``. | | | | | set ``mfix.tag.grad_vel.less_than = true``. | | | | | * Values may be specified per level. If fewer than ``amr.max_level`` | | | | | values are provided, the last value is used for all higher levels. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading @@ -171,19 +171,25 @@ The following inputs are defined using the prefix ``amr``: +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +======================+=======================================================================+=============+===========+ | blocking_factor_x | Each grid in *X* must be divisible by ``blocking_factor_x`` | Int | 8 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_y | Each grid in *Y* must be divisible by ``blocking_factor_y`` | Int | 8 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_z | Each grid in *Z* must be divisible by ``blocking_factor_z`` | Int | 8 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | max_grid_size_x | Maximum number of cells at level 0 in each grid in *X* | Int | 32 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | max_grid_size_y | Maximum number of cells at level 0 in each grid in *Y* | Int | 32 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | max_grid_size_z | Maximum number of cells at level 0 in each grid in *Z* | Int | 32 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_x | Each grid in *X* must be divisible by ``blocking_factor_x`` | Int | 8 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_y | Each grid in *Y* must be divisible by ``blocking_factor_y`` | Int | 8 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_z | Each grid in *Z* must be divisible by ``blocking_factor_z`` | Int | 8 | | refine_grid_layout | If true, AMReX will attempt to chop new grids into smaller chunks | Bool | true | | | ensuring at least one grid per MPI process, provided this does not | | | | | violate the blocking factor constraint. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ Note, the default for ``max_grid_size`` is 64 for GPU runs. The domain is decomposed into *grids* by dividing the number of cells by the max grid size for each direction (e.g., ``n_cells[0]/max_grid_size_x``). The blocking factor ensures that the grids will be sufficiently coarsenable for good multigrid performance; therefore, the Loading docs/source_docs/user_guide/inputs/output/checkpointing.rst +21 −21 Original line number Diff line number Diff line Loading @@ -5,29 +5,29 @@ Checkpointing The following inputs must be preceded by the prefix ``mfix`` 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 in number of timesteps; | Int | -1 | | | if -1 then no checkpoints will be written | | | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ | check_per_approx | Frequency of checkpoint output in simulation time; | Real | 0 | | | if 0 then no checkpoints will be written | | | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ | check_walltime_interval | Frequency of checkpoint output in runtime (HH:MM:SS) | String | None | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ | check_file | Prefix to use for checkpoint output | String | chk | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ +=========================+========================================================================+=============+==================+ | restart | If present, the name of file to restart from. | String | None | +-------------------------+------------------------------------------------------------------------+-------------+------------------+ | check_file | Prefix to use for checkpoint output file name. | String | chk | +-------------------------+------------------------------------------------------------------------+-------------+------------------+ | check_int | Checkpoint output interval in number of timesteps (0 to disable). | Int | 0 | +-------------------------+------------------------------------------------------------------------+-------------+------------------+ | check_per_approx | Approximate checkpoint output interval in simulation time (0 to | Real | 0 | | | disable). | | | +-------------------------+------------------------------------------------------------------------+-------------+------------------+ | check_walltime_interval | Checkpoint output interval in elapsed run time (HH:MM:SS). Only one | String | None | | | of ``check_int``, ``check_per_approx``, or ``check_walltime_interval`` | | | | | may be specified. | | | +-------------------------+------------------------------------------------------------------------+-------------+------------------+ | geom_chk_write | Write the EB geometry data into ``geom_chk_file`` and additionally, | Bool | false | | | ``geom_levelset_chk_file`` if levelset refinement is enabled. | | | | | refinement is enabled. | | | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ +-------------------------+------------------------------------------------------------------------+-------------+------------------+ | geom_chk_file | Name of the EB checkpoint file that is used to store or read | String | geom_chk | | | the unrefined geometry. | | | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ | geom_levelset_chk_file | Name of the EB checkpoint file that is used to store or read | String | geom\_ | | | the refined geometry, i.e. when levelset refinement is enabled. | | levelset\_ | | | | | chk | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ +-------------------------+------------------------------------------------------------------------+-------------+------------------+ | geom_levelset_chk_file | Name of the EB checkpoint file that is used to store or read | String | geom_levelset_chk| | | the refined geometry, i.e. when levelset refinement is enabled. | | | | | | | | +-------------------------+------------------------------------------------------------------------+-------------+------------------+ docs/source_docs/user_guide/inputs/output/monitors.rst +161 −168 File changed.Preview size limit exceeded, changes collapsed. Show changes Loading
docs/source_docs/user_guide/inputs/geometry.rst +2 −2 Original line number Diff line number Diff line Loading @@ -8,7 +8,7 @@ The following inputs are defined using the prefix ``mfix``: +------------------------+-------------------------------------------------------------------------------+----------+---------------------+ | | Description | Type | Default | +========================+===============================================================================+==========+=====================+ | geometry | Simulation geometry type. | String | 'box' | | geometry | Simulation geometry type. | String | | | | Options (case-insensitive): | | | | | | | | | | * ``box`` - predefined :ref:`box geometry<InputsGeometry_box>` | | | Loading @@ -19,7 +19,7 @@ The following inputs are defined using the prefix ``mfix``: | | * ``None`` - no embedded boundary -- all domain faces must be specified | | | | | | | | +------------------------+-------------------------------------------------------------------------------+----------+---------------------+ | levelset__refinement | Refinement factor of levelset resolution relative to level 0 | Int | 1 | | levelset_refinement | Refinement factor of levelset resolution relative to level 0 | Int | 1 | | | resolution | | | +------------------------+-------------------------------------------------------------------------------+----------+---------------------+ Loading
docs/source_docs/user_guide/inputs/initial_conditions.rst +1 −1 Original line number Diff line number Diff line Loading @@ -79,7 +79,7 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut +========================+=======================================================================+=============+===========+ | volfrac | Volume fraction | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | temperature | temperature | Real | 0 | | temperature | Temperature | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | species.[species_name] | Mass fraction of `species_name`. Must be a solid species. | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading
docs/source_docs/user_guide/inputs/mesh_and_gridding.rst +15 −9 Original line number Diff line number Diff line Loading @@ -110,7 +110,7 @@ Cells intersected by the embedded boundary are always tagged for refinement, reg | | the specified value. | | | | | | | | | | * To tag cells when density is **less than** the specified value, | | | | | set ``mfix.rho.less_than = true``. | | | | | set ``mfix.tag.rho.less_than = true``. | | | | | * Values may be specified per level. If fewer than ``amr.max_level`` | | | | | values are provided, the last value is used for all higher levels. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading @@ -121,7 +121,7 @@ Cells intersected by the embedded boundary are always tagged for refinement, reg | | two adjacent cells is greater than the specified value. | | | | | | | | | | * To tag cells when the difference is less than the specified value, | | | | | set ``mfix.grad_rho.less_than = true``. | | | | | set ``mfix.tag.grad_rho.less_than = true``. | | | | | * Values may be specified per level. If fewer than ``amr.max_level`` | | | | | values are provided, the last value is used for all higher levels. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading @@ -133,7 +133,7 @@ Cells intersected by the embedded boundary are always tagged for refinement, reg | | specified value. | | | | | | | | | | * To tag cells when the difference is less than the specified value, | | | | | set ``mfix.grad_vel.less_than = true``. | | | | | set ``mfix.tag.vel.less_than = true``. | | | | | * Values may be specified per level. If fewer than ``amr.max_level`` | | | | | values are provided, the last value is used for all higher levels. | | | | | | | | Loading @@ -148,7 +148,7 @@ Cells intersected by the embedded boundary are always tagged for refinement, reg | | specified value. | | | | | | | | | | * To tag cells when the difference is less than the specified value, | | | | | set ``mfix.grad_vel.less_than = true``. | | | | | set ``mfix.tag.grad_vel.less_than = true``. | | | | | * Values may be specified per level. If fewer than ``amr.max_level`` | | | | | values are provided, the last value is used for all higher levels. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading @@ -171,19 +171,25 @@ The following inputs are defined using the prefix ``amr``: +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +======================+=======================================================================+=============+===========+ | blocking_factor_x | Each grid in *X* must be divisible by ``blocking_factor_x`` | Int | 8 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_y | Each grid in *Y* must be divisible by ``blocking_factor_y`` | Int | 8 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_z | Each grid in *Z* must be divisible by ``blocking_factor_z`` | Int | 8 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | max_grid_size_x | Maximum number of cells at level 0 in each grid in *X* | Int | 32 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | max_grid_size_y | Maximum number of cells at level 0 in each grid in *Y* | Int | 32 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | max_grid_size_z | Maximum number of cells at level 0 in each grid in *Z* | Int | 32 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_x | Each grid in *X* must be divisible by ``blocking_factor_x`` | Int | 8 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_y | Each grid in *Y* must be divisible by ``blocking_factor_y`` | Int | 8 | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ | blocking_factor_z | Each grid in *Z* must be divisible by ``blocking_factor_z`` | Int | 8 | | refine_grid_layout | If true, AMReX will attempt to chop new grids into smaller chunks | Bool | true | | | ensuring at least one grid per MPI process, provided this does not | | | | | violate the blocking factor constraint. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ Note, the default for ``max_grid_size`` is 64 for GPU runs. The domain is decomposed into *grids* by dividing the number of cells by the max grid size for each direction (e.g., ``n_cells[0]/max_grid_size_x``). The blocking factor ensures that the grids will be sufficiently coarsenable for good multigrid performance; therefore, the Loading
docs/source_docs/user_guide/inputs/output/checkpointing.rst +21 −21 Original line number Diff line number Diff line Loading @@ -5,29 +5,29 @@ Checkpointing The following inputs must be preceded by the prefix ``mfix`` 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 in number of timesteps; | Int | -1 | | | if -1 then no checkpoints will be written | | | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ | check_per_approx | Frequency of checkpoint output in simulation time; | Real | 0 | | | if 0 then no checkpoints will be written | | | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ | check_walltime_interval | Frequency of checkpoint output in runtime (HH:MM:SS) | String | None | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ | check_file | Prefix to use for checkpoint output | String | chk | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ +=========================+========================================================================+=============+==================+ | restart | If present, the name of file to restart from. | String | None | +-------------------------+------------------------------------------------------------------------+-------------+------------------+ | check_file | Prefix to use for checkpoint output file name. | String | chk | +-------------------------+------------------------------------------------------------------------+-------------+------------------+ | check_int | Checkpoint output interval in number of timesteps (0 to disable). | Int | 0 | +-------------------------+------------------------------------------------------------------------+-------------+------------------+ | check_per_approx | Approximate checkpoint output interval in simulation time (0 to | Real | 0 | | | disable). | | | +-------------------------+------------------------------------------------------------------------+-------------+------------------+ | check_walltime_interval | Checkpoint output interval in elapsed run time (HH:MM:SS). Only one | String | None | | | of ``check_int``, ``check_per_approx``, or ``check_walltime_interval`` | | | | | may be specified. | | | +-------------------------+------------------------------------------------------------------------+-------------+------------------+ | geom_chk_write | Write the EB geometry data into ``geom_chk_file`` and additionally, | Bool | false | | | ``geom_levelset_chk_file`` if levelset refinement is enabled. | | | | | refinement is enabled. | | | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ +-------------------------+------------------------------------------------------------------------+-------------+------------------+ | geom_chk_file | Name of the EB checkpoint file that is used to store or read | String | geom_chk | | | the unrefined geometry. | | | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ | geom_levelset_chk_file | Name of the EB checkpoint file that is used to store or read | String | geom\_ | | | the refined geometry, i.e. when levelset refinement is enabled. | | levelset\_ | | | | | chk | +-------------------------+-----------------------------------------------------------------------+-------------+------------+ +-------------------------+------------------------------------------------------------------------+-------------+------------------+ | geom_levelset_chk_file | Name of the EB checkpoint file that is used to store or read | String | geom_levelset_chk| | | the refined geometry, i.e. when levelset refinement is enabled. | | | | | | | | +-------------------------+------------------------------------------------------------------------+-------------+------------------+
docs/source_docs/user_guide/inputs/output/monitors.rst +161 −168 File changed.Preview size limit exceeded, changes collapsed. Show changes
