Acts/Geometry/CuboidPortalShell.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/Geometry/CuboidVolumeBounds.hpp"
0013 #include "Acts/Geometry/PortalShell.hpp"
0014 #include "Acts/Geometry/TrackingVolume.hpp"
0015 #include "Acts/Utilities/AxisDefinitions.hpp"
0016 #include "Acts/Utilities/Logger.hpp"
0017
0018 #include <array>
0019 #include <memory>
0020 #include <vector>
0021
0022 namespace Acts {
0023
0024 /// @class CuboidPortalShell
0025 /// Base class for cuboid shaped portal shells, e.g. shells for cuboid
0026 /// volumes
0027 class CuboidPortalShell : public PortalShellBase {
0028  public:
0029   using Face = CuboidVolumeBounds::Face;
0030
0031   /// Retrieve the portal associated to the given face. Can be nullptr if unset.
0032   /// @param face The face to retrieve the portal for
0033   /// @return The portal associated to the face
0034   virtual Portal* portal(Face face) = 0;
0035
0036   /// Retrieve a shared_ptr for the portal associated to the given face. Can be
0037   /// nullptr if unset.
0038   /// @param face The face to retrieve the portal for
0039   /// @return The portal associated to the face
0040   virtual std::shared_ptr<Portal> portalPtr(Face face) = 0;
0041
0042   /// Set the portal associated to the given face.
0043   /// @param portal The portal to set
0044   /// @param face The face to set the portal
0045   virtual void setPortal(std::shared_ptr<Portal> portal, Face face) = 0;
0046
0047   /// @copydoc PortalShellBase::fill
0048   void fill(TrackingVolume& volume) override;
0049
0050   virtual const Transform3& transform() const = 0;
0051 };
0052
0053 /// Output stream operator for the CuboidPortalShell::Face enum
0054 /// @param os The output stream
0055 /// @param face The face to output
0056 /// @return The output stream
0057 std::ostream& operator<<(std::ostream& os, CuboidPortalShell::Face face);
0058
0059 /// @class SingleCuboidPortalShell
0060 /// This class describes a cuboid shell containing a single volume.
0061 class SingleCuboidPortalShell : public CuboidPortalShell {
0062  public:
0063   /// Construct a single cuboid portal shell for the given volume
0064   /// @param volume The volume to create the shell for
0065   explicit SingleCuboidPortalShell(TrackingVolume& volume);
0066
0067   /// @copydoc PortalShellBase::size
0068   std::size_t size() const final;
0069
0070   /// @copydoc CuboidPortalShell::portal
0071   Portal* portal(Face face) final;
0072
0073   /// @copydoc CuboidPortalShell::portalPtr
0074   std::shared_ptr<Portal> portalPtr(Face face) final;
0075
0076   /// @copydoc CuboidPortalShell::setPortal
0077   void setPortal(std::shared_ptr<Portal> portal, Face face) final;
0078
0079   /// @copydoc PortalShellBase::applyToVolume
0080   void applyToVolume() override;
0081
0082   /// @copydoc PortalShellBase::isValid
0083   bool isValid() const override;
0084
0085   /// @copydoc PortalShellBase::label
0086   std::string label() const override;
0087
0088   const Transform3& transform() const override {
0089     return m_volume->transform();
0090   };
0091
0092  private:
0093   std::array<std::shared_ptr<Portal>, 6> m_portals{};
0094
0095   TrackingVolume* m_volume;
0096 };
0097
0098 /// @class CuboidStackPortalShell
0099 /// This class describes a cuboid shell containing multiple volumes.
0100 class CuboidStackPortalShell final : public CuboidPortalShell {
0101  public:
0102   /// Construct the portal shell stack from the given shells
0103   /// @param gctx The geometry context
0104   /// @param shells The shells to stack
0105   /// @note The shells must be ordered in the given direction
0106   /// @param direction The stacking direction (along x/y/z axis) in local stack coordinates
0107   /// @param logger A logging instance for debugging
0108   CuboidStackPortalShell(const GeometryContext& gctx,
0109                          std::vector<CuboidPortalShell*> shells,
0110                          AxisDirection direction,
0111                          const Logger& logger = getDummyLogger());
0112
0113   /// @copydoc PortalShellBase::size
0114   std::size_t size() const override;
0115
0116   /// @copydoc CuboidPortalShell::portal
0117   Portal* portal(Face face) override;
0118
0119   /// @copydoc CuboidPortalShell::portalPtr
0120   std::shared_ptr<Portal> portalPtr(Face face) override;
0121
0122   /// @copydoc CuboidPortalShell::setPortal
0123   void setPortal(std::shared_ptr<Portal> portal, Face face) override;
0124
0125   void applyToVolume() override {
0126     // No-op, because it's a composite portal shell
0127   }
0128
0129   /// @copydoc PortalShellBase::isValid
0130   bool isValid() const override;
0131
0132   /// @copydoc PortalShellBase::label
0133   std::string label() const override;
0134
0135   /// Return the stack's group transform
0136   const Transform3& transform() const override;
0137
0138  private:
0139   /// Shell stacking direction in local stack coordinates
0140   AxisDirection m_direction;
0141
0142   /// The cuboid face positioned first along the stacking direction
0143   CuboidVolumeBounds::Face m_frontFace = Face::NegativeXFace;
0144   /// The cuboid face positioned last along the stacking direction
0145   CuboidVolumeBounds::Face m_backFace = Face::PositiveXFace;
0146   /// The cuboid faces parallel to the stacking direction
0147   std::array<CuboidVolumeBounds::Face, 4> m_sideFaces{
0148       Face::NegativeZFace, Face::PositiveZFace, Face::NegativeYFace,
0149       Face::PositiveYFace};
0150
0151   std::vector<CuboidPortalShell*> m_shells;
0152 };
0153
0154 }  // namespace Acts