Skip to content

Commit 68aca7a

Browse files
committed
Fix default for agg_grid_size
1 parent 5a3a824 commit 68aca7a

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

Docs/sphinx_documentation/source/LinearSolvers.rst

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ biconjugate gradient stabilized method, but can easily be changed with the :cpp:
359359

360360
void setBottomSolver (BottomSolver s);
361361

362-
Available choices are
362+
Available choices the bottom solver are
363363

364364
- :cpp:`MLMG::BottomSolver::bicgstab`: The default.
365365

@@ -379,15 +379,23 @@ Available choices are
379379

380380
- :cpp:`MLMG::BottomSolver::petsc`: Currently for cell-centered only.
381381

382+
The :cpp:`LPInfo` class can be used control the agglomeration and
383+
consolidation strategy for multigrid coarsening.
384+
382385
- :cpp:`LPInfo::setAgglomeration(bool)` (by default true) can be used
383386
to copy the current level of multigrid data to fewer, larger
384387
boxes. Two advantages of using this option is that the bottom solver will become
385388
smaller, and communication overhead is reduced.
386389

387-
- :cpp:`LPInfo::setAgglomerationGridSize(int)` (by default 8 in 1D, 16 in 2D, 32 in 3D)
388-
if agglomeration is used, when the average box size becomes smaller than agg_grid_size^{DIM},
389-
boxes will agglomerate until this is no longer the case. Note that this action is
390-
recursive and can happen at several different levels in the multigrid hierarchy.
390+
- :cpp:`LPInfo::setAgglomerationGridSize(int)` controls the grid-length
391+
threshold used for agglomeration. By default, the threshold length is set
392+
to 32 for GPU builds, and 8, 16 and 32 for CPU builds in 1D, 2D and 3D,
393+
respectively. The corresponding volume threshold is :math:`L^D`, where
394+
:math:`L` is the length threshold and :math:`D` is
395+
:cpp:`AMREX_SPACEDIM`. When the average box volume falls below this volume
396+
threshold, boxes are agglomerated until this is no longer the case. Note
397+
that this action is recursive and can happen at several different levels
398+
in the multigrid hierarchy.
391399

392400
- :cpp:`LPInfo::setConsolidation(bool)` (by default true) can be used
393401
continue to transfer a multigrid problem to fewer MPI ranks.

0 commit comments

Comments
 (0)