Acts/Material/ProtoSurfaceMaterial.hpp

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/Definitions/Algebra.hpp"
0012 #include "Acts/Material/ISurfaceMaterial.hpp"
0013 #include "Acts/Material/MaterialSlab.hpp"
0014 #include "Acts/Utilities/BinUtility.hpp"
0015 #include "Acts/Utilities/ProtoAxis.hpp"
0016
0017 #include <iosfwd>
0018 #include <vector>
0019
0020 namespace Acts {
0021
0022 /// @class ProtoSurfaceMaterial
0023 ///
0024 /// @brief proxy to SurfaceMaterial hand over BinUtility or other suitable
0025 /// binning description
0026 ///
0027 /// The ProtoSurfaceMaterial class acts as a proxy to the SurfaceMaterial
0028 /// to mark the layers and surfaces on which the material should be mapped on
0029 /// at construction time of the geometry and to hand over the granularity of
0030 /// of the material map with the bin Utility.
0031 template <typename BinningType>
0032 class ProtoSurfaceMaterialT : public ISurfaceMaterial {
0033  public:
0034   /// Constructor without binningType - homogeneous material
0035   ProtoSurfaceMaterialT() = default;
0036
0037   /// Constructor with BinningType
0038   /// @param binning a binning description for the material map binning
0039   /// @param mappingType is the type of surface mapping associated to the surface
0040   explicit ProtoSurfaceMaterialT(const BinningType& binning,
0041                                  MappingType mappingType = MappingType::Default)
0042       : ISurfaceMaterial(1., mappingType), m_binning(binning) {}
0043
0044   /// Copy constructor
0045   ///
0046   /// @param smproxy The source proxy
0047   ProtoSurfaceMaterialT(const ProtoSurfaceMaterialT<BinningType>& smproxy) =
0048       default;
0049
0050   /// Copy move constructor
0051   ///
0052   /// @param smproxy The source proxy
0053   ProtoSurfaceMaterialT(ProtoSurfaceMaterialT<BinningType>&& smproxy) noexcept =
0054       default;
0055
0056   /// Destructor
0057   ~ProtoSurfaceMaterialT() override = default;
0058
0059   /// Assignment operator
0060   ///
0061   /// @param smproxy The source proxy
0062   ProtoSurfaceMaterialT<BinningType>& operator=(
0063       const ProtoSurfaceMaterialT<BinningType>& smproxy) = default;
0064
0065   /// Assignment move operator
0066   ///
0067   /// @param smproxy The source proxy
0068   ProtoSurfaceMaterialT<BinningType>& operator=(
0069       ProtoSurfaceMaterialT<BinningType>&& smproxy) noexcept = default;
0070
0071   /// Scale operation - dummy implementation
0072   ///
0073   ProtoSurfaceMaterialT<BinningType>& scale(double /*factor*/) final {
0074     return (*this);
0075   }
0076
0077   /// Return the BinUtility
0078   const BinningType& binning() const { return (m_binning); }
0079
0080   /// Return method for full material description of the Surface - from local
0081   /// coordinates
0082   ///
0083   /// @return will return dummy material
0084   const MaterialSlab& materialSlab(const Vector2& /*lp*/) const final {
0085     return (m_materialSlab);
0086   }
0087
0088   /// Return method for full material description of the Surface - from the
0089   /// global coordinates
0090   ///
0091   /// @return will return dummy material
0092   const MaterialSlab& materialSlab(const Vector3& /*gp*/) const final {
0093     return (m_materialSlab);
0094   }
0095
0096   /// Output Method for std::ostream, to be overloaded by child classes
0097   ///
0098   /// @param sl is the output stream
0099   std::ostream& toStream(std::ostream& sl) const final {
0100     sl << "Acts::ProtoSurfaceMaterial : " << std::endl;
0101     sl << m_binning << std::endl;
0102     return sl;
0103   }
0104
0105  private:
0106   /// A binning description
0107   BinningType m_binning;
0108
0109   /// Dummy material properties
0110   MaterialSlab m_materialSlab = MaterialSlab::Nothing();
0111 };
0112
0113 /// @brief Type alias for a prototype surface material using BinUtility
0114 /// @details A surface material implementation that uses BinUtility for binning
0115 using ProtoSurfaceMaterial = ProtoSurfaceMaterialT<Acts::BinUtility>;
0116
0117 /// @brief Type alias for a prototype surface material using a grid of ProtoAxis
0118 /// @details A surface material implementation that uses a vector of ProtoAxis for grid-based binning
0119 using ProtoGridSurfaceMaterial =
0120     ProtoSurfaceMaterialT<std::vector<DirectedProtoAxis>>;
0121
0122 }  // namespace Acts