Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
apcraig committed May 16, 2024
1 parent 0cc5d02 commit 7a89af6
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions doc/source/user_guide/ug_implementation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -215,18 +215,18 @@ 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``,
and decomposition information ``distribution_type``, ``processor_shape``,
and ``distribution_wgt`` in **ice_in**. If ``max_blocks=-1``, the model
will calculate the number of blocks needed for each task. ``max_blocks``
can also be set by the user, although this may use extra memory and the
model will abort if ``max_blocks`` is set too small for the decomposition.
and ``distribution_wgt`` in **ice_in**.
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
distributed across the processors. The model is parallelized over blocks
for both MPI and OpenMP. Some suggested combinations for these
parameters for best performance are given in Section :ref:`performance`.
The script **cice.setup** computes some default decompositions and layouts
but the user can overwrite the defaults by manually changing the values in
`ice_in`. At runtime, the model will print decomposition
but the user can override the defaults by manually changing the values in
`ice_in`. The number of blocks per processor can vary, and this is computed
internally when the namelist ``max_blocks=-1``. ``max_blocks``
can also be set by the user, although this may use extra memory and the
model will abort if ``max_blocks`` is set too small for the decomposition.
At runtime, the model will print decomposition
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.
Expand Down

0 comments on commit 7a89af6

Please sign in to comment.