Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: update erroneous cmake options #11936

Merged
merged 1 commit into from
May 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions RELEASE_NOTES
Original file line number Diff line number Diff line change
Expand Up @@ -919,20 +919,20 @@ Tpetra
2. Otherwise, if you're building with OpenMP, Tpetra uses OpenMP by
default.
3. Otherwise, if Kokkos enables the Serial execution space (if
Kokkos_ENABLE_Serial is ON), Tpetra uses Serial by default.
Kokkos_ENABLE_SERIAL is ON), Tpetra uses Serial by default.
4. Otherwise, if Kokkos enables the Threads execution space (if
Kokkos_ENABLE_Pthread is ON), Tpetra uses Threads by default.
Kokkos_ENABLE_THREADS is ON), Tpetra uses Threads by default.

If you wish to enable other Node types, you may set the following
CMake options. You do NOT need to set any of these options explicitly
if the Node type would be enabled by default anyway.

- Tpetra_INST_CUDA (Kokkos_ENABLE_Cuda must be ON, and Trilinos must
- Tpetra_INST_CUDA (Kokkos_ENABLE_CUDA must be ON, and Trilinos must
be built with CUDA; ON by default if building with CUDA)
- Tpetra_INST_OPENMP (Kokkos_ENABLE_OpenMP must be ON, and Trilinos
- Tpetra_INST_OPENMP (Kokkos_ENABLE_OPENMP must be ON, and Trilinos
must be built with OpenMP support)
- Tpetra_INST_PTHREAD (Kokkos_ENABLE_Pthread must be ON)
- Tpetra_INST_SERIAL (Kokkos_ENABLE_Serial must be ON)
- Tpetra_INST_PTHREAD (Kokkos_ENABLE_THREADS must be ON)
- Tpetra_INST_SERIAL (Kokkos_ENABLE_SERIAL must be ON)

While it is legal to enable both the OpenMP and Pthreads back-ends in
the same executable, it is a bad idea. Both back-ends spawn their own
Expand Down Expand Up @@ -1893,7 +1893,7 @@ Tpetra
# Disable KokkosClassic::TPINode
-D KokkosClassic_ENABLE_ThreadPool:BOOL=OFF
# Shut off Kokkos' Pthreads back-end in favor of OpenMP
-D Kokkos_ENABLE_Pthread:BOOL=OFF
-D Kokkos_ENABLE_THREADS:BOOL=OFF

You must also enable the following subpackages explicitly, since they
are not Primary Tested at the moment:
Expand Down
4 changes: 2 additions & 2 deletions packages/tpetra/core/example/BlockCrs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ cmake \
-D Trilinos_ENABLE_Tpetra:BOOL=ON \
-D Kokkos_ENABLE_CXX11_DISPATCH_LAMBDA:BOOL=ON \
-D Kokkos_ENABLE_OPENMP:BOOL=${USE_OPENMP} \
-D Kokkos_ENABLE_Cuda_UVM:BOOL=${USE_CUDA} \
-D Kokkos_ENABLE_Cuda_Lambda:BOOL=${USE_CUDA} \
-D Kokkos_ENABLE_CUDA_UVM:BOOL=${USE_CUDA} \
-D Kokkos_ENABLE_CUDA_LAMBDA:BOOL=${USE_CUDA} \
-D KOKKOS_ARCH=${ARCH_FLAG} \
-D TPL_ENABLE_MPI:BOOL=ON \
-D TPL_ENABLE_BLAS:BOOL=ON \
Expand Down
2 changes: 1 addition & 1 deletion packages/tpetra/core/guide/src/Obtaining/Building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,5 +123,5 @@ The best option for building Tpetra is to enable the execution space type at the

- Enabling CUDA (by using NVCC and ``nvcc_wrapper``) makes CUDA Tpetra's default execution space.
- Enabling OpenMP (``Trilinos_ENABLE_OpenMP:BOOL=ON``), but not enabling CUDA, makes OpenMP Tpetra's default execution space.
- The Pthreads (``Kokkos::Threads``) back-end is a special case; it does not get enabled by default. This avoids surprises, because Trilinos enables its Pthreads TPL by default as long as it can detect it. Users may set the CMake option ``Kokkos_ENABLE_Pthread:BOOL=ON`` to enable use of Pthreads in Tpetra, and to make it default.
- The Pthreads (``Kokkos::Threads``) back-end is a special case; it does not get enabled by default. This avoids surprises, because Trilinos enables its Pthreads TPL by default as long as it can detect it. Users may set the CMake option ``Kokkos_ENABLE_THREADS:BOOL=ON`` to enable use of Pthreads in Tpetra, and to make it default.

8 changes: 4 additions & 4 deletions packages/tpetra/doc/FAQ.txt
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ variables that you would normally set:
#+BEGIN_EXAMPLE
-D TPL_ENABLE_MPI:BOOL=ON
-D TPL_ENABLE_CUDA:BOOL=ON
-D Kokkos_ENABLE_Cuda_UVM:BOOL=ON
-D Kokkos_ENABLE_Cuda_Lambda:BOOL=ON
-D Kokkos_ENABLE_CUDA_UVM:BOOL=ON
-D Kokkos_ENABLE_CUDA_LAMBDA:BOOL=ON
#+END_EXAMPLE

If you already define ~CMAKE_CXX_FLAGS~ yourself, just make sure that
Expand Down Expand Up @@ -198,8 +198,8 @@ do the following:
that the CMake variable ~TPL_ENABLE_Pthread~ is ~ON~. If not,
you may need to tell Trilinos where to find the Pthreads library
and header file.
2. Enable Kokkos' Pthreads support, by setting
~Kokkos_ENABLE_Pthread:BOOL=OFF~.
2. Enable Kokkos' Threads support, by setting
~Kokkos_ENABLE_THREADS:BOOL=OFF~.
3. Enable Tpetra's Pthreads support, by setting
~Tpetra_INST_PTHREAD:BOOL=OFF~.
4. Make Tpetra use Pthreads by default, by setting
Expand Down
4 changes: 2 additions & 2 deletions packages/zoltan2/test/core/temp/XpetraEpetraMatrix.cpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Program to debug segfaults being reported in CDASH when
// -D Kokkos_ENABLE_Pthreadi:BOOL=ON
// -D Tpetra_INST_PTHREAD:BOOL=ON
// -D Kokkos_ENABLE_THREADS:BOOL=ON
// -D Tpetra_INST_PTHREAD:BOOL=ON
// Problem appears to be in creation of Xpetra::EpetraCrsMatrixT

#include <Teuchos_RCP.hpp>
Expand Down