Acts/Material/GridSurfaceMaterialFactory.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/Material/GridSurfaceMaterial.hpp"
0012 #include "Acts/Material/MaterialSlab.hpp"
0013 #include "Acts/Utilities/GridAccessHelpers.hpp"
0014 #include "Acts/Utilities/ProtoAxis.hpp"
0015
0016 #include <memory>
0017 #include <vector>
0018
0019 namespace Acts::GridSurfaceMaterialFactory {
0020
0021 /// Create and fill from a single proto axis
0022 ///
0023 /// @param pAxis the type of the ProtoAxis
0024 /// @param materialAccessor the material accessor
0025 /// @param boundToGridLocal the delegate from bound to grid local frame
0026 /// @param globalToGridLocal the delegate from global into grid local frame
0027 /// @param payload the grid payload (material slab / indices)
0028 ///
0029 /// @return a unique pointer to the surface material
0030 template <typename material_accessor_t>
0031 std::unique_ptr<
0032     IGridSurfaceMaterial<typename material_accessor_t::grid_value_type>>
0033 create1D(
0034     const ProtoAxis& pAxis, material_accessor_t&& materialAccessor,
0035     GridAccess::BoundToGridLocal1DimDelegate boundToGridLocal,
0036     GridAccess::GlobalToGridLocal1DimDelegate globalToGridLocal,
0037     const std::vector<typename material_accessor_t::grid_value_type>& payload) {
0038   // Visit the axis type and create the grid surface material
0039   auto ism = pAxis.getAxis().visit(
0040       [&]<typename AxisType>(const AxisType& axis)
0041           -> std::unique_ptr<IGridSurfaceMaterial<
0042               typename material_accessor_t::grid_value_type>> {
0043         using GridType =
0044             Grid<typename material_accessor_t::grid_value_type, AxisType>;
0045         return std::make_unique<
0046             GridSurfaceMaterialT<GridType, material_accessor_t>>(
0047             GridType(axis), std::forward<material_accessor_t>(materialAccessor),
0048             std::move(boundToGridLocal), std::move(globalToGridLocal));
0049       });
0050   // Fill it via the grid view
0051   AnyGridView<typename material_accessor_t::grid_value_type> gv =
0052       ism->gridView();
0053   auto indices = gv.numLocalBins();
0054   for (std::size_t i0 = 0; i0 < indices[0]; ++i0) {
0055     // Offset comes from overflow/underflow bin
0056     gv.atLocalBins({i0 + 1u}) = payload[i0];
0057   }
0058   return ism;
0059 }
0060
0061 /// Static creation method for the with ProtoAxis objects
0062 ///
0063 /// @param pAxis0 proto axis in direction 0
0064 /// @param pAxis1 proto axis in direction 1
0065 /// @param materialAccessor the material accessor
0066 /// @param boundToGridLocal the delegate from bound to grid local frame
0067 /// @param globalToGridLocal the delegate from global into grid local frame
0068 /// @param payload the grid payload in 2D (material slab / indices)
0069 /// the payload has to be column major, i.e. [i0][i1]
0070 ///
0071 /// @return a unique pointer to the surface material
0072 template <typename material_accessor_t>
0073 std::unique_ptr<
0074     IGridSurfaceMaterial<typename material_accessor_t::grid_value_type>>
0075 create2D(
0076     const ProtoAxis& pAxis0, const ProtoAxis& pAxis1,
0077     material_accessor_t&& materialAccessor,
0078     GridAccess::BoundToGridLocal2DimDelegate boundToGridLocal,
0079     GridAccess::GlobalToGridLocal2DimDelegate globalToGridLocal,
0080     const std::vector<
0081         std::vector<typename material_accessor_t::grid_value_type>>& payload) {
0082   // Validate axis compatibility
0083   if (pAxis0.getAxisDirection() == pAxis1.getAxisDirection()) {
0084     throw std::invalid_argument(
0085         "createGridSurfaceMaterial: ProtoAxes must have different directions");
0086   }
0087   auto ism = pAxis0.getAxis().visit(
0088       [&]<typename AxisTypeA>(const AxisTypeA& axisA)
0089           -> std::unique_ptr<IGridSurfaceMaterial<
0090               typename material_accessor_t::grid_value_type>> {
0091         return pAxis1.getAxis().visit(
0092             [&]<typename AxisTypeB>(const AxisTypeB& axisB)
0093                 -> std::unique_ptr<IGridSurfaceMaterial<
0094                     typename material_accessor_t::grid_value_type>> {
0095               using GridType =
0096                   Grid<typename material_accessor_t::grid_value_type, AxisTypeA,
0097                        AxisTypeB>;
0098               return std::make_unique<
0099                   GridSurfaceMaterialT<GridType, material_accessor_t>>(
0100                   GridType(axisA, axisB),
0101                   std::forward<material_accessor_t>(materialAccessor),
0102                   std::move(boundToGridLocal), std::move(globalToGridLocal));
0103             });
0104       });
0105
0106   // Fill it via the grid view
0107   AnyGridView<typename material_accessor_t::grid_value_type> gv =
0108       ism->gridView();
0109   auto indices = gv.numLocalBins();
0110   for (std::size_t i0 = 0; i0 < indices[0]; ++i0) {
0111     for (std::size_t i1 = 0; i1 < indices[1]; ++i1) {
0112       // Offset comes from overflow/underflow bin
0113       gv.atLocalBins({i0 + 1, i1 + 1}) = payload[i0][i1];
0114     }
0115   }
0116
0117   return ism;
0118 }
0119
0120 /// The resolved functions to reduce compile time template bloat
0121 ///  - GridMaterial 1D
0122 /// @param pAxis the proto axis
0123 /// @param materialAccessor the material accessor
0124 /// @param boundToGridLocal the delegate from bound to grid local frame
0125 /// @param globalToGridLocal the delegate from global into grid local frame
0126 /// @param payload the grid payload (material slab / indices)
0127 std::unique_ptr<IGridSurfaceMaterial<MaterialSlab>> create(
0128     const ProtoAxis& pAxis, GridMaterialAccessor&& materialAccessor,
0129     GridAccess::BoundToGridLocal1DimDelegate boundToGridLocal,
0130     GridAccess::GlobalToGridLocal1DimDelegate globalToGridLocal,
0131     const std::vector<MaterialSlab>& payload);
0132
0133 /// The resolved functions to reduce compile time template bloat
0134 /// - IndexedMaterial 1D
0135 /// @param pAxis the proto axis
0136 /// @param materialAccessor the material accessor
0137 /// @param boundToGridLocal the delegate from bound to grid local frame
0138 /// @param globalToGridLocal the delegate from global into grid local frame
0139 /// @param payload the grid payload (material slab / indices)
0140 std::unique_ptr<IGridSurfaceMaterial<IndexedMaterialAccessor::grid_value_type>>
0141 create(const ProtoAxis& pAxis, IndexedMaterialAccessor&& materialAccessor,
0142        GridAccess::BoundToGridLocal1DimDelegate boundToGridLocal,
0143        GridAccess::GlobalToGridLocal1DimDelegate globalToGridLocal,
0144        const std::vector<IndexedMaterialAccessor::grid_value_type>& payload);
0145
0146 /// The resolved functions to reduce compile time template bloat
0147 /// - GloballyIndexedMaterial 1D
0148 /// @param pAxis the proto axis
0149 /// @param materialAccessor the material accessor
0150 /// @param boundToGridLocal the delegate from bound to grid local frame
0151 /// @param globalToGridLocal the delegate from global into grid local frame
0152 /// @param payload the grid payload (material slab / indices)
0153 std::unique_ptr<
0154     IGridSurfaceMaterial<GloballyIndexedMaterialAccessor::grid_value_type>>
0155 create(const ProtoAxis& pAxis,
0156        GloballyIndexedMaterialAccessor&& materialAccessor,
0157        GridAccess::BoundToGridLocal1DimDelegate boundToGridLocal,
0158        GridAccess::GlobalToGridLocal1DimDelegate globalToGridLocal,
0159        const std::vector<GloballyIndexedMaterialAccessor::grid_value_type>&
0160            payload);
0161
0162 /// The resolved functions to reduce compile time template bloat
0163 /// - GridMaterial 2D
0164 /// @param pAxis0 the proto axis in direction 0
0165 /// @param pAxis1 the proto axis in direction 1
0166 /// @param materialAccessor the material accessor
0167 /// @param boundToGridLocal the delegate from bound to grid local frame
0168 /// @param globalToGridLocal the delegate from global into grid local frame
0169 /// @param payload the grid payload (material slab / indices)
0170 std::unique_ptr<IGridSurfaceMaterial<MaterialSlab>> create(
0171     const ProtoAxis& pAxis0, const ProtoAxis& pAxis1,
0172     GridMaterialAccessor&& materialAccessor,
0173     GridAccess::BoundToGridLocal2DimDelegate boundToGridLocal,
0174     GridAccess::GlobalToGridLocal2DimDelegate globalToGridLocal,
0175     const std::vector<std::vector<MaterialSlab>>& payload);
0176
0177 /// The resolved functions to reduce compile time template bloat
0178 /// - IndexedMaterial 2D
0179 /// @param pAxis0 the proto axis in direction 0
0180 /// @param pAxis1 the proto axis in direction 1
0181 /// @param materialAccessor the material accessor
0182 /// @param boundToGridLocal the delegate from bound to grid local frame
0183 /// @param globalToGridLocal the delegate from global into grid local frame
0184 /// @param payload the grid payload (material slab / indices)
0185 std::unique_ptr<IGridSurfaceMaterial<IndexedMaterialAccessor::grid_value_type>>
0186 create(const ProtoAxis& pAxis0, const ProtoAxis& pAxis1,
0187        IndexedMaterialAccessor&& materialAccessor,
0188        GridAccess::BoundToGridLocal2DimDelegate boundToGridLocal,
0189        GridAccess::GlobalToGridLocal2DimDelegate globalToGridLocal,
0190        const std::vector<std::vector<IndexedMaterialAccessor::grid_value_type>>&
0191            payload);
0192
0193 /// The resolved functions to reduce compile time template bloat
0194 /// - GloballyIndexedMaterial 2D
0195 /// @param pAxis0 the proto axis in direction 0
0196 /// @param pAxis1 the proto axis in direction 1
0197 /// @param materialAccessor the material accessor
0198 /// @param boundToGridLocal the delegate from bound to grid local frame
0199 /// @param globalToGridLocal the delegate from global into grid local frame
0200 /// @param payload the grid payload (material slab / indices)
0201 std::unique_ptr<
0202     IGridSurfaceMaterial<GloballyIndexedMaterialAccessor::grid_value_type>>
0203 create(const ProtoAxis& pAxis0, const ProtoAxis& pAxis1,
0204        GloballyIndexedMaterialAccessor&& materialAccessor,
0205        GridAccess::BoundToGridLocal2DimDelegate boundToGridLocal,
0206        GridAccess::GlobalToGridLocal2DimDelegate globalToGridLocal,
0207        const std::vector<
0208            std::vector<GloballyIndexedMaterialAccessor::grid_value_type>>&
0209            payload);
0210 }  // namespace Acts::GridSurfaceMaterialFactory