Merge pull request #504 from eagles-project/jeff-cohere/bfbhash

Generates bit-for-bit hashes for each validation driver using EAMxx's bfbhash approach.

Author: jeff-cohere

CMakeLists.txt

@@ -80,6 +80,9 @@ include_directories(${PROJECT_BINARY_DIR}/src)
 
 link_directories("${MAM4XX_HAERO_DIR}/${CMAKE_INSTALL_LIBDIR}")
 
+# emit compile_commands.json for use with clangd
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
 # Code coverage
 if (ENABLE_COVERAGE)
   message(STATUS "Enabling code coverage instrumentation")

ext/skywalker

@@ -88,6 +88,5 @@ int main(int argc, char **argv) {
   ensemble->write(output_file);
 
   // Clean up.
-  delete ensemble;
-  validation::finalize();
+  validation::finalize(ensemble);
 }

src/validation/aero_emissions/aero_emissions_driver.cpp

@@ -78,6 +78,5 @@ int main(int argc, char **argv) {
   ensemble->write(output_file);
 
   // Clean up.
-  delete ensemble;
-  validation::finalize();
+  validation::finalize(ensemble);
 }

src/validation/aero_model/aero_model_driver.cpp

@@ -99,6 +99,5 @@ int main(int argc, char **argv) {
   ensemble->write(output_file);
 
   // Clean up.
-  delete ensemble;
-  validation::finalize();
+  validation::finalize(ensemble);
 }

src/validation/aerosol_optics/aerosol_optics_driver.cpp

@@ -68,6 +68,5 @@ int main(int argc, char **argv) {
   ensemble->write(output_file);
 
   // Clean up.
-  delete ensemble;
-  validation::finalize();
+  validation::finalize(ensemble);
 }

src/validation/aging/aging_driver.cpp

@@ -0,0 +1,61 @@
+#ifndef MAM4XX_BFBHASH_HPP
+#define MAM4xx_BFBHASH_HPP
+
+// This was copied from Andrew Bradley's original implementation at
+// E3SM/components/eamxx/src/share/util/eamxx_bfbhash.hpp.
+
+#include <cstdint>
+
+#include <ekat_comm.hpp>
+#include <ekat_kokkos_types.hpp>
+
+namespace mam4 {
+namespace bfbhash {
+
+typedef std::uint64_t HashType;
+
+KOKKOS_INLINE_FUNCTION void hash(const HashType v, HashType &accum) {
+  constexpr auto first_bit = 1ULL << 63;
+  accum += ~first_bit & v; // no overflow
+  accum ^= first_bit & v;  // handle most significant bit
+}
+
+KOKKOS_INLINE_FUNCTION void hash(const double v_, HashType &accum) {
+  static_assert(sizeof(double) == sizeof(HashType),
+                "HashType must have size sizeof(double).");
+  HashType v;
+  std::memcpy(&v, &v_, sizeof(HashType));
+  hash(v, accum);
+}
+
+KOKKOS_INLINE_FUNCTION void hash(const float v, HashType &accum) {
+  hash(double(v), accum);
+}
+
+// For Kokkos::parallel_reduce.
+template <typename ExecSpace = Kokkos::HostSpace> struct HashReducer {
+  typedef HashReducer reducer;
+  typedef HashType value_type;
+  typedef Kokkos::View<value_type *, ExecSpace, Kokkos::MemoryUnmanaged>
+      result_view_type;
+
+  KOKKOS_INLINE_FUNCTION HashReducer(value_type &value_) : value(value_) {}
+  KOKKOS_INLINE_FUNCTION void join(value_type &dest,
+                                   const value_type &src) const {
+    hash(src, dest);
+  }
+  KOKKOS_INLINE_FUNCTION void init(value_type &val) const { val = 0; }
+  KOKKOS_INLINE_FUNCTION value_type &reference() const { return value; }
+  KOKKOS_INLINE_FUNCTION bool references_scalar() const { return true; }
+  KOKKOS_INLINE_FUNCTION result_view_type view() const {
+    return result_view_type(&value, 1);
+  }
+
+private:
+  value_type &value;
+};
+
+} // namespace bfbhash
+} // namespace mam4
+
+#endif

src/validation/bfbhash.hpp

@@ -76,6 +76,5 @@ int main(int argc, char **argv) {
   ensemble->write(output_file);
 
   // Clean up.
-  delete ensemble;
-  validation::finalize();
+  validation::finalize(ensemble);
 }

src/validation/calcsize/calcsize_driver.cpp

@@ -78,6 +78,5 @@ int main(int argc, char **argv) {
   ensemble->write(output_file);
 
   //   // Clean up.
-  delete ensemble;
-  validation::finalize();
+  validation::finalize(ensemble);
 }

src/validation/coagulation/coagulation_driver.cpp

@@ -126,6 +126,5 @@ int main(int argc, char **argv) {
   ensemble->write(output_file);
 
   // Clean up.
-  delete ensemble;
-  validation::finalize();
+  validation::finalize(ensemble);
 }