Portal.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file Portal.hpp

// This file is part of the Acts project.
//
// Copyright (C) 2022 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#pragma once

#include "Acts/Definitions/Algebra.hpp"
#include "Acts/Definitions/Direction.hpp"
#include "Acts/Geometry/GeometryContext.hpp"
#include "Acts/Geometry/GeometryIdentifier.hpp"
#include "Acts/Navigation/NavigationDelegates.hpp"
#include "Acts/Navigation/NavigationState.hpp"
#include "Acts/Surfaces/BoundaryCheck.hpp"
#include "Acts/Surfaces/Surface.hpp"

#include <array>
#include <map>
#include <memory>
#include <optional>
#include <vector>

namespace Acts {

class ISurfaceMaterial;
class Surface;

namespace Experimental {
class DetectorVolume;
struct NavigationState;

class Portal : public std::enable_shared_from_this<Portal> {
 protected:
  Portal(std::shared_ptr<Surface> surface);

 public:
  using DetectorVolumeUpdators = std::array<DetectorVolumeUpdator, 2u>;

  using AttachedDetectorVolumes =
      std::array<std::vector<std::shared_ptr<DetectorVolume>>, 2u>;

  friend class DetectorVolume;

  static std::shared_ptr<Portal> makeShared(std::shared_ptr<Surface> surface);

  std::shared_ptr<Portal> getSharedPtr();

  std::shared_ptr<const Portal> getSharedPtr() const;

  Portal() = delete;
  virtual ~Portal() = default;

  const Surface& surface() const;

  Surface& surface();

  void updateDetectorVolume(const GeometryContext& gctx,
                            NavigationState& nState) const noexcept(false);

  void assignGeometryId(const GeometryIdentifier& geometryId);

  void fuse(std::shared_ptr<Portal>& other) noexcept(false);

  void assignDetectorVolumeUpdator(
      Direction dir, DetectorVolumeUpdator dVolumeUpdator,
      std::vector<std::shared_ptr<DetectorVolume>> attachedVolumes);

  void assignDetectorVolumeUpdator(DetectorVolumeUpdator dVolumeUpdator,
                                   std::vector<std::shared_ptr<DetectorVolume>>
                                       attachedVolumes) noexcept(false);

  // Access to the portal targets: opposite/along normal vector
  const DetectorVolumeUpdators& detectorVolumeUpdators() const;

  // Access to the attached volumes - non-const access
  AttachedDetectorVolumes& attachedDetectorVolumes();

 private:
  std::shared_ptr<Surface> m_surface;

  DetectorVolumeUpdators m_volumeUpdators = {unconnectedUpdator(),
                                             unconnectedUpdator()};

  AttachedDetectorVolumes m_attachedVolumes;
};

}  // namespace Experimental
}  // namespace Acts