From b892132f6144461fb7cdb339e40b1f7e0a81ccd2 Mon Sep 17 00:00:00 2001 From: Candace Gilet Date: Tue, 26 Mar 2024 14:18:00 -0400 Subject: [PATCH] Minor documentation clarification. (#3847) --- Docs/sphinx_documentation/source/Basics.rst | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/Docs/sphinx_documentation/source/Basics.rst b/Docs/sphinx_documentation/source/Basics.rst index ebddd14f9b5..8c5fe3dbba5 100644 --- a/Docs/sphinx_documentation/source/Basics.rst +++ b/Docs/sphinx_documentation/source/Basics.rst @@ -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 @@ -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