Merge pull request #9 from lanl/jmm/phoebus-tweaks

Minor tweaks and fixes for quality of life downstream

CMakeLists.txt

@@ -26,6 +26,7 @@ option (SINGULARITY_USE_KOKKOSKERNELS
 option (SINGULARITY_INVERT_AT_SETUP "Use eospacs preinverted tables" OFF)
 option (SINGULARITY_BUILD_TESTS "Compile tests" OFF)
 option (SINGULARITY_BUILD_SESAME2SPINER "Compile sesame2spiner" OFF)
+option (SINGULARITY_BUILD_STELLARCOLLAPSE2SPINER "Compile stellarcollapse2spiner" OFF)
 option (SINGULARITY_BETTER_DEBUG_FLAGS
   "Better debug flags for singularity" ON)
 option (SINGULARITY_HIDE_MORE_WARNINGS "hide more warnings" OFF)
@@ -83,6 +84,10 @@ execute_process(COMMAND patch -N -s -V never
 add_library (singularity-eos::flags INTERFACE IMPORTED GLOBAL)
 add_library (singularity-eos::libs INTERFACE IMPORTED)
 
+target_include_directories(singularity-eos::flags
+                           INTERFACE
+                           $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}>)
+
 # xl fix
 target_compile_options(singularity-eos::flags INTERFACE
                        $<$<COMPILE_LANG_AND_ID:CXX,XL>:-std=c++1y;-qxflag=disable__cplusplusOverride>)
@@ -301,7 +306,7 @@ else()
               $<TARGET_OBJECTS:eos_objs>)
 endif()
 
-if (SINGULARITY_USE_HDF5)
+if (SINGULARITY_USE_HDF5 AND SINGULARITY_BUILD_STELLARCOLLAPSE2SPINER)
    add_subdirectory(${PROJECT_SOURCE_DIR}/utils/stellarcollapse2spiner)
    install(TARGETS stellarcollapse2spiner DESTINATION bin)
 endif()

README.md

@@ -61,6 +61,7 @@ A number of options are avaialable for compiling:
 | SINGULARITY_TEST_SESAME           | OFF     | Test the Sesame table readers                                                        |
 | SINGULARITY_TEST_STELLAR_COLLAPSE | OFF     | Test the Stellar Collapse table readers                                              |
 | SINGULARITY_BUILD_SESAME2SPINER   | OFF     | Builds the conversion tool sesame2spiner which makes files readable by SpinerEOS     |
+| SINGULARITY_BUILD_STELLARCOLLAPSE2SPINER | OFF     | Builds the conversion tool stellarcollapse2spiner which optionally makes stellar collapse files faster to read |
 | SINGULARITY_INVERT_AT_SETUP       | OFF     | For tests, pre-invert eospac tables.                                                 |
 | SINGULARITY_BETTER_DEBUG_FLAGS    | ON      | Enables nicer GPU debug flags. May interfere with in-tree builds as a submodule      |
 | SINGULARITY_HIDE_MORE_WARNINGS    | OFF     | Makes warnings less verbose. May interfere with in-tree builds as a submodule        |

eos/eos.hpp

@@ -76,11 +76,7 @@ template <typename T> class ScaledEOS {
   // move semantics ensures dynamic memory comes along for the ride
   ScaledEOS(T &&t, const Real scale)
       : t_(std::forward<T>(t)), scale_(scale), inv_scale_(1. / scale) {}
-  PORTABLE_FUNCTION ScaledEOS() = default;
-  PORTABLE_FUNCTION ScaledEOS &operator=(ScaledEOS &&) = default;
-  PORTABLE_FUNCTION ScaledEOS &operator=(const ScaledEOS &) = default;
-  PORTABLE_FUNCTION ScaledEOS(const ScaledEOS &) = default;
-  // PORTABLE_FUNCTION ~ScaledEOS() = default;
+  ScaledEOS() = default;
 
   auto GetOnDevice() { return ScaledEOS<T>(t_.GetOnDevice(), scale_); }
   inline void Finalize() { t_.Finalize(); }
@@ -167,7 +163,6 @@ template <typename T> class ScaledEOS {
       break;
     default:
       EOS_ERROR("Didn't find a valid input for ScaledEOS::FillEOS\n");
-      exit(1);
     }
   }
 
@@ -222,11 +217,7 @@ template <typename T> class ShiftedEOS {
 public:
   // move semantics ensures dynamic memory comes along for the ride
   ShiftedEOS(T &&t, const Real shift) : t_(std::forward<T>(t)), shift_(shift) {}
-  PORTABLE_FUNCTION ShiftedEOS() = default;
-  PORTABLE_FUNCTION ShiftedEOS &operator=(ShiftedEOS &&) = default;
-  PORTABLE_FUNCTION ShiftedEOS &operator=(const ShiftedEOS &) = default;
-  PORTABLE_FUNCTION ShiftedEOS(const ShiftedEOS &) = default;
-  // PORTABLE_FUNCTION ~ShiftedEOS() = default;
+  ShiftedEOS() = default;
 
   auto GetOnDevice() { return ShiftedEOS<T>(t_.GetOnDevice(), shift_); }
   inline void Finalize() { t_.Finalize(); }
@@ -303,7 +294,6 @@ template <typename T> class ShiftedEOS {
       break;
     default:
       EOS_ERROR("Didn't find a valid input for ShiftedEOS::FillEOS\n");
-      exit(1);
     }
   }
 
@@ -353,11 +343,7 @@ template <typename T> class RelativisticEOS {
         ,
         cl2_(cl * cl) // speed of light squared
   {}
-  PORTABLE_FUNCTION RelativisticEOS() = default;
-  PORTABLE_FUNCTION RelativisticEOS &operator=(RelativisticEOS &&) = default;
-  PORTABLE_FUNCTION RelativisticEOS &
-  operator=(const RelativisticEOS &) = default;
-  PORTABLE_FUNCTION RelativisticEOS(const RelativisticEOS &) = default;
+  RelativisticEOS() = default;
 
   auto GetOnDevice() { return RelativisticEOS<T>(t_.GetOnDevice(), cl_); }
   inline void Finalize() { t_.Finalize(); }
@@ -464,11 +450,8 @@ template <typename T> class RelativisticEOS {
 
 class IdealGas {
 public:
-  PORTABLE_FUNCTION IdealGas() = default;
-  PORTABLE_FUNCTION IdealGas &operator=(IdealGas &&) = default;
-  PORTABLE_FUNCTION IdealGas &operator=(const IdealGas &) = default;
-  PORTABLE_FUNCTION IdealGas(const IdealGas &) = default;
-  PORTABLE_FUNCTION IdealGas(Real gm1, Real Cv)
+  IdealGas() = default;
+  PORTABLE_INLINE_FUNCTION IdealGas(Real gm1, Real Cv)
       : _Cv(Cv), _gm1(gm1), _rho0(_P0 / (_gm1 * _Cv * _T0)), _sie0(_Cv * _T0),
         _bmod0((_gm1 + 1) * _gm1 * _rho0 * _Cv * _T0), _dpde0(_gm1 * _rho0),
         _dvdt0(1. / (_rho0 * _T0)) {}
@@ -533,15 +516,11 @@ class IdealGas {
 // /[...]/eos/gruneisen in FLAG
 class Gruneisen {
 public:
-  PORTABLE_FUNCTION Gruneisen() = default;
-  PORTABLE_FUNCTION Gruneisen &operator=(Gruneisen &&) = default;
-  PORTABLE_FUNCTION Gruneisen &operator=(const Gruneisen &) = default;
-  PORTABLE_FUNCTION Gruneisen(const Gruneisen &) = default;
-  // PORTABLE_INLINE_FUNCTION ~Gruneisen() = default;
-  PORTABLE_FUNCTION Gruneisen(const Real C0, const Real s1, const Real s2,
-                              const Real s3, const Real G0, const Real b,
-                              const Real rho0, const Real T0, const Real P0,
-                              const Real Cv)
+  Gruneisen() = default;
+  PORTABLE_INLINE_FUNCTION
+  Gruneisen(const Real C0, const Real s1, const Real s2, const Real s3,
+            const Real G0, const Real b, const Real rho0, const Real T0,
+            const Real P0, const Real Cv)
       : _C0(C0), _s1(s1), _s2(s2), _s3(s3), _G0(G0), _b(b), _rho0(rho0),
         _T0(T0), _P0(P0), _Cv(Cv) {}
   Gruneisen GetOnDevice() { return *this; }
@@ -606,14 +585,10 @@ class Gruneisen {
 // implemented in xRAGE for eostype(1).  It does not include any energy shifting
 class JWL {
 public:
-  PORTABLE_FUNCTION JWL() = default;
-  PORTABLE_FUNCTION JWL &operator=(JWL &&) = default;
-  PORTABLE_FUNCTION JWL &operator=(const JWL &) = default;
-  PORTABLE_FUNCTION JWL(const JWL &) = default;
-  // PORTABLE_INLINE_FUNCTION ~JWL() = default;
-  PORTABLE_FUNCTION JWL(const Real A, const Real B, const Real R1,
-                        const Real R2, const Real w, const Real rho0,
-                        const Real Cv)
+  JWL() = default;
+  PORTABLE_INLINE_FUNCTION JWL(const Real A, const Real B, const Real R1,
+                               const Real R2, const Real w, const Real rho0,
+                               const Real Cv)
       : _A(A), _B(B), _R1(R1), _R2(R2), _w(w), _rho0(rho0), _Cv(Cv) {}
   JWL GetOnDevice() { return *this; }
   PORTABLE_FUNCTION Real TemperatureFromDensityInternalEnergy(
@@ -672,12 +647,8 @@ class JWL {
 
 class DavisReactants {
 public:
-  PORTABLE_FUNCTION DavisReactants() = default;
-  // PORTABLE_INLINE_FUNCTION ~DavisReactants() = default;
-  PORTABLE_FUNCTION DavisReactants &operator=(DavisReactants &&) = default;
-  PORTABLE_FUNCTION DavisReactants &operator=(const DavisReactants &) = default;
-  PORTABLE_FUNCTION DavisReactants(const DavisReactants &) = default;
-  PORTABLE_FUNCTION
+  DavisReactants() = default;
+  PORTABLE_INLINE_FUNCTION
   DavisReactants(const Real rho0, const Real e0, const Real P0, const Real T0,
                  const Real A, const Real B, const Real C, const Real G0,
                  const Real Z, const Real alpha, const Real Cv0)
@@ -742,12 +713,8 @@ class DavisReactants {
 
 class DavisProducts {
 public:
-  PORTABLE_FUNCTION DavisProducts() = default;
-  PORTABLE_FUNCTION DavisProducts &operator=(DavisProducts &&) = default;
-  PORTABLE_FUNCTION DavisProducts &operator=(const DavisProducts &) = default;
-  PORTABLE_FUNCTION DavisProducts(const DavisProducts &) = default;
-  // PORTABLE_INLINE_FUNCTION ~DavisProducts() = default;
-  PORTABLE_FUNCTION
+  DavisProducts() = default;
+  PORTABLE_INLINE_FUNCTION
   DavisProducts(const Real a, const Real b, const Real k, const Real n,
                 const Real vc, const Real pc, const Real Cv, const Real E0)
       : _a(a), _b(b), _k(k), _n(n), _vc(vc), _pc(pc), _Cv(Cv), _E0(E0) {}
@@ -837,12 +804,6 @@ class SpinerEOSDependsRhoT {
                        bool reproducibility_mode = false);
   PORTABLE_INLINE_FUNCTION
   SpinerEOSDependsRhoT() : memoryStatus_(DataStatus::Deallocated) {}
-  PORTABLE_FUNCTION SpinerEOSDependsRhoT &
-  operator=(SpinerEOSDependsRhoT &&) = default;
-  PORTABLE_FUNCTION SpinerEOSDependsRhoT &
-  operator=(const SpinerEOSDependsRhoT &) = default;
-  PORTABLE_FUNCTION
-  SpinerEOSDependsRhoT(const SpinerEOSDependsRhoT &) = default;
 
   SpinerEOSDependsRhoT GetOnDevice();
 
@@ -1045,12 +1006,6 @@ class SpinerEOSDependsRhoSie {
   };
   PORTABLE_INLINE_FUNCTION SpinerEOSDependsRhoSie()
       : memoryStatus_(DataStatus::Deallocated) {}
-  PORTABLE_FUNCTION SpinerEOSDependsRhoSie &
-  operator=(SpinerEOSDependsRhoSie &&) = default;
-  PORTABLE_FUNCTION SpinerEOSDependsRhoSie &
-  operator=(const SpinerEOSDependsRhoSie &) = default;
-  PORTABLE_FUNCTION
-  SpinerEOSDependsRhoSie(const SpinerEOSDependsRhoSie &) = default;
   SpinerEOSDependsRhoSie(const std::string &filename, int matid,
                          bool reproducibility_mode = false);
   SpinerEOSDependsRhoSie(const std::string &filename,
@@ -1208,10 +1163,6 @@ class StellarCollapse {
 
   PORTABLE_INLINE_FUNCTION
   StellarCollapse() : memoryStatus_(DataStatus::Deallocated) {}
-  PORTABLE_FUNCTION StellarCollapse &operator=(StellarCollapse &&) = default;
-  PORTABLE_FUNCTION StellarCollapse &
-  operator=(const StellarCollapse &) = default;
-  PORTABLE_FUNCTION StellarCollapse(const StellarCollapse &) = default;
 
   StellarCollapse GetOnDevice();
 
@@ -1323,16 +1274,15 @@ class StellarCollapse {
   void computeColdAndHotCurves_();
   void setNormalValues_();
 
-  PORTABLE_INLINE_FUNCTION void __attribute__((always_inline))
+  PORTABLE_INLINE_FUNCTION __attribute__((always_inline)) void
   checkLambda_(Real *lambda) const noexcept {
     if (lambda == nullptr) {
       EOS_ERROR(
           "StellarCollapse: lambda must contain Ye and 1 space for caching.\n");
-      exit(1);
     }
   }
 
-  PORTABLE_INLINE_FUNCTION Real __attribute__((always_inline))
+  PORTABLE_INLINE_FUNCTION __attribute__((always_inline)) Real
   toLog_(const Real x, const Real offset) const noexcept {
     // return std::log10(x + offset + EPS);
     // return std::log10(std::abs(std::max(x,-offset) + offset)+EPS);
@@ -1390,15 +1340,14 @@ class StellarCollapse {
 
   PORTABLE_FUNCTION Real lTFromlRhoSie_(const Real lRho, const Real sie,
                                         Real *lambda) const noexcept;
-  PORTABLE_INLINE_FUNCTION void __attribute__((always_inline))
+  PORTABLE_INLINE_FUNCTION __attribute__((always_inline)) void
   getLogsFromRhoT_(const Real rho, const Real temp, Real *lambda, Real &lRho,
                    Real &lT, Real &Ye) const noexcept {
     checkLambda_(lambda);
     lRho = lRho_(rho);
     lT = lT_(temp);
     Ye = lambda[Lambda::Ye];
     lambda[Lambda::lT] = lT;
-    return;
   }
   PORTABLE_INLINE_FUNCTION __attribute__((always_inline)) void
   getLogsFromRhoSie_(const Real rho, const Real sie, Real *lambda, Real &lRho,

eos/eos_stellar_collapse.cpp

@@ -292,19 +292,16 @@ void StellarCollapse::FillEos(Real &rho, Real &temp, Real &energy, Real &press,
   const unsigned long input = ~output;
   if (output == thermalqs::none) {
     UNDEFINED_ERROR;
-    exit(1);
   }
   if (output & thermalqs::density) {
     EOS_ERROR("StellarCollapse cannot output density at this time");
-    exit(1);
   }
   if (input & thermalqs::temperature) {
     getLogsFromRhoT_(rho, temp, lambda, lRho, lT, Ye);
   } else if (input & thermalqs::specific_internal_energy) {
     getLogsFromRhoSie_(rho, energy, lambda, lRho, lT, Ye);
   } else {
     UNDEFINED_ERROR;
-    exit(1);
   }
   if (output & thermalqs::specific_internal_energy) {
     const Real lE = lE_.interpToReal(Ye, lT, lRho);
@@ -404,7 +401,6 @@ void StellarCollapse::LoadFromStellarCollapseFile_(
   status = H5LTread_dataset_double(file_id, "energy_shift", &lEOffset_);
   if (status < 0) {
     EOS_ERROR("An HDF5 error ocurred while reading energy_shift\n");
-    exit(1);
   }
 
   // Bounds
@@ -456,7 +452,6 @@ int StellarCollapse::readSCInt_(const hid_t &file_id, const std::string &name) {
   if (status < 0) {
     std::string msg = "Failed to read dataset " + name + "\n";
     EOS_ERROR(msg.c_str());
-    exit(1);
   }
   return data;
 }
@@ -648,7 +643,7 @@ Real StellarCollapse::lTFromlRhoSie_(const Real lRho, const Real sie,
     status = findRoot(lEFunc, lE, lTGuess, lTMin_, lTMax_, ROOT_THRESH,
                       ROOT_THRESH, lT, counts);
     if (status != RootFinding1D::Status::SUCCESS) {
-#ifdef STELLAR_COLLAPSE_EOS_VERBOSE
+#if STELLAR_COLLAPSE_EOS_VERBOSE
       std::stringstream errorMessage;
       errorMessage << "Inverting log(sie) table for log(T) failed\n"
                    << "Ye      = " << Ye << "\n"

eos/eos_variant.hpp

@@ -44,7 +44,6 @@ class Variant {
     eos_( std::move(std::forward<EOSChoice>(choice)) )
   {}
 
-  PORTABLE_FUNCTION
   Variant() noexcept = default;
 
   template<typename EOSChoice,

test/eos_unit_tests.cpp

@@ -46,11 +46,16 @@ namespace thermalqs = singularity::thermalqs;
 const std::string eosName = "../singularity-eos-data/materials.sp5";
 const std::string airName = "air";
 const std::string steelName = "stainless steel 347";
-const int steelID = 4272;
-const int airID = 5030;
-const int DTID = 5267;
-const int goldID = 2700;
+
+#ifdef SPINER_USE_HDF
+#ifdef SPINER_TEST_SESAME
+constexpr int steelID = 4272;
+constexpr int airID = 5030;
+constexpr int DTID = 5267;
+constexpr int goldID = 2700;
 constexpr Real ev2k = 1.160451812e4;
+#endif // SPINER_TEST_SESAME
+#endif // SPINER_USE_HDF
 
 constexpr Real EPS = 1e-2; // within a percent
 PORTABLE_INLINE_FUNCTION bool isClose(Real a, Real b) {

utils/cuda_compatibility.patch

@@ -62,7 +62,7 @@ index 2fb2ac549..aeef9dcdd 100644
 
      MPARK_VARIANT_COPY_CONSTRUCTOR(
 -        Trait::TriviallyAvailable,
-+        Trait::TriviallyAvailable,V_GPU_FUNCTION
++        Trait::TriviallyAvailable,
          copy_constructor(const copy_constructor &that) = default;);
 
      MPARK_VARIANT_COPY_CONSTRUCTOR(
@@ -103,7 +103,7 @@ index 2fb2ac549..aeef9dcdd 100644
 
      MPARK_VARIANT_MOVE_ASSIGNMENT(
 -        Trait::TriviallyAvailable,
-+        Trait::TriviallyAvailable,V_GPU_FUNCTION
++        Trait::TriviallyAvailable,
          move_assignment &operator=(move_assignment &&that) = default;);
 
      MPARK_VARIANT_MOVE_ASSIGNMENT(

utils/stellarcollapse2spiner/main.cpp

@@ -18,7 +18,7 @@
 #include <iostream>
 #include <string>
 
-#include <eos.hpp>
+#include <eos/eos.hpp>
 
 using singularity::StellarCollapse;