CylinderVolumeBuilder.cpp

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

// 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/.

#include "Acts/Geometry/CylinderVolumeBuilder.hpp"

#include "Acts/Geometry/BoundarySurfaceFace.hpp"
#include "Acts/Geometry/CylinderLayer.hpp"
#include "Acts/Geometry/CylinderVolumeBounds.hpp"
#include "Acts/Geometry/DiscLayer.hpp"
#include "Acts/Geometry/ITrackingVolumeHelper.hpp"
#include "Acts/Geometry/TrackingVolume.hpp"
#include "Acts/Surfaces/CylinderBounds.hpp"
#include "Acts/Surfaces/RadialBounds.hpp"
#include "Acts/Utilities/Definitions.hpp"

#include <algorithm>
#include <vector>

Acts::CylinderVolumeBuilder::CylinderVolumeBuilder(
    const Acts::CylinderVolumeBuilder::Config& cvbConfig,
    std::unique_ptr<const Logger> logger)
    : Acts::ITrackingVolumeBuilder(), m_cfg(), m_logger(std::move(logger)) {
  setConfiguration(cvbConfig);
}

Acts::CylinderVolumeBuilder::~CylinderVolumeBuilder() = default;

void Acts::CylinderVolumeBuilder::setConfiguration(
    const Acts::CylinderVolumeBuilder::Config& cvbConfig) {
  // @todo check consistency
  // copy the configuration
  m_cfg = cvbConfig;
}

void Acts::CylinderVolumeBuilder::setLogger(
    std::unique_ptr<const Logger> newLogger) {
  m_logger = std::move(newLogger);
}

std::shared_ptr<Acts::TrackingVolume>
Acts::CylinderVolumeBuilder::trackingVolume(
    const GeometryContext& gctx, TrackingVolumePtr existingVolume,
    VolumeBoundsPtr externalBounds) const {
  ACTS_DEBUG("Configured to build volume : " << m_cfg.volumeName);
  if (existingVolume) {
    ACTS_DEBUG("- will wrap/enclose : " << existingVolume->volumeName());
  }

  // the return volume
  // -----------------------------------------------------------------------------
  MutableTrackingVolumePtr volume = nullptr;

  // now analyize the layers that are provided
  // -----------------------------------------------------
  LayerVector negativeLayers;
  LayerVector centralLayers;
  LayerVector positiveLayers;

  // the wrapping configuration
  WrappingConfig wConfig;

  // the layers are built by the layer builder
  if (m_cfg.layerBuilder) {
    // the negative Layers
    negativeLayers = m_cfg.layerBuilder->negativeLayers(gctx);
    // the central Layers
    centralLayers = m_cfg.layerBuilder->centralLayers(gctx);
    // the positive Layer
    positiveLayers = m_cfg.layerBuilder->positiveLayers(gctx);
  }

  // Build the confined volumes
  MutableTrackingVolumeVector centralVolumes;
  if (m_cfg.ctVolumeBuilder) {
    centralVolumes = m_cfg.ctVolumeBuilder->centralVolumes();
  }

  // (0) PREP WORK ------------------------------------------------
  //
  // a) volume config of the existing volume
  if (existingVolume) {
    // volume and existing volume
    auto existingBounds = dynamic_cast<const CylinderVolumeBounds*>(
        &existingVolume->volumeBounds());
    // set the inside values
    wConfig.existingVolumeConfig.present = true;
    wConfig.existingVolumeConfig.rMin =
        existingBounds->get(CylinderVolumeBounds::eMinR);
    wConfig.existingVolumeConfig.rMax =
        existingBounds->get(CylinderVolumeBounds::eMaxR);
    wConfig.existingVolumeConfig.zMin =
        existingVolume->center().z() -
        existingBounds->get(CylinderVolumeBounds::eHalfLengthZ);
    wConfig.existingVolumeConfig.zMax =
        existingVolume->center().z() +
        existingBounds->get(CylinderVolumeBounds::eHalfLengthZ);
  }
  //
  // b) outside config
  // the volume config for the Outside
  VolumeConfig externalBoundConfig;
  if (externalBounds) {
    const CylinderVolumeBounds* ocvBounds =
        dynamic_cast<const CylinderVolumeBounds*>(externalBounds.get());
    // the cast to CylinderVolumeBounds needs to be successful
    if (ocvBounds != nullptr) {
      // get values from the out bounds
      wConfig.externalVolumeConfig.present = true;
      wConfig.externalVolumeConfig.rMin =
          ocvBounds->get(CylinderVolumeBounds::eMinR);
      wConfig.externalVolumeConfig.rMax =
          ocvBounds->get(CylinderVolumeBounds::eMaxR);
      wConfig.externalVolumeConfig.zMin =
          -ocvBounds->get(CylinderVolumeBounds::eHalfLengthZ);
      wConfig.externalVolumeConfig.zMax =
          ocvBounds->get(CylinderVolumeBounds::eHalfLengthZ);
    }
  }

  // ---------------------------------------------
  // The Volume Config of the SubVolumes
  // ---------------------------------------------
  // sub volume / layer configuration (subVolumes only build of layers are
  // present)
  // --------------------------------------------------------------------------
  //
  // possbile configurations are (so far only synchronised):
  //
  // | Negative Endcap | Barrel | Positive Endcap | -  all layers present
  //                   | Barrel |                   -  barrel present
  // | Negative Endcap |        | Positive Endcap | - only endcaps present
  //                                                -  no layer present
  // Check if already given through configuration
  //
  // (A) volume configuration
  //

  // Find out with Layer analysis
  // analyze the layers
  wConfig.nVolumeConfig = analyzeContent(gctx, negativeLayers, {});  // TODO
  wConfig.cVolumeConfig = analyzeContent(gctx, centralLayers, centralVolumes);
  wConfig.pVolumeConfig = analyzeContent(gctx, positiveLayers, {});  // TODO

  std::string layerConfiguration = "|";
  if (wConfig.nVolumeConfig) {
    // negative layers are present
    ACTS_VERBOSE("Negative layers are present: rmin, rmax | zmin, zmax = "
                 << wConfig.nVolumeConfig.toString());
    // add to the string output
    layerConfiguration += " Negative Endcap |";
  }
  if (wConfig.cVolumeConfig) {
    // central layers are present
    ACTS_VERBOSE("Central layers are present:  rmin, rmax | zmin, zmax = "
                 << wConfig.cVolumeConfig.toString());
    // add to the string output
    layerConfiguration += " Barrel |";
  }
  if (wConfig.pVolumeConfig) {
    // positive layers are present
    ACTS_VERBOSE("Positive layers are present: rmin, rmax | zmin, zmax = "
                 << wConfig.pVolumeConfig.toString());
    // add to the string output
    layerConfiguration += " Positive Endcap |";
  }
  // screen output
  ACTS_DEBUG("Layer configuration is : " << layerConfiguration);

  // (B) LAYER Config SYNCHRONISATION ----------------------------------
  // synchronise the layer config
  ACTS_VERBOSE("Configurations after layer parsing " << '\n'
                                                     << wConfig.toString());
  // first let us arrange the new container volume
  wConfig.configureContainerVolume();
  ACTS_VERBOSE("Configuration after container synchronisation "
               << '\n'
               << wConfig.toString());
  // now let's understand the wrapping if needed
  if (wConfig.existingVolumeConfig) {
    wConfig.wrapInsertAttach();
    ACTS_VERBOSE("Configuration after wrapping, insertion, attachment "
                 << '\n'
                 << wConfig.toString());
  } else {
    // no wrapping around inner volume needed
    // however there could be central, positive & negative volume which will
    // need to be put into a container volume
    wConfig.wCondition = NoWrapping;
  }

  // (C) VOLUME CREATION ----------------------------------
  auto tvHelper = m_cfg.trackingVolumeHelper;
  // the barrel is always created
  auto barrel =
      wConfig.cVolumeConfig
          ? tvHelper->createTrackingVolume(
                gctx, wConfig.cVolumeConfig.layers,
                wConfig.cVolumeConfig.volumes, m_cfg.volumeMaterial,
                wConfig.cVolumeConfig.rMin, wConfig.cVolumeConfig.rMax,
                wConfig.cVolumeConfig.zMin, wConfig.cVolumeConfig.zMax,
                m_cfg.volumeName + "::Barrel")
          : nullptr;

  // Helper method to check for

  // Helper method to create endcap volume
  auto createEndcap =
      [&](VolumeConfig& centralConfig, VolumeConfig& endcapConfig,
          const std::string& endcapName) -> MutableTrackingVolumePtr {
    // No config - no volume
    if (not endcapConfig) {
      return nullptr;
    }
    // Check for ring layout
    if (m_cfg.checkRingLayout) {
      ACTS_DEBUG("Configured to check for ring layout - parsing layers.");
      // Parsing loop for ring layout
      std::vector<double> innerRadii = {};
      std::vector<double> outerRadii = {};
      for (const auto& elay : endcapConfig.layers) {
        auto discBounds = dynamic_cast<const RadialBounds*>(
            &(elay->surfaceRepresentation().bounds()));
        if (discBounds != nullptr) {
          double tolerance = m_cfg.ringTolerance;
          // Search for the rmin value  - and insert if necessary
          double rMin = discBounds->rMin();
          auto innerSearch = std::find_if(
              innerRadii.begin(), innerRadii.end(), [&](double reference) {
                return std::abs(rMin - reference) < tolerance;
              });
          if (innerSearch == innerRadii.end()) {
            innerRadii.push_back(rMin);
          }
          // Search for the rmax value - and insert if necessary
          double rMax = discBounds->rMax();
          auto outerSearch = std::find_if(
              outerRadii.begin(), outerRadii.end(), [&](double reference) {
                return std::abs(rMax - reference) < tolerance;
              });
          if (outerSearch == outerRadii.end()) {
            outerRadii.push_back(rMax);
          }
        }
      }
      // Result of the parsing loop
      if (innerRadii.size() == outerRadii.size() and not innerRadii.empty()) {
        bool consistent = true;
        // The inter volume radii
        std::vector<double> interRadii = {};
        for (int ir = 1; ir < int(innerRadii.size()); ++ir) {
          // Check whether inner/outer radii are consistent
          if (outerRadii[ir - 1] < innerRadii[ir]) {
            interRadii.push_back(0.5 * (outerRadii[ir - 1] + innerRadii[ir]));
          } else {
            consistent = false;
            break;
          }
        }
        // Continue if the ring layout is consistent
        if (consistent) {
          ACTS_DEBUG("Ring layout detection: " << innerRadii.size()
                                               << " volumes.");
          // Separate the Layers into volumes
          std::vector<std::pair<double, double>> volumeRminRmax = {};
          for (unsigned int ii = 0; ii < interRadii.size(); ++ii) {
            if (ii == 0) {
              volumeRminRmax.push_back({endcapConfig.rMin, interRadii[ii]});
            }
            if (ii + 1 < interRadii.size()) {
              volumeRminRmax.push_back({interRadii[ii], interRadii[ii + 1]});
            } else {
              volumeRminRmax.push_back({interRadii[ii], endcapConfig.rMax});
            }
          }
          auto ringLayers =
              std::vector<LayerVector>(innerRadii.size(), LayerVector());
          // Filling loop
          for (const auto& elay : endcapConfig.layers) {
            // Getting the reference radius
            double test =
                elay->surfaceRepresentation().binningPositionValue(gctx, binR);
            // Find the right bin
            auto ringVolume = std::find_if(
                volumeRminRmax.begin(), volumeRminRmax.end(),
                [&](const auto& reference) {
                  return (test > reference.first and test < reference.second);
                });
            if (ringVolume != volumeRminRmax.end()) {
              unsigned int ringBin =
                  std::distance(volumeRminRmax.begin(), ringVolume);
              ringLayers[ringBin].push_back(elay);
            }
          }
          // Subvolume construction
          ACTS_DEBUG("Ring layout configuration: ");
          // Endcap container
          std::vector<TrackingVolumePtr> endcapContainer;
          unsigned int ir = 0;
          for (auto& rLayers : ringLayers) {
            ACTS_DEBUG(" - ring volume " << ir << " with " << rLayers.size()
                                         << " layers, and rmin/rmax = "
                                         << volumeRminRmax[ir].first << "/"
                                         << volumeRminRmax[ir].second);
            endcapContainer.push_back(tvHelper->createTrackingVolume(
                gctx, rLayers, centralConfig.volumes, m_cfg.volumeMaterial,
                volumeRminRmax[ir].first, volumeRminRmax[ir].second,
                endcapConfig.zMin, endcapConfig.zMax,
                m_cfg.volumeName + endcapName + std::string("::Ring") +
                    std::to_string(ir)));
            ++ir;
          }
          // Return a container of ring volumes
          return tvHelper->createContainerTrackingVolume(gctx, endcapContainer);
        }
      }
    }

    // No ring layout - return single volume
    return tvHelper->createTrackingVolume(
        gctx, endcapConfig.layers, centralConfig.volumes, m_cfg.volumeMaterial,
        endcapConfig.rMin, endcapConfig.rMax, endcapConfig.zMin,
        endcapConfig.zMax, m_cfg.volumeName + endcapName);
  };

  // The negative endcap is created if present
  auto nEndcap = createEndcap(wConfig.cVolumeConfig, wConfig.nVolumeConfig,
                              "::NegativeEndcap");

  // The positive endcap is created if present
  auto pEndcap = createEndcap(wConfig.cVolumeConfig, wConfig.pVolumeConfig,
                              "::PositiveEndcap");

  ACTS_DEBUG("Newly created volume(s) will be " << wConfig.wConditionScreen);
  // Standalone container, full wrapping, full insertion & if no existing volume
  // is present needs a bare triple
  if (wConfig.wCondition == Wrapping || wConfig.wCondition == Inserting ||
      wConfig.wCondition == NoWrapping) {
    ACTS_VERBOSE("Combined new container is being built.");
    // Stuff into the container what you have
    std::vector<TrackingVolumePtr> volumesContainer;
    if (nEndcap) {
      volumesContainer.push_back(nEndcap);
      volume = nEndcap;
      // Set the inner or outer material
      if (not m_cfg.buildToRadiusZero) {
        volume->assignBoundaryMaterial(m_cfg.boundaryMaterial[0],
                                       Acts::tubeInnerCover);
      }
      volume->assignBoundaryMaterial(m_cfg.boundaryMaterial[1],
                                     Acts::tubeOuterCover);
      volume->assignBoundaryMaterial(m_cfg.boundaryMaterial[2],
                                     Acts::negativeFaceXY);
      volume->assignBoundaryMaterial(m_cfg.boundaryMaterial[3],
                                     Acts::positiveFaceXY);
    }
    if (barrel) {
      // Assign boundary material if existing
      volumesContainer.push_back(barrel);
      volume = barrel;
      // Set the inner or outer material
      if (not m_cfg.buildToRadiusZero) {
        volume->assignBoundaryMaterial(m_cfg.boundaryMaterial[0],
                                       Acts::tubeInnerCover);
      }
      volume->assignBoundaryMaterial(m_cfg.boundaryMaterial[1],
                                     Acts::tubeOuterCover);
      volume->assignBoundaryMaterial(m_cfg.boundaryMaterial[3],
                                     Acts::negativeFaceXY);
      volume->assignBoundaryMaterial(m_cfg.boundaryMaterial[4],
                                     Acts::positiveFaceXY);
    }
    if (pEndcap) {
      volumesContainer.push_back(pEndcap);
      volume = pEndcap;
      // Set the inner or outer material
      if (not m_cfg.buildToRadiusZero) {
        volume->assignBoundaryMaterial(m_cfg.boundaryMaterial[0],
                                       Acts::tubeInnerCover);
      }
      volume->assignBoundaryMaterial(m_cfg.boundaryMaterial[1],
                                     Acts::tubeOuterCover);
      volume->assignBoundaryMaterial(m_cfg.boundaryMaterial[4],
                                     Acts::negativeFaceXY);
      volume->assignBoundaryMaterial(m_cfg.boundaryMaterial[5],
                                     Acts::positiveFaceXY);
    }
    // and low lets create the new volume
    volume =
        volumesContainer.size() > 1
            ? tvHelper->createContainerTrackingVolume(gctx, volumesContainer)
            : volume;
  } else if (wConfig.wCondition != Attaching) {
    // the new volume is the only one present
    volume = nEndcap ? nEndcap : (barrel ? barrel : pEndcap);
  }

  // Prepare the gap volumes first
  TrackingVolumePtr existingVolumeCp = existingVolume;
  // Check if further action is needed on existing volumes and gap volumes
  if (existingVolumeCp) {
    // Check if gaps are needed
    std::vector<TrackingVolumePtr> existingContainer;
    if (wConfig.fGapVolumeConfig) {
      // create the gap volume
      auto fGap = tvHelper->createGapTrackingVolume(
          gctx, wConfig.cVolumeConfig.volumes, m_cfg.volumeMaterial,
          wConfig.fGapVolumeConfig.rMin, wConfig.fGapVolumeConfig.rMax,
          wConfig.fGapVolumeConfig.zMin, wConfig.fGapVolumeConfig.zMax, 1,
          false, m_cfg.volumeName + "::fGap");
      // push it back into the list
      existingContainer.push_back(fGap);
    }
    existingContainer.push_back(existingVolumeCp);
    if (wConfig.sGapVolumeConfig) {
      // create the gap volume
      auto sGap = tvHelper->createGapTrackingVolume(
          gctx, wConfig.cVolumeConfig.volumes, m_cfg.volumeMaterial,
          wConfig.sGapVolumeConfig.rMin, wConfig.sGapVolumeConfig.rMax,
          wConfig.sGapVolumeConfig.zMin, wConfig.sGapVolumeConfig.zMax, 1,
          false, m_cfg.volumeName + "::sGap");
      // push it back into the list
      existingContainer.push_back(sGap);
    }

    // And low lets create the new existing volume with gaps
    existingVolumeCp =
        existingContainer.size() > 1
            ? tvHelper->createContainerTrackingVolume(gctx, existingContainer)
            : existingVolumeCp;

    // for central wrapping or inserting, we need to update once more
    // clear the container
    existingContainer.clear();
    if (wConfig.wCondition == CentralWrapping) {
      existingContainer.push_back(existingVolumeCp);
      existingContainer.push_back(barrel);
    } else if (wConfig.wCondition == CentralInserting) {
      existingContainer.push_back(barrel);
      existingContainer.push_back(existingVolumeCp);
    }
    // update
    existingVolumeCp =
        !existingContainer.empty()
            ? tvHelper->createContainerTrackingVolume(gctx, existingContainer)
            : existingVolumeCp;

    std::vector<TrackingVolumePtr> totalContainer;
    // check what to do with the existing
    if (wConfig.wCondition == Attaching ||
        wConfig.wCondition == CentralWrapping ||
        wConfig.wCondition == CentralInserting) {
      if (nEndcap) {
        totalContainer.push_back(nEndcap);
      }
      totalContainer.push_back(existingVolumeCp);
      if (pEndcap) {
        totalContainer.push_back(pEndcap);
      }
    } else if (wConfig.wCondition == Inserting && volume) {
      totalContainer.push_back(volume);
      totalContainer.push_back(existingVolumeCp);
    } else if (wConfig.wCondition == Wrapping && volume) {
      totalContainer.push_back(existingVolumeCp);
      totalContainer.push_back(volume);
    } else {
      ACTS_ERROR("Misconfiguration in volume building detected.");
      return nullptr;
    }
    // now create the new container volume
    volume = tvHelper->createContainerTrackingVolume(gctx, totalContainer);
  }

  return volume;
}

// -----------------------------
Acts::VolumeConfig Acts::CylinderVolumeBuilder::analyzeContent(
    const GeometryContext& gctx, const LayerVector& lVector,
    const MutableTrackingVolumeVector& mtvVector) const {
  // @TODO add envelope tolerance
  //
  // return object
  VolumeConfig lConfig;
  // only if the vector is present it can actually be analyzed
  if (!lVector.empty() || !mtvVector.empty()) {
    // we have layers
    lConfig.present = true;
    // loop over the layer
    for (auto& layer : lVector) {
      // the thickness of the layer needs to be taken into account
      double thickness = layer->thickness();
      // get the center of the layer
      const Vector3D& center = layer->surfaceRepresentation().center(gctx);
      // check if it is a cylinder layer
      const CylinderLayer* cLayer =
          dynamic_cast<const CylinderLayer*>(layer.get());
      if (cLayer != nullptr) {
        // now we have access to all the information
        double rMinC =
            cLayer->surfaceRepresentation().bounds().get(CylinderBounds::eR) -
            0.5 * thickness;
        double rMaxC =
            cLayer->surfaceRepresentation().bounds().get(CylinderBounds::eR) +
            0.5 * thickness;

        double hZ = cLayer->surfaceRepresentation().bounds().get(
            CylinderBounds::eHalfLengthZ);
        lConfig.rMin =
            std::min(lConfig.rMin, rMinC - m_cfg.layerEnvelopeR.first);
        lConfig.rMax =
            std::max(lConfig.rMax, rMaxC + m_cfg.layerEnvelopeR.second);
        lConfig.zMin =
            std::min(lConfig.zMin, center.z() - hZ - m_cfg.layerEnvelopeZ);
        lConfig.zMax =
            std::max(lConfig.zMax, center.z() + hZ + m_cfg.layerEnvelopeZ);
      }
      // proceed further if it is a Disc layer
      const RadialBounds* dBounds = dynamic_cast<const RadialBounds*>(
          &(layer->surfaceRepresentation().bounds()));
      if (dBounds != nullptr) {
        // now we have access to all the information
        double rMinD = dBounds->rMin();
        double rMaxD = dBounds->rMax();
        double zMinD = center.z() - 0.5 * thickness;
        double zMaxD = center.z() + 0.5 * thickness;
        lConfig.rMin =
            std::min(lConfig.rMin, rMinD - m_cfg.layerEnvelopeR.first);
        lConfig.rMax =
            std::max(lConfig.rMax, rMaxD + m_cfg.layerEnvelopeR.second);
        lConfig.zMin = std::min(lConfig.zMin, zMinD - m_cfg.layerEnvelopeZ);
        lConfig.zMax = std::max(lConfig.zMax, zMaxD + m_cfg.layerEnvelopeZ);
      }
    }
    for (auto& volume : mtvVector) {
      const CylinderVolumeBounds* cvBounds =
          dynamic_cast<const CylinderVolumeBounds*>(&volume->volumeBounds());
      if (cvBounds != nullptr) {
        lConfig.rMin =
            std::min(lConfig.rMin, cvBounds->get(CylinderVolumeBounds::eMinR));
        lConfig.rMax =
            std::max(lConfig.rMax, cvBounds->get(CylinderVolumeBounds::eMaxR));
        lConfig.zMin = std::min(
            lConfig.zMin, -cvBounds->get(CylinderVolumeBounds::eHalfLengthZ));
        lConfig.zMax = std::max(
            lConfig.zMax, cvBounds->get(CylinderVolumeBounds::eHalfLengthZ));
      }
    }
  }

  // Set the layers to the layer vector
  lConfig.layers = lVector;
  // set the layers to the layer vector
  lConfig.volumes = mtvVector;
  // overwrite to radius 0 if needed
  if (m_cfg.buildToRadiusZero) {
    ACTS_VERBOSE("This layer builder is configured to build to the beamline.");
    lConfig.rMin = 0.;
  }

  // and return what you have
  return lConfig;
}