Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
apcraig committed May 14, 2024
1 parent 7402dc7 commit 3f25267
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
1 change: 1 addition & 0 deletions doc/source/user_guide/ug_case_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,7 @@ domain_nml
"``maskhalo_remap``", "logical", "mask unused halo cells for transport", "``.false.``"
"``maskhalo_bound``", "logical", "mask unused halo cells for boundary updates", "``.false.``"
"``max_blocks``", "integer", "maximum number of blocks per MPI task for memory allocation", "-1"
"", "``-1``", "find number of blocks per MPI task automatically", ""
"``nprocs``", "integer", "number of MPI tasks to use", "-1"
"", "``-1``", "find number of MPI tasks automatically", ""
"``ns_boundary_type``", "``cyclic``", "periodic boundary conditions in y-direction", "``open``"
Expand Down
12 changes: 6 additions & 6 deletions doc/source/user_guide/ug_implementation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -213,10 +213,11 @@ ghost cells, and the same numbering system is applied to each of the
four subdomains.

The user sets the ``NTASKS`` and ``NTHRDS`` settings in **cice.settings**
and chooses a block size ``block_size_x`` :math:`\times`\ ``block_size_y``,
``max_blocks``, and decomposition information ``distribution_type``, ``processor_shape``,
and ``distribution_type`` in **ice_in**. That information is used to
determine how the blocks are
and chooses a block size, ``block_size_x`` :math:`\times`\ ``block_size_y``,
and decomposition information ``distribution_type``, ``processor_shape``,
and ``distribution_type`` in **ice_in**. ``max_blocks`` is computed
automatically if set to a value of -1, but it can also be set by the user.
This information is used to determine how the blocks are
distributed across the processors, and how the processors are
distributed across the grid domain. The model is parallelized over blocks
for both MPI and OpenMP. Some suggested combinations for these
Expand All @@ -227,8 +228,7 @@ but the user can overwrite the defaults by manually changing the values in
information to the log file, and if the block size or max blocks is
inconsistent with the task and thread size, the model will abort. The
code will also print a warning if the maximum number of blocks is too large.
Although this is not fatal, it does use extra memory. If ``max_blocks`` is
set to -1, the code will compute a tentative ``max_blocks`` on the fly.
Although this is not fatal, it does use extra memory.

A loop at the end of routine *create_blocks* in module
**ice_blocks.F90** will print the locations for all of the blocks on
Expand Down

0 comments on commit 3f25267

Please sign in to comment.