EIC code displayed by LXR master/​include/​celeritas/​global/​Stepper.hh	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-09-18 09:09:05

 //------------------------------- -*- C++ -*- -------------------------------//
 // Copyright Celeritas contributors: see top-level COPYRIGHT file for details
 // SPDX-License-Identifier: (Apache-2.0 OR MIT)
 //---------------------------------------------------------------------------//
 //! \file celeritas/global/Stepper.hh
 //---------------------------------------------------------------------------//
 #pragma once
 
 #include <memory>
 #include <vector>
 
 #include "corecel/Types.hh"
 #include "corecel/cont/Span.hh"
 #include "corecel/data/CollectionStateStore.hh"
 #include "corecel/random/params/RngParamsFwd.hh"
 #include "celeritas/Types.hh"
 #include "celeritas/geo/GeoFwd.hh"
 #include "celeritas/phys/Primary.hh"
 #include "celeritas/track/TrackInitData.hh"
 
 #include "CoreState.hh"
 #include "CoreTrackData.hh"
 
 namespace celeritas
 {
 //---------------------------------------------------------------------------//
 class CoreParams;
 struct Primary;
 class ExtendFromPrimariesAction;
 
 class ActionSequence;
 
 //---------------------------------------------------------------------------//
 /*!
  * State-specific options for the stepper.
  *
  * - \c params : Problem definition
  * - \c num_track_slots : Maximum number of threads to run in parallel on GPU
  *   (optional, could be set by params)
  *   \c stream_id : Unique (thread/task) ID for this process
  * - \c action_times : Whether to synchronize device between actions for timing
  */
 struct StepperInput
 {
     std::shared_ptr<CoreParams const> params;
     StreamId stream_id{};
     size_type num_track_slots{};
     bool action_times{false};
 
     //! True if defined
     explicit operator bool() const { return params && stream_id; }
 };
 
 //---------------------------------------------------------------------------//
 /*!
  * Track counters for a step.
  */
 struct StepperResult
 {
     size_type generated{};  //!< New primaries added
     size_type queued{};  //!< Pending track initializers at end of step
     size_type active{};  //!< Active tracks at start of step
     size_type alive{};  //!< Active and alive at end of step
 
     //! True if more steps need to be run
     explicit operator bool() const { return queued > 0 || alive > 0; }
 };
 
 //---------------------------------------------------------------------------//
 /*!
  * Interface class for stepper classes.
  *
  * This allows higher-level classes not to care whether the stepper operates on
  * host or device.
  *
  * \note This class and its daughter may be removed soon to facilitate step
  * gathering.
  */
 class StepperInterface
 {
   public:
     //!@{
     //! \name Type aliases
     using Input = StepperInput;
     using ActionSequenceT = ActionSequence;
     using SpanConstPrimary = Span<Primary const>;
     using result_type = StepperResult;
     using SPState = std::shared_ptr<CoreStateInterface>;
     //!@}
 
   public:
     // Default virtual destructor
     virtual ~StepperInterface();
 
     // Warm up before stepping
     virtual void warm_up() = 0;
 
     // Transport existing states
     virtual StepperResult operator()() = 0;
 
     // Transport existing states and these new primaries
     virtual StepperResult operator()(SpanConstPrimary primaries) = 0;
 
     // Kill all tracks in flight to debug "stuck" tracks
     virtual void kill_active() = 0;
 
     // Reseed the RNGs at the start of an event for reproducibility
     virtual void reseed(UniqueEventId event_id) = 0;
 
     //! Get action sequence for timing diagnostics
     virtual ActionSequenceT const& actions() const = 0;
 
     //! Get the core state interface
     virtual CoreStateInterface const& state() const = 0;
 
     //! Get a shared pointer to the state (TEMPORARY)
     virtual SPState sp_state() = 0;
 
   protected:
     StepperInterface() = default;
     CELER_DEFAULT_COPY_MOVE(StepperInterface);
 };
 
 //---------------------------------------------------------------------------//
 /*!
  * Manage a state vector and execute a single step on all of them.
  *
  * \note This is likely to be removed and refactored since we're changing how
  * primaries are created and how multithread state ownership is managed.
  *
  * \code
    Stepper<MemSpace::host> step(input);
 
    // Transport primaries for the initial step
    StepperResult alive_tracks = step(my_primaries);
    while (alive_tracks)
    {
        // Transport secondaries
        alive_tracks = step();
    }
    \endcode
  */
 template<MemSpace M>
 class Stepper final : public StepperInterface
 {
   public:
     //!@{
     //! \name Type aliases
     using StateRef = CoreStateData<Ownership::reference, M>;
     //!@}
 
   public:
     // Construct with problem parameters and setup options
     explicit Stepper(Input input);
 
     // Default destructor
     ~Stepper() final;
 
     // Warm up before stepping
     void warm_up() final;
 
     // Transport existing states
     StepperResult operator()() final;
 
     // Transport existing states and these new primaries
     StepperResult operator()(SpanConstPrimary primaries) final;
 
     // Kill all tracks in flight to debug "stuck" tracks
     void kill_active() final;
 
     // Reseed the RNGs at the start of an event for reproducibility
     void reseed(UniqueEventId event_id) final;
 
     //! Get action sequence for timing diagnostics
     ActionSequenceT const& actions() const final { return *actions_; }
 
     //! Access core data, primarily for debugging
     StateRef const& state_ref() const { return state_->ref(); }
 
     //! Get the core state interface for diagnostic output
     CoreStateInterface const& state() const final { return *state_; }
 
     //! Reset the core state counters and data so it can be reused
     void reset_state() { state_->reset(); }
 
     //! Get a shared pointer to the state (TEMPORARY, DO NOT USE)
     SPState sp_state() final { return state_; }
 
   private:
     // Params data
     std::shared_ptr<CoreParams const> params_;
     // Primary initialization
     std::shared_ptr<ExtendFromPrimariesAction const> primaries_action_;
     // State data
     std::shared_ptr<CoreState<M>> state_;
     // Call sequence
     std::shared_ptr<ActionSequenceT> actions_;
 };
 
 //---------------------------------------------------------------------------//
 // EXPLICIT INSTANTIATION
 //---------------------------------------------------------------------------//
 
 extern template class Stepper<MemSpace::host>;
 extern template class Stepper<MemSpace::device>;
 
 //---------------------------------------------------------------------------//
 }  // namespace celeritas

This page was automatically generated by the 2.3.7 LXR engine. The LXR team