Tpetra: Rename headers in fix for #5279

@trilinos/tpetra
trilinos · May 30, 2019 · 972a933 · 972a933
1 parent 98e2a6e
commit 972a933
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 9 deletions.
diff --git a/...re/src/Tpetra_Details_checkMemoryType.cpp → .../core/src/Tpetra_Details_checkPointer.cpp b/...re/src/Tpetra_Details_checkMemoryType.cpp → .../core/src/Tpetra_Details_checkPointer.cpp
@@ -37,7 +37,7 @@
 // ************************************************************************
 // @HEADER
 
-#include "Tpetra_Details_checkMemoryType.hpp"
+#include "Tpetra_Details_checkPointer.hpp"
 #include "Kokkos_Core.hpp"
 #include "Teuchos_TestForException.hpp"
 #ifdef HAVE_TPETRACORE_CUDA
@@ -67,7 +67,8 @@ EMemoryType getCudaMemoryType (const void* ptr)
     // CUDA 11.0 supports passing in an unregistered host pointer.  In
     // that case, attr.type will be cudaMemoryTypeUnregistered.  CUDA
     // 9.2 doesn't yet have the 'type' field in the
-    // cudaPointerAttributes struct.
+    // cudaPointerAttributes struct, and this function just returns
+    // this error code if given an unregistered host pointer.
     return EMemoryType::HOST;
   }
   else if (err != cudaSuccess) {

diff --git a/...re/src/Tpetra_Details_checkMemoryType.hpp → .../core/src/Tpetra_Details_checkPointer.hpp b/...re/src/Tpetra_Details_checkMemoryType.hpp → .../core/src/Tpetra_Details_checkPointer.hpp
@@ -37,13 +37,15 @@
 // ************************************************************************
 // @HEADER
 
-#ifndef TPETRA_DETAILS_CHECKMEMORYTYPE_HPP
-#define TPETRA_DETAILS_CHECKMEMORYTYPE_HPP
+#ifndef TPETRA_DETAILS_CHECKPOINTER_HPP
+#define TPETRA_DETAILS_CHECKPOINTER_HPP
 
-/// \file Tpetra_Details_checkMemoryType.hpp
+/// \file Tpetra_Details_checkPointer.hpp
 /// \brief Declaration of functions for checking whether a given
-///   Kokkos::View has a pointer that matches the claimed memory
-///   space.
+///   pointer is accessible from a given Kokkos execution space.
+///
+/// \warning This header file and its contents are implementation
+///   details of Tpetra.
 
 #include "TpetraCore_config.h"
 
@@ -110,4 +112,4 @@ std::string memorySpaceName (const void* ptr);
 } // namespace Details
 } // namespace Tpetra
 
-#endif // TPETRA_DETAILS_CHECKMEMORYTYPE_HPP
+#endif // TPETRA_DETAILS_CHECKPOINTER_HPP
diff --git a/packages/tpetra/core/test/Utils/CheckMemoryType.cpp b/packages/tpetra/core/test/Utils/CheckMemoryType.cpp
@@ -42,7 +42,7 @@
 */
 
 #include "Tpetra_TestingUtilities.hpp"
-#include "Tpetra_Details_checkMemoryType.hpp"
+#include "Tpetra_Details_checkPointer.hpp"
 #include "Tpetra_Details_Behavior.hpp"
 #include "Kokkos_Core.hpp"