Skip to content

Commit

Permalink
Minor documentation clarification. (#3847)
Browse files Browse the repository at this point in the history
  • Loading branch information
cgilet committed Mar 26, 2024
1 parent 9e8f8d6 commit b892132
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions Docs/sphinx_documentation/source/Basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1942,7 +1942,8 @@ tiling flag is on. One can change the default size using :cpp:`ParmParse`
| | FArrayBoxes. | |
+-----------------------------------------------------+------------------------------------------------------+

Dynamic tiling, which runs one box per OpenMP thread, is also available.
Dynamic tiling, which runs one box per OpenMP thread, either with or without
tiling the box, is also available.
This is useful when the underlying work cannot benefit from thread
parallelization. Dynamic tiling is implemented using the :cpp:`MFItInfo`
object and requires the :cpp:`MFIter` loop to be defined in an OpenMP
Expand Down Expand Up @@ -1981,9 +1982,13 @@ Dynamic tiling also allows explicit definition of a tile size:
...
}

Usually :cpp:`MFIter` is used for accessing multiple MultiFabs like the second
example, in which two MultiFabs, :cpp:`U` and :cpp:`F`, use :cpp:`MFIter` via
:cpp:`operator[]`. These different MultiFabs may have different BoxArrays. For
Note that :cpp:`EnableTiling()`, with no argument, will use the default tile size.

Usually :cpp:`MFIter` is used for accessing multiple MultiFabs, like
the second example in the previous section on :ref:`sec:basics:mfiter:notiling`
in which two MultiFabs, :cpp:`U` and :cpp:`F`, use :cpp:`MFIter` via
:cpp:`array()` and :cpp:`const_array()` functions. These different MultiFabs
may have different BoxArrays. For
example, :cpp:`U` might be cell-centered, whereas :cpp:`F` might be nodal in
:math:`x`-direction and cell in other directions. The :cpp:`MFIter::validbox`
and :cpp:`tilebox` functions return Boxes of the same type as the
Expand Down

0 comments on commit b892132

Please sign in to comment.