Back to home page

EIC code displayed by LXR

 
 

    


File indexing completed on 2025-01-18 09:10:54

0001 // This file is part of the ACTS project.
0002 //
0003 // Copyright (C) 2016 CERN for the benefit of the ACTS project
0004 //
0005 // This Source Code Form is subject to the terms of the Mozilla Public
0006 // License, v. 2.0. If a copy of the MPL was not distributed with this
0007 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
0008 
0009 #pragma once
0010 
0011 #include "Acts/EventData/TrackParameters.hpp"
0012 #include "Acts/Geometry/GeometryContext.hpp"
0013 #include "Acts/MagneticField/MagneticFieldContext.hpp"
0014 #include "Acts/Material/interface/IAssignmentFinder.hpp"
0015 #include "Acts/Propagator/ActorList.hpp"
0016 #include "Acts/Propagator/Propagator.hpp"
0017 #include "Acts/Propagator/SurfaceCollector.hpp"
0018 #include "Acts/Surfaces/Surface.hpp"
0019 #include "Acts/Utilities/Logger.hpp"
0020 #include "Acts/Utilities/VectorHelpers.hpp"
0021 
0022 #include <utility>
0023 #include <vector>
0024 
0025 namespace Acts {
0026 
0027 /// @brief selector for finding surface
0028 ///
0029 /// This is to be used with a SurfaceCollector<>
0030 struct MaterialSurfaceIdentifier {
0031   /// check if the surface has material
0032   bool operator()(const Surface& sf) const {
0033     return (sf.surfaceMaterial() != nullptr);
0034   }
0035 };
0036 
0037 /// An Interaction volume collector with unique counting
0038 struct InteractionVolumeCollector {
0039   /// Simple result struct that holds the collected volumes
0040   ///
0041   /// @note the map is to avoid double counting as this is
0042   /// called in an action list
0043   struct this_result {
0044     std::map<GeometryIdentifier, IAssignmentFinder::VolumeAssignment> collected;
0045   };
0046 
0047   using result_type = this_result;
0048 
0049   /// Collector action for the ActionList of the Propagator
0050   /// It checks if the propagator state has a current volume,
0051   /// in which case the action is performed:
0052   /// - it records the volume given the configuration
0053   ///
0054   /// @tparam propagator_state_t is the type of Propagator state
0055   /// @tparam stepper_t Type of the stepper used for the propagation
0056   /// @tparam navigator_t Type of the navigator used for the propagation
0057   ///
0058   /// @param [in,out] state is the mutable stepper state object
0059   /// @param [in] stepper The stepper in use
0060   /// @param [in] navigator The navigator in use
0061   /// @param [in,out] result is the mutable result object
0062   template <typename propagator_state_t, typename stepper_t,
0063             typename navigator_t>
0064   void act(propagator_state_t& state, const stepper_t& stepper,
0065            const navigator_t& navigator, result_type& result,
0066            const Logger& /*logger*/) const {
0067     // Retrieve the current volume
0068     auto currentVolume = navigator.currentVolume(state.navigation);
0069 
0070     // The current volume has been assigned by the navigator
0071     if (currentVolume != nullptr) {
0072       auto collIt = result.collected.find(currentVolume->geometryId());
0073       // Check if the volume has been collected and if it has material
0074       if (collIt == result.collected.end() &&
0075           currentVolume->volumeMaterial() != nullptr) {
0076         Vector3 entryPosition = stepper.position(state.stepping);
0077         Vector3 exitPosition = entryPosition;
0078         IAssignmentFinder::VolumeAssignment vAssignment{
0079             InteractionVolume(currentVolume), entryPosition, exitPosition};
0080         result.collected.emplace(currentVolume->geometryId(), vAssignment);
0081       } else if (collIt != result.collected.end()) {
0082         // Update the exit position
0083         (collIt->second).exit = stepper.position(state.stepping);
0084       }
0085     }
0086   }
0087 };
0088 
0089 /// @class PropagatorMaterialAssigner
0090 ///
0091 /// A Propagator based material assigner that uses the navigation and
0092 /// transport of the propagator to assign the material to the surface
0093 /// or the volume.
0094 ///
0095 /// @note eventual navigation problems would affect he material mapping
0096 template <typename propagator_t>
0097 class PropagatorMaterialAssigner final : public IAssignmentFinder {
0098  public:
0099   /// @brief  Construct with propagator
0100   /// @param propagator
0101   PropagatorMaterialAssigner(propagator_t propagator)
0102       : m_propagator(std::move(propagator)) {}
0103 
0104   /// @brief Method for generating assignment candidates for the
0105   /// material interaction assignment to surfaces or volumes
0106   ///
0107   /// @param gctx is the geometry context
0108   /// @param mctx is the magnetic field context
0109   /// @param position is the position of the initial ray
0110   /// @param direction is the direction of initial ray
0111   ///
0112   /// @return a vector of Surface Assignments and Volume Assignments
0113   std::pair<std::vector<IAssignmentFinder::SurfaceAssignment>,
0114             std::vector<IAssignmentFinder::VolumeAssignment>>
0115   assignmentCandidates(const GeometryContext& gctx,
0116                        const MagneticFieldContext& mctx,
0117                        const Vector3& position,
0118                        const Vector3& direction) const final {
0119     // Return container
0120     std::pair<std::vector<IAssignmentFinder::SurfaceAssignment>,
0121               std::vector<IAssignmentFinder::VolumeAssignment>>
0122         candidates;
0123 
0124     using VectorHelpers::makeVector4;
0125     // Neutral curvilinear parameters
0126     NeutralCurvilinearTrackParameters start(
0127         makeVector4(position, 0), direction, 1, std::nullopt,
0128         NeutralParticleHypothesis::geantino());
0129 
0130     // Prepare Action list and abort list
0131     using MaterialSurfaceCollector =
0132         SurfaceCollector<MaterialSurfaceIdentifier>;
0133     using ActorList = ActorList<MaterialSurfaceCollector,
0134                                 InteractionVolumeCollector, EndOfWorldReached>;
0135     using PropagatorOptions =
0136         typename propagator_t::template Options<ActorList>;
0137 
0138     PropagatorOptions options(gctx, mctx);
0139 
0140     const auto& result = m_propagator.propagate(start, options).value();
0141 
0142     // The surface collection results
0143     auto scResult =
0144         result.template get<MaterialSurfaceCollector::result_type>();
0145     auto mappingSurfaces = scResult.collected;
0146 
0147     for (auto& mSurface : mappingSurfaces) {
0148       candidates.first.push_back(IAssignmentFinder::SurfaceAssignment{
0149           mSurface.surface, mSurface.position, direction});
0150     }
0151 
0152     // The volume collection results
0153     auto vcResult =
0154         result.template get<InteractionVolumeCollector::result_type>();
0155     for (const auto& [geoId, vIntersection] : vcResult.collected) {
0156       candidates.second.push_back(vIntersection);
0157     }
0158 
0159     // Return the candidates
0160     return candidates;
0161   }
0162 
0163  private:
0164   propagator_t m_propagator;
0165 };
0166 
0167 }  // namespace Acts