CylinderVolumeHelper.hpp

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

// This file is part of the Acts project.
//
// Copyright (C) 2016-2020 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/Geometry/BoundarySurfaceFace.hpp"
#include "Acts/Geometry/GeometryContext.hpp"
#include "Acts/Geometry/ITrackingVolumeHelper.hpp"
#include "Acts/Utilities/BinningType.hpp"
#include "Acts/Utilities/Logger.hpp"

#include <iosfwd>
#include <memory>
#include <string>
#include <vector>

namespace Acts {

class Layer;
class TrackingVolume;
class VolumeBounds;
class CylinderVolumeBounds;
class IVolumeMaterial;
class ILayerArrayCreator;
class ITrackingVolumeArrayCreator;

class CylinderVolumeHelper : public ITrackingVolumeHelper {
 public:
  struct Config {
    std::shared_ptr<const ILayerArrayCreator> layerArrayCreator = nullptr;
    std::shared_ptr<const ITrackingVolumeArrayCreator>
        trackingVolumeArrayCreator = nullptr;
    double passiveLayerThickness = 1;
    int passiveLayerPhiBins = 1;
    int passiveLayerRzBins = 100;
  };

  CylinderVolumeHelper(const Config& cvhConfig,
                       std::unique_ptr<const Logger> logger = getDefaultLogger(
                           "CylinderVolumeHelper", Logging::INFO));

  ~CylinderVolumeHelper() override = default;

  MutableTrackingVolumePtr createTrackingVolume(
      const GeometryContext& gctx, const LayerVector& layers,
      std::shared_ptr<const IVolumeMaterial> volumeMaterial,
      VolumeBoundsPtr volumeBounds, MutableTrackingVolumeVector mtvVector = {},
      const Transform3& transform = Transform3::Identity(),
      const std::string& volumeName = "UndefinedVolume",
      BinningType bType = arbitrary) const override;

  MutableTrackingVolumePtr createTrackingVolume(
      const GeometryContext& gctx, const LayerVector& layers,
      MutableTrackingVolumeVector mtvVector,
      std::shared_ptr<const IVolumeMaterial> volumeMaterial, double rMin,
      double rMax, double zMin, double zMax,
      const std::string& volumeName = "UndefinedVolume",
      BinningType bType = arbitrary) const override;

  MutableTrackingVolumePtr createGapTrackingVolume(
      const GeometryContext& gctx, MutableTrackingVolumeVector& mtvVector,
      std::shared_ptr<const IVolumeMaterial> volumeMaterial, double rMin,
      double rMax, double zMin, double zMax, unsigned int materialLayers,
      bool cylinder = true,
      const std::string& volumeName = "UndefinedVolume") const override;

  MutableTrackingVolumePtr createGapTrackingVolume(
      const GeometryContext& gctx, MutableTrackingVolumeVector& mtvVector,
      std::shared_ptr<const IVolumeMaterial> volumeMaterial, double rMin,
      double rMax, double zMin, double zMax,
      const std::vector<double>& layerPositions, bool cylinder = true,
      const std::string& volumeName = "UndefinedVolume",
      BinningType bType = arbitrary) const override;

  MutableTrackingVolumePtr createContainerTrackingVolume(
      const GeometryContext& gctx,
      const TrackingVolumeVector& volumes) const override;

  void setConfiguration(const Config& cvhConfig);

  Config getConfiguration() const;

  void setLogger(std::unique_ptr<const Logger> newLogger);

 protected:
  Config m_cfg;

 private:
  const Logger& logger() const { return *m_logger; }

  std::unique_ptr<const Logger> m_logger;

  bool estimateAndCheckDimension(
      const GeometryContext& gctx, const LayerVector& layers,
      const CylinderVolumeBounds*& cylinderVolumeBounds,
      const Transform3& transform, double& rMinClean, double& rMaxClean,
      double& zMinClean, double& zMaxClean, BinningValue& bValue,
      BinningType bType = arbitrary) const;

  bool interGlueTrackingVolume(const GeometryContext& gctx,
                               const MutableTrackingVolumePtr& tVolume,
                               bool rBinned, double rMin, double rGlueMin,
                               double rMax, double zMin, double zMax) const;

  void glueTrackingVolumes(const GeometryContext& gctx,
                           const MutableTrackingVolumePtr& tvolOne,
                           BoundarySurfaceFace faceOne,
                           const MutableTrackingVolumePtr& tvolTwo,
                           BoundarySurfaceFace faceTwo, double rMin,
                           double rGlueMin, double rMax, double zMin,
                           double zMax) const;

  void addFaceVolumes(const MutableTrackingVolumePtr& tvol,
                      BoundarySurfaceFace glueFace,
                      TrackingVolumeVector& vols) const;

  LayerPtr createCylinderLayer(double z, double r, double halflengthZ,
                               double thickness, int binsPhi, int binsZ) const;

  LayerPtr createDiscLayer(double z, double rMin, double rMax, double thickness,
                           int binsPhi, int binsR) const;
};

inline CylinderVolumeHelper::Config CylinderVolumeHelper::getConfiguration()
    const {
  return m_cfg;
}
}  // namespace Acts