From a37cff26a1a1721b17592df5454397b887233519 Mon Sep 17 00:00:00 2001 From: Charles G Waldman Date: Mon, 27 Apr 2026 13:26:19 -0500 Subject: [PATCH 1/2] fix table header --- .../user_guide/inputs/gridding.rst | 29 ++++++++++--------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/gridding.rst b/docs/source_docs/user_guide/inputs/gridding.rst index 5edb4ed..24e6980 100644 --- a/docs/source_docs/user_guide/inputs/gridding.rst +++ b/docs/source_docs/user_guide/inputs/gridding.rst @@ -6,20 +6,21 @@ Grids, tiles, and tagging Grid layout ----------- - -+----------------------+-----------------------------------------------------------------------+-------------+-----------+ -| 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. | | | -+----------------------+-----------------------------------------------------------------------+-------------+-----------+ ++----------------------+-----------------------------------------------------------------------+----------+-------------+ +| | 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. | | | ++----------------------+-----------------------------------------------------------------------+-------------+----------+ -- GitLab From 7a5d3d230347f7b99b611438de19b22c4e50d1b9 Mon Sep 17 00:00:00 2001 From: Charles G Waldman Date: Mon, 27 Apr 2026 14:30:06 -0500 Subject: [PATCH 2/2] fix table headers --- docs/source_docs/user_guide/inputs/domain.rst | 14 ++++++++ .../user_guide/inputs/gridding.rst | 34 ++++++++----------- 2 files changed, 28 insertions(+), 20 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/domain.rst b/docs/source_docs/user_guide/inputs/domain.rst index fc4da1f..7d0e796 100644 --- a/docs/source_docs/user_guide/inputs/domain.rst +++ b/docs/source_docs/user_guide/inputs/domain.rst @@ -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 `_ contains a significant + amount of information on grid creation and load balancing. Users are strongly encouraged to + read the relevant sections. + + Periodic domains ---------------- diff --git a/docs/source_docs/user_guide/inputs/gridding.rst b/docs/source_docs/user_guide/inputs/gridding.rst index 24e6980..d3b1c83 100644 --- a/docs/source_docs/user_guide/inputs/gridding.rst +++ b/docs/source_docs/user_guide/inputs/gridding.rst @@ -4,11 +4,14 @@ Grids, tiles, and tagging ========================= -Grid layout ------------ -+----------------------+-----------------------------------------------------------------------+----------+-------------+ -| | Description | Type | Default | -+======================+=======================================================================+==========+=============+ +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. | | | @@ -22,15 +25,6 @@ Grid layout | | 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:: The `AMReX documentation `_ contains a significant @@ -54,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`` | | | -+----------------------+-----------------------------------------------------------------------+-------------+--------------+ ++----------------------+-------------------------------------------------------------------+-------------+--------------+ +| | Description | Type | Default | ++======================+===================================================================+=============+==============+ +| 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. -- GitLab