Add optical sensitive detectors #2215
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,104 @@ | ||||||
| //------------------------------- -*- C++ -*- -------------------------------// | ||||||
| // Copyright Celeritas contributors: see top-level COPYRIGHT file for details | ||||||
| // SPDX-License-Identifier: (Apache-2.0 OR MIT) | ||||||
| //---------------------------------------------------------------------------// | ||||||
| //! \file celeritas/optical/detector/DetectorAction.cc | ||||||
| //---------------------------------------------------------------------------// | ||||||
| #include "DetectorAction.hh" | ||||||
|
|
||||||
| #include "celeritas/optical/action/ActionLauncher.hh" | ||||||
| #include "celeritas/optical/action/TrackSlotExecutor.hh" | ||||||
|
|
||||||
| #include "DetectorExecutor.hh" | ||||||
|
|
||||||
| namespace celeritas | ||||||
| { | ||||||
| namespace optical | ||||||
| { | ||||||
| //---------------------------------------------------------------------------// | ||||||
| /*! | ||||||
| * Construct with action ID. | ||||||
| */ | ||||||
| DetectorAction::DetectorAction(ActionId aid) | ||||||
| : StaticConcreteAction(aid, "scoring-detector", "Score detector hits") | ||||||
| { | ||||||
| } | ||||||
|
|
||||||
| //---------------------------------------------------------------------------// | ||||||
| /*! | ||||||
| * Launch the detector action on host. | ||||||
| */ | ||||||
| void DetectorAction::step(CoreParams const& params, CoreStateHost& state) const | ||||||
| { | ||||||
| TrackSlotExecutor execute{ | ||||||
| params.ptr<MemSpace::native>(), state.ptr(), DetectorExecutor{}}; | ||||||
| launch_action(state, execute); | ||||||
|
|
||||||
| this->process_hits(params, state); | ||||||
| } | ||||||
|
|
||||||
| #if !CELER_USE_DEVICE | ||||||
| void DetectorAction::step(CoreParams const&, CoreStateDevice&) const | ||||||
| { | ||||||
| CELER_NOT_CONFIGURED("CUDA OR HIP"); | ||||||
| } | ||||||
| #endif | ||||||
|
|
||||||
| //---------------------------------------------------------------------------// | ||||||
| /*! | ||||||
| * Process hits copied from the kernels and send them to the callback. | ||||||
| */ | ||||||
| void DetectorAction::process_hits(CoreParams const& params, | ||||||
| CoreStateHost& state) const | ||||||
| { | ||||||
| this->process_hits_impl<MemSpace::host>(params, state); | ||||||
| } | ||||||
|
|
||||||
| //---------------------------------------------------------------------------// | ||||||
| /*! | ||||||
| * Process hits copied from the kernels and send them to the callback. | ||||||
| */ | ||||||
| void DetectorAction::process_hits(CoreParams const& params, | ||||||
| CoreStateDevice& state) const | ||||||
| { | ||||||
| this->process_hits_impl<MemSpace::device>(params, state); | ||||||
| } | ||||||
|
|
||||||
| //---------------------------------------------------------------------------// | ||||||
| /*! | ||||||
| * Process hits copied from the kernels and send them to the callback. | ||||||
| * | ||||||
| * Copied hits might be invalid, and are removed before sending into the | ||||||
| * callback function. The callback is only execute when a non-zero amount of | ||||||
|
There was a problem hiding this comment. Spelling error: "execute" should be "executed". The comment should read "The callback is only executed when a non-zero amount of valid hits occurs."
Suggested change
|
||||||
| * valid hits occurs. | ||||||
| */ | ||||||
| template<MemSpace M> | ||||||
| void DetectorAction::process_hits_impl(CoreParams const& params, | ||||||
| CoreState<M>& state) const | ||||||
| { | ||||||
| DetectorHitOutput hit_results; | ||||||
|
|
||||||
| // Copy hits (possibly from device) into pinned vector | ||||||
| copy_hits<M>(&hit_results, state.ref().scoring, state.stream_id()); | ||||||
|
|
||||||
| // Erase all hits with invalid detector ID | ||||||
| hit_results.hits.erase( | ||||||
| std::remove_if(hit_results.hits.begin(), | ||||||
| hit_results.hits.end(), | ||||||
| [](DetectorHit const& hit) { | ||||||
| return !static_cast<bool>(hit.detector); | ||||||
| }), | ||||||
| hit_results.hits.end()); | ||||||
|
|
||||||
| // Send hits to the callback function, if there are any | ||||||
| if (!hit_results.hits.empty()) | ||||||
| { | ||||||
| auto const& scoring = params.scoring(); | ||||||
| CELER_ASSERT(scoring); | ||||||
| scoring->process_hits(make_span(hit_results.hits)); | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
| //---------------------------------------------------------------------------// | ||||||
| } // namespace optical | ||||||
| } // namespace celeritas | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| //------------------------------ -*- cuda -*- -------------------------------// | ||
| // Copyright Celeritas contributors: see top-level COPYRIGHT file for details | ||
| // SPDX-License-Identifier: (Apache-2.0 OR MIT) | ||
| //---------------------------------------------------------------------------// | ||
| //! \file celeritas/optical/detector/DetectorAction.cu | ||
| //---------------------------------------------------------------------------// | ||
| #include "DetectorAction.hh" | ||
|
|
||
| #include "celeritas/optical/action/ActionLauncher.device.hh" | ||
| #include "celeritas/optical/action/TrackSlotExecutor.hh" | ||
|
|
||
| #include "DetectorExecutor.hh" | ||
|
|
||
| namespace celeritas | ||
| { | ||
| namespace optical | ||
| { | ||
| //---------------------------------------------------------------------------// | ||
| /*! | ||
| * Launch the detector action on device. | ||
| */ | ||
| void DetectorAction::step(CoreParams const& params, CoreStateDevice& state) const | ||
| { | ||
| TrackSlotExecutor execute{ | ||
| params.ptr<MemSpace::native>(), state.ptr(), DetectorExecutor{}}; | ||
|
|
||
| static ActionLauncher<decltype(execute)> const launch_kernel(*this); | ||
| launch_kernel(state, execute); | ||
|
|
||
| this->process_hits(params, state); | ||
| } | ||
|
|
||
| //---------------------------------------------------------------------------// | ||
| } // namespace optical | ||
| } // namespace celeritas |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| //------------------------------- -*- C++ -*- -------------------------------// | ||
| // Copyright Celeritas contributors: see top-level COPYRIGHT file for details | ||
| // SPDX-License-Identifier: (Apache-2.0 OR MIT) | ||
| //---------------------------------------------------------------------------// | ||
| //! \file celeritas/optical/detector/DetectorAction.hh | ||
| //---------------------------------------------------------------------------// | ||
| #pragma once | ||
|
|
||
| #include <algorithm> | ||
|
|
||
| #include "celeritas/optical/CoreParams.hh" | ||
| #include "celeritas/optical/CoreState.hh" | ||
| #include "celeritas/optical/action/ActionInterface.hh" | ||
|
|
||
| #include "DetectorData.hh" | ||
| #include "ScoringParams.hh" | ||
|
|
||
| namespace celeritas | ||
| { | ||
| namespace optical | ||
| { | ||
| //---------------------------------------------------------------------------// | ||
| /*! | ||
| * Record sensitive detector data for optical photons at the end of every step. | ||
| * | ||
| * The \c DetectorExecutor is responsible for copying hit data for every photon | ||
| * into the state buffer at the end of every step on a kernel level. Even if a | ||
| * track was not in a detector, it is still copied into the state buffer with | ||
| * an invalid detector ID. All hits are copied into pinned memory on the host, | ||
| * where invalid hits are erased. A span of only valid hits is then passed into | ||
| * the user provided callback function. | ||
| */ | ||
| class DetectorAction final : public OpticalStepActionInterface, | ||
|
Member
There was a problem hiding this comment. I think to be consistent these should all be ScoringAction/Data/Executor... we might want to defer renaming to a different PR though, or at least lay out what the I was also confused initially because DetectorAction is just an implementation detail of ScoringParams, and the creation of those is what does all the work (kind of like the optical offload). The action/executor definitely need to be in a detail namespace.
Contributor
Author
There was a problem hiding this comment. Looking back on it, I think scoring is a bad name cause that is usually used for the simpler tallying of things like energy deposits. Maybe a DetectorHitParams or UserDetectorParams is better for indicating that it's meant to deal with the actual hits and callbacks?
Member
There was a problem hiding this comment. Don't think too hard about it; we could easily end up in a hell of combining detector, sensitive, hit, callback, user, score, tally, ... I think "sensitive detector" is a special case of a "scoring region": the scoring region is specifically a set of logical volumes, and the scoring action is a general "callback" capability that gets the entire step. An arguably scoring regions are just a specialization of a "user stepping action"... |
||
| public StaticConcreteAction | ||
| { | ||
| public: | ||
| // Construct with ID | ||
| explicit DetectorAction(ActionId); | ||
|
|
||
| // Launch kernel with host data | ||
| void step(CoreParams const&, CoreStateHost&) const final; | ||
|
|
||
| // Launch kernel with device data | ||
| void step(CoreParams const&, CoreStateDevice&) const final; | ||
|
|
||
| //! Dependency ordering of the action | ||
| StepActionOrder order() const final { return StepActionOrder::post; } | ||
|
|
||
| private: | ||
| //!@{ | ||
| //! Process hits copied from the kernels and send them to the callback | ||
| void process_hits(CoreParams const&, CoreStateHost&) const; | ||
| void process_hits(CoreParams const&, CoreStateDevice&) const; | ||
|
|
||
| template<MemSpace M> | ||
| void process_hits_impl(CoreParams const&, CoreState<M>&) const; | ||
| //!@} | ||
| }; | ||
|
|
||
| //---------------------------------------------------------------------------// | ||
| } // namespace optical | ||
| } // namespace celeritas | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is confusing...