Skip to content

Commit

Permalink
Docs: MPI_THREAD_MULTIPLE (AMReX-Codes#1355)
Browse files Browse the repository at this point in the history
## Summary

Add GNUmake and CMake docs about control of `MPI_THREAD_MULTIPLE`.

## Additional background

## Checklist

The proposed changes:
- [ ] fix a bug or incorrect behavior in AMReX
- [ ] add new capabilities to AMReX
- [ ] changes answers in the test suite to more than roundoff level
- [ ] are likely to significantly affect the results of downstream AMReX users
- [x] are described in the proposed changes to the AMReX documentation, if appropriate
  • Loading branch information
ax3l authored and dwillcox committed Oct 3, 2020
1 parent dee1030 commit 616a687
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Docs/sphinx_documentation/source/BuildingAMReX.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,8 @@ to FALSE. The meaning of these variables should
be obvious. When ``DEBUG=TRUE``, aggressive compiler optimization flags are
turned off and assertions in source code are turned on. For production runs,
``DEBUG`` should be set to FALSE.
An advanced variable, ``MPI_THREAD_MULTIPLE``, can be set to TRUE to initialize
MPI with support for concurrent MPI calls from multiple threads.

Variables ``USE_CUDA``, ``USE_HIP`` and ``USE_DPCPP`` are used for
targeting Nvidia, AMD and Intel GPUs, respectively. At most one of
Expand Down Expand Up @@ -477,6 +479,8 @@ below.
+------------------------------+-------------------------------------------------+-------------+-----------------+
| ENABLE_MEM_PROFILE | Build with memory-profiling support | NO | YES, NO |
+------------------------------+-------------------------------------------------+-------------+-----------------+
| ENABLE_MPI_THREAD_MULTIPLE | Concurrent MPI calls from multiple threads | NO | YES, NO |
+------------------------------+-------------------------------------------------+-------------+-----------------+
| ENABLE_PROFPARSER | Build with profile parser support | NO | YES, NO |
+------------------------------+-------------------------------------------------+-------------+-----------------+
| ENABLE_FPE | Build with Floating Point Exceptions checks | NO | YES, NO |
Expand Down

0 comments on commit 616a687

Please sign in to comment.