Add more assertions and minor fixes (#730)

* Check for valid track initializer
* Add more assertions
* Require track initializer to have positive energy
* Add a should-be-unnecessary assertion to the StackAllocator
* Fix comparison
* Fix CELER_UNLIKELY macro for when __builtin_expect() isn't available

src/celeritas/ext/VecgeomTrackView.hh

@@ -182,6 +182,8 @@ VecgeomTrackView::VecgeomTrackView(ParamsRef const& params,
 CELER_FUNCTION VecgeomTrackView&
 VecgeomTrackView::operator=(Initializer_t const& init)
 {
+    CELER_EXPECT(is_soft_unit_vector(init.dir));
+
     // Initialize position/direction
     pos_ = init.pos;
     dir_ = init.dir;
@@ -213,6 +215,8 @@ VecgeomTrackView::operator=(Initializer_t const& init)
 CELER_FUNCTION
 VecgeomTrackView& VecgeomTrackView::operator=(DetailedInitializer const& init)
 {
+    CELER_EXPECT(is_soft_unit_vector(init.dir));
+
     if (this != &init.other)
     {
         // Copy the navigation state and position from the parent state

src/celeritas/mat/MaterialParamsOutput.cc

@@ -28,10 +28,10 @@ namespace celeritas
 {
 //---------------------------------------------------------------------------//
 /*!
- * Construct from shared geometry data.
+ * Construct from shared material data.
  */
-MaterialParamsOutput::MaterialParamsOutput(SPConstMaterialParams geo)
-    : material_(std::move(geo))
+MaterialParamsOutput::MaterialParamsOutput(SPConstMaterialParams material)
+    : material_(std::move(material))
 {
     CELER_EXPECT(material_);
 }

src/celeritas/mat/MaterialParamsOutput.hh

@@ -27,7 +27,7 @@ class MaterialParamsOutput final : public OutputInterface
     //!@}
 
   public:
-    // Construct from shared materialmetry data
+    // Construct from shared material data
     explicit MaterialParamsOutput(SPConstMaterialParams material);
 
     //! Category of data to write

src/celeritas/phys/ParticleData.hh

@@ -108,6 +108,12 @@ struct ParticleTrackInitializer
 {
     ParticleId particle_id;  //!< Type of particle (electron, gamma, ...)
     units::MevEnergy energy;  //!< Kinetic energy [MeV]
+
+    //! True if assigned and valid
+    explicit CELER_FUNCTION operator bool() const
+    {
+        return particle_id && energy > zero_quantity();
+    }
 };
 
 //---------------------------------------------------------------------------//

src/celeritas/track/SimData.hh

@@ -99,6 +99,12 @@ struct SimTrackInitializer
 
     TrackStatus status{TrackStatus::inactive};
     StepLimit step_limit;
+
+    //! True if assigned and valid
+    explicit CELER_FUNCTION operator bool() const
+    {
+        return track_id && event_id;
+    }
 };
 
 //---------------------------------------------------------------------------//

src/celeritas/track/TrackInitData.hh

@@ -68,6 +68,12 @@ struct TrackInitializer
     SimTrackInitializer sim;
     GeoTrackInitializer geo;
     ParticleTrackInitializer particle;
+
+    //! True if assigned and valid
+    explicit CELER_FUNCTION operator bool() const
+    {
+        return sim && geo && particle;
+    }
 };
 
 //---------------------------------------------------------------------------//

src/celeritas/track/detail/ProcessSecondariesLauncher.hh

@@ -104,6 +104,9 @@ ProcessSecondariesLauncher<M>::operator()(TrackSlotId tid) const
     {
         if (secondary)
         {
+            CELER_ASSERT(secondary.energy > zero_quantity()
+                         && is_soft_unit_vector(secondary.direction));
+
             // Particles should not be making secondaries while crossing a
             // surface
             GeoTrackView geo(params_.geometry, states_.geometry, tid);
@@ -128,6 +131,7 @@ ProcessSecondariesLauncher<M>::operator()(TrackSlotId tid) const
             ti.geo.dir = secondary.direction;
             ti.particle.particle_id = secondary.particle_id;
             ti.particle.energy = secondary.energy;
+            CELER_ASSERT(ti);
 
             if (!initialized && sim.status() != TrackStatus::alive)
             {

src/corecel/Macros.hh

@@ -71,7 +71,7 @@
 #    define CELER_UNLIKELY(COND) __builtin_expect(!!(COND), 0)
 #else
 // No other compilers seem to have a similar builtin
-#    define CELER_UNLIKELY(COND) COND
+#    define CELER_UNLIKELY(COND) (COND)
 #endif
 
 /*!

src/corecel/data/StackAllocator.hh

@@ -228,6 +228,9 @@ CELER_FUNCTION auto StackAllocator<T>::operator()(size_type count)
     for (size_type i = 1; i < count; ++i)
     {
         // Initialize remaining values
+        // XXX see #639: something is causing \c start to change unexpectedly,
+        // which leads to values being initialized at the wrong memory location
+        CELER_ASSERT(&data_.storage[StorageId{start + i}] == result + i);
         new (&data_.storage[StorageId{start + i}]) value_type;
     }
     return result;

src/orange/Types.hh

@@ -11,6 +11,7 @@
 #include "corecel/OpaqueId.hh"
 #include "corecel/Types.hh"
 #include "corecel/cont/Array.hh"
+#include "corecel/math/ArrayUtils.hh"
 
 namespace celeritas
 {
@@ -51,6 +52,12 @@ struct GeoTrackInitializer
 {
     Real3 pos;
     Real3 dir;
+
+    //! True if assigned and valid
+    explicit CELER_FUNCTION operator bool() const
+    {
+        return is_soft_unit_vector(dir);
+    }
 };
 
 //---------------------------------------------------------------------------//