Loading docs/source_docs/user_guide/inputs/domain.rst +14 −0 Changes for docs/source_docs/user_guide/inputs/domain.rst: 14 added lines, 0 removed lines. Original line number Diff line number Diff line Loading @@ -119,6 +119,20 @@ The following inputs are defined using the prefix ``amr``: | | specified per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ 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 ``max_grid_size`` must be divisible by the corresponding ``blocking_factor``. .. note:: The `AMReX documentation <https://amrex-codes.github.io/amrex/docs_html/index.html>`_ contains a significant amount of information on grid creation and load balancing. Users are strongly encouraged to read the relevant sections. Periodic domains ---------------- Loading docs/source_docs/user_guide/inputs/gridding.rst +15 −20 Changes for docs/source_docs/user_guide/inputs/gridding.rst: 15 added lines, 20 removed lines. Original line number Diff line number Diff line Loading @@ -4,31 +4,26 @@ Grids, tiles, and tagging ========================= Grid layout ----------- Grid refinement --------------- +----------------------+-----------------------------------------------------------------------+-------------+-----------+ The following inputs are defined using the prefix ``amr``: +----------------------+-----------------------------------------------------------------------+-------------+----------+ | | Description | Type | Default | +======================+=======================================================================+=============+==========+ | refine_grid_layout_x | If set, AMReX will attempt to chop new grids into smaller chunks along| Bool | true | | | the x axis, ensuring at least one grid per MPI process, provided this | | | | | does not violate the blocking factor constraint. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ +----------------------+-----------------------------------------------------------------------+-------------+----------+ | refine_grid_layout_y | If set, AMReX will attempt to chop new grids into smaller chunks along| Bool | true | | | the y axis, ensuring at least one grid per MPI process, provided this | | | | | does not violate the blocking factor constraint. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ +----------------------+-----------------------------------------------------------------------+-------------+----------+ | refine_grid_layout_z | If set AMReX will attempt to chop new grids into smaller chunks along | Bool | true | | | the z axis, 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 ``max_grid_size`` must be divisible by the corresponding ``blocking_factor``. +----------------------+-----------------------------------------------------------------------+-------------+----------+ .. note:: Loading @@ -53,12 +48,12 @@ The following inputs are defined using the prefix ``fabarray``: The following inputs are defined using the prefix ``particles``: +----------------------+-----------------------------------------------------------------------+-------------+--------------+ +----------------------+-------------------------------------------------------------------+-------------+--------------+ | | Description | Type | Default | +======================+=======================================================================+=============+==============+ | tile_size | Maximum number of cells in each direction for (logical) tiles | Ints<3> | 1024000 8 8 | | | in the ParticleBoxArray if ``load_balance`` is ``DualGrid`` | | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ +======================+===================================================================+=============+==============+ | tile_size | Maximum number of cells in each direction for (logical) tiles in | Ints<3> | 1024000 8 8 | | | the ParticleBoxArray if ``load_balance`` is ``DualGrid`` | | | +----------------------+-------------------------------------------------------------------+-------------+--------------+ When running on shared memory machines using an OpenMP enabled executable, *grids* are subdivided into *tiles* and iterated over to improve data locality by cache blocking. Loading Loading
docs/source_docs/user_guide/inputs/domain.rst +14 −0 Changes for docs/source_docs/user_guide/inputs/domain.rst: 14 added lines, 0 removed lines. Original line number Diff line number Diff line Loading @@ -119,6 +119,20 @@ The following inputs are defined using the prefix ``amr``: | | specified per-level. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ 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 ``max_grid_size`` must be divisible by the corresponding ``blocking_factor``. .. note:: The `AMReX documentation <https://amrex-codes.github.io/amrex/docs_html/index.html>`_ contains a significant amount of information on grid creation and load balancing. Users are strongly encouraged to read the relevant sections. Periodic domains ---------------- Loading
docs/source_docs/user_guide/inputs/gridding.rst +15 −20 Changes for docs/source_docs/user_guide/inputs/gridding.rst: 15 added lines, 20 removed lines. Original line number Diff line number Diff line Loading @@ -4,31 +4,26 @@ Grids, tiles, and tagging ========================= Grid layout ----------- Grid refinement --------------- +----------------------+-----------------------------------------------------------------------+-------------+-----------+ The following inputs are defined using the prefix ``amr``: +----------------------+-----------------------------------------------------------------------+-------------+----------+ | | Description | Type | Default | +======================+=======================================================================+=============+==========+ | refine_grid_layout_x | If set, AMReX will attempt to chop new grids into smaller chunks along| Bool | true | | | the x axis, ensuring at least one grid per MPI process, provided this | | | | | does not violate the blocking factor constraint. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ +----------------------+-----------------------------------------------------------------------+-------------+----------+ | refine_grid_layout_y | If set, AMReX will attempt to chop new grids into smaller chunks along| Bool | true | | | the y axis, ensuring at least one grid per MPI process, provided this | | | | | does not violate the blocking factor constraint. | | | +----------------------+-----------------------------------------------------------------------+-------------+-----------+ +----------------------+-----------------------------------------------------------------------+-------------+----------+ | refine_grid_layout_z | If set AMReX will attempt to chop new grids into smaller chunks along | Bool | true | | | the z axis, 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 ``max_grid_size`` must be divisible by the corresponding ``blocking_factor``. +----------------------+-----------------------------------------------------------------------+-------------+----------+ .. note:: Loading @@ -53,12 +48,12 @@ The following inputs are defined using the prefix ``fabarray``: The following inputs are defined using the prefix ``particles``: +----------------------+-----------------------------------------------------------------------+-------------+--------------+ +----------------------+-------------------------------------------------------------------+-------------+--------------+ | | Description | Type | Default | +======================+=======================================================================+=============+==============+ | tile_size | Maximum number of cells in each direction for (logical) tiles | Ints<3> | 1024000 8 8 | | | in the ParticleBoxArray if ``load_balance`` is ``DualGrid`` | | | +----------------------+-----------------------------------------------------------------------+-------------+--------------+ +======================+===================================================================+=============+==============+ | tile_size | Maximum number of cells in each direction for (logical) tiles in | Ints<3> | 1024000 8 8 | | | the ParticleBoxArray if ``load_balance`` is ``DualGrid`` | | | +----------------------+-------------------------------------------------------------------+-------------+--------------+ When running on shared memory machines using an OpenMP enabled executable, *grids* are subdivided into *tiles* and iterated over to improve data locality by cache blocking. Loading
