DDHGCalModule.cc

Go to the documentation of this file.

// File: DDHGCalModule.cc
// Description: Geometry factory class for HGCal (EE and HESil)

#include <cmath>
#include <algorithm>

#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "DetectorDescription/Core/interface/DDutils.h"
#include "DetectorDescription/Core/interface/DDLogicalPart.h"
#include "DetectorDescription/Core/interface/DDSolid.h"
#include "DetectorDescription/Core/interface/DDMaterial.h"
#include "DetectorDescription/Core/interface/DDCurrentNamespace.h"
#include "DetectorDescription/Core/interface/DDSplit.h"
#include "Geometry/HGCalCommonData/plugins/DDHGCalModule.h"
#include "Geometry/HGCalCommonData/interface/HGCalGeomTools.h"
#include "Geometry/HGCalCommonData/interface/HGCalParameters.h"
#include "CLHEP/Units/GlobalPhysicalConstants.h"
#include "CLHEP/Units/GlobalSystemOfUnits.h"

//#define EDM_ML_DEBUG

DDHGCalModule::DDHGCalModule() {
#ifdef EDM_ML_DEBUG
  std::cout << "DDHGCalModule info: Creating an instance" << std::endl;
#endif
}

DDHGCalModule::~DDHGCalModule() {}

void DDHGCalModule::initialize(const DDNumericArguments & nArgs,
                   const DDVectorArguments & vArgs,
                   const DDMapArguments & ,
                   const DDStringArguments & sArgs,
                   const DDStringVectorArguments &vsArgs){

  wafer         = vsArgs["WaferName"];
#ifdef EDM_ML_DEBUG
  std::cout << "DDHGCalModule: " << wafer.size() << " wafers" << std::endl;
  for (unsigned int i=0; i<wafer.size(); ++i)
    std::cout << "Wafer[" << i << "] " << wafer[i] << std::endl;
#endif
  materials     = vsArgs["MaterialNames"];
  names         = vsArgs["VolumeNames"];
  thick         = vArgs["Thickness"];
  for (unsigned int i=0; i<materials.size(); ++i) {
    copyNumber.emplace_back(1);
  }
#ifdef EDM_ML_DEBUG
  std::cout << "DDHGCalModule: " << materials.size()
        << " types of volumes" << std::endl;
  for (unsigned int i=0; i<names.size(); ++i)
    std::cout << "Volume [" << i << "] " << names[i] << " of thickness " 
          << thick[i] << " filled with " << materials[i]
          << " first copy number " << copyNumber[i] << std::endl;
#endif
  layers        = dbl_to_int(vArgs["Layers"]);
  layerThick    = vArgs["LayerThick"];
#ifdef EDM_ML_DEBUG
  std::cout << "DDHGCalModule: " << layers.size() << " blocks" <<std::endl;
  for (unsigned int i=0; i<layers.size(); ++i)
    std::cout << "Block [" << i << "] of thickness "  << layerThick[i] 
          << " with " << layers[i] << " layers" << std::endl;
#endif
  layerType     = dbl_to_int(vArgs["LayerType"]);
  layerSense    = dbl_to_int(vArgs["LayerSense"]);
#ifdef EDM_ML_DEBUG
  std::cout << "DDHGCalModule: " << layerType.size() << " layers" 
        << std::endl;
  for (unsigned int i=0; i<layerType.size(); ++i)
    std::cout << "Layer [" << i << "] with material type "  << layerType[i]
          << " sensitive class " << layerSense[i] << std::endl;
#endif
  zMinBlock     = nArgs["zMinBlock"];
  rMaxFine      = nArgs["rMaxFine"];
  waferW        = nArgs["waferW"];
  sectors       = (int)(nArgs["Sectors"]);
#ifdef EDM_ML_DEBUG
  std::cout << "DDHGCalModule: zStart " << zMinBlock << " rFineCoarse " 
        << rMaxFine << " wafer width " << waferW << " sectors " << sectors
        << std::endl;
#endif
  slopeB        = vArgs["SlopeBottom"];
  slopeT        = vArgs["SlopeTop"];
  zFront        = vArgs["ZFront"];
  rMaxFront     = vArgs["RMaxFront"];
#ifdef EDM_ML_DEBUG
  std::cout << "DDHGCalModule: Bottom slopes " << slopeB[0] << ":" 
        << slopeB[1] << " and " << slopeT.size() << " slopes for top" 
        << std::endl;
  for (unsigned int i=0; i<slopeT.size(); ++i)
    std::cout << "Block [" << i << "] Zmin " << zFront[i] << " Rmax "
          << rMaxFront[i] << " Slope " << slopeT[i] << std::endl;
#endif
  idNameSpace   = DDCurrentNamespace::ns();
#ifdef EDM_ML_DEBUG
  std::cout << "DDHGCalModule: NameSpace " << idNameSpace << std::endl;
#endif
}

// DDHGCalModule methods...

void DDHGCalModule::execute(DDCompactView& cpv) {
  
#ifdef EDM_ML_DEBUG
  std::cout << "==>> Constructing DDHGCalModule..." << std::endl;
#endif
  copies.clear();
  constructLayers (parent(), cpv);
#ifdef EDM_ML_DEBUG
  std::cout << copies.size() << " different wafer copy numbers" << std::endl;
  int nk(0), k(0);
  for (std::unordered_set<int>::const_iterator itr=copies.begin();
       itr != copies.end(); ++itr,++k) {
    std::cout << "[" << k << "] : " << (*itr) << " ";
    ++nk;
    if (nk == 8) { std::cout << std::endl; nk = 0;}
  }
  if (nk > 0) std::cout << std::endl;
#endif
  copies.clear();
#ifdef EDM_ML_DEBUG
  std::cout << "<<== End of DDHGCalModule construction ..." << std::endl;
#endif
}

void DDHGCalModule::constructLayers(const DDLogicalPart& module, 
                    DDCompactView& cpv) {
  
#ifdef EDM_ML_DEBUG
  std::cout << "DDHGCalModule test: \t\tInside Layers" << std::endl;
#endif
  double       zi(zMinBlock);
  int          laymin(0);
  const double tol(0.01);
  for (unsigned int i=0; i<layers.size(); i++) {
    double  zo     = zi + layerThick[i];
    double  routF  = rMax(zi);
    int     laymax = laymin+layers[i];
    double  zz     = zi;
    double  thickTot(0);
    for (int ly=laymin; ly<laymax; ++ly) {
      int     ii     = layerType[ly];
      int     copy   = copyNumber[ii];
      double  rinB   = (layerSense[ly] == 0) ? (zo*slopeB[0]) : (zo*slopeB[1]);
      zz            += (0.5*thick[ii]);
      thickTot      += thick[ii];

      std::string name = "HGCal"+names[ii]+std::to_string(copy);
#ifdef EDM_ML_DEBUG
      std::cout << "DDHGCalModule test: Layer " << ly << ":" << ii 
        << " Front " << zi << ", " << routF << " Back " << zo << ", " 
        << rinB << " superlayer thickness " << layerThick[i] 
        << std::endl;
#endif
      DDName matName(DDSplit(materials[ii]).first, 
             DDSplit(materials[ii]).second);
      DDMaterial matter(matName);
      DDLogicalPart glog;
      if (layerSense[ly] == 0) {
    double alpha = CLHEP::pi/sectors;
    double rmax  = routF*cos(alpha) - tol;
    std::vector<double> pgonZ, pgonRin, pgonRout;
    pgonZ.emplace_back(-0.5*thick[ii]);    pgonZ.emplace_back(0.5*thick[ii]);
    pgonRin.emplace_back(rinB);            pgonRin.emplace_back(rinB);   
    pgonRout.emplace_back(rmax);           pgonRout.emplace_back(rmax);   
    DDSolid solid = DDSolidFactory::polyhedra(DDName(name, idNameSpace),
                          sectors, -alpha, CLHEP::twopi,
                          pgonZ, pgonRin, pgonRout);
    glog = DDLogicalPart(solid.ddname(), matter, solid);
#ifdef EDM_ML_DEBUG
    std::cout << "DDHGCalModule test: " << solid.name() 
          << " polyhedra of " << sectors << " sectors covering " 
          << -alpha/CLHEP::deg << ":" 
          << (-alpha+CLHEP::twopi)/CLHEP::deg
          << " with " << pgonZ.size() << " sections" << std::endl;
    for (unsigned int k=0; k<pgonZ.size(); ++k)
      std::cout << "[" << k << "] z " << pgonZ[k] << " R " << pgonRin[k] 
            << ":" << pgonRout[k] << std::endl;
#endif
      } else {
    DDSolid solid = DDSolidFactory::tubs(DDName(name, idNameSpace), 
                         0.5*thick[ii], rinB, routF, 0.0,
                         CLHEP::twopi);
    glog = DDLogicalPart(solid.ddname(), matter, solid);
#ifdef EDM_ML_DEBUG
    std::cout << "DDHGCalModule test: " << solid.name()
          << " Tubs made of " << matName << " of dimensions " << rinB 
          << ", " << routF << ", " << 0.5*thick[ii] << ", 0.0, "
          << CLHEP::twopi/CLHEP::deg << std::endl;
    std::cout << "DDHGCalModule test position in: " << glog.name() 
          << " number " << copy << std::endl;
#endif
    positionSensitive(glog,rinB,routF,cpv);
      }
      DDTranslation r1(0,0,zz);
      DDRotation rot;
      cpv.position(glog, module, copy, r1, rot);
      ++copyNumber[ii];
#ifdef EDM_ML_DEBUG
      std::cout << "DDHGCalModule test: " << glog.name() << " number "
        << copy << " positioned in " << module.name() << " at " << r1 
        << " with " << rot << std::endl;
#endif
      zz += (0.5*thick[ii]);
    } // End of loop over layers in a block
    zi     = zo;
    laymin = laymax;
    if (fabs(thickTot-layerThick[i]) < 0.00001) {
    } else if (thickTot > layerThick[i]) {
      edm::LogError("HGCalGeom") << "Thickness of the partition " << layerThick[i]
                 << " is smaller than thickness " << thickTot
                 << " of all its components **** ERROR ****\n";
    } else if (thickTot < layerThick[i]) {
      edm::LogWarning("HGCalGeom") << "Thickness of the partition " 
                   << layerThick[i] << " does not match with "
                   << thickTot << " of the components\n";
    }
  }   // End of loop over blocks
}

double DDHGCalModule::rMax(double z) {
  double r(0);
#ifdef EDM_ML_DEBUG
  unsigned int ik(0);
#endif
  for (unsigned int k=0; k<slopeT.size(); ++k) {
    if (z < zFront[k]) break;
    r  = rMaxFront[k] + (z - zFront[k]) * slopeT[k];
#ifdef EDM_ML_DEBUG
    ik = k;
#endif
  }
#ifdef EDM_ML_DEBUG
  std::cout << "rMax : " << z << ":" << ik << ":" << r << std::endl;
#endif
  return r;
}

void DDHGCalModule::positionSensitive(DDLogicalPart& glog, double rin,
                      double rout, DDCompactView& cpv) {
  double dx   = 0.5*waferW;
  double dy   = 3.0*dx*tan(30.0*CLHEP::deg);
  double rr   = 2.0*dx*tan(30.0*CLHEP::deg);
  int    ncol = (int)(2.0*rout/waferW) + 1;
  int    nrow = (int)(rout/(waferW*tan(30.0*CLHEP::deg))) + 1;
  int    incm(0), inrm(0), kount(0), ntot(0), nin(0), nfine(0), ncoarse(0);
#ifdef EDM_ML_DEBUG
  std::cout << glog.ddname() << " rout " << rout << " Row " << nrow 
        << " Column " << ncol << std::endl; 
#endif
  for (int nr=-nrow; nr <= nrow; ++nr) {
    int inr = (nr >= 0) ? nr : -nr;
    for (int nc=-ncol; nc <= ncol; ++nc) {
      int inc = (nc >= 0) ? nc : -nc;
      if (inr%2 == inc%2) {
    double xpos = nc*dx;
    double ypos = nr*dy;
    std::pair<int,int> corner = 
      HGCalGeomTools::waferCorner(xpos, ypos, dx, rr, rin, rout, true);
    ++ntot;
    if (corner.first > 0) {
      int copy = inr*100 + inc;
      if (nc < 0) copy += 10000;
      if (nr < 0) copy += 100000;
      if (inc > incm) incm = inc;
      if (inr > inrm) inrm = inr;
      kount++;
      if (copies.count(copy) == 0) copies.insert(copy);
      if (corner.first == (int)(HGCalParameters::k_CornerSize)) {
        double rpos = std::sqrt(xpos*xpos+ypos*ypos);
        DDTranslation tran(xpos, ypos, 0.0);
        DDRotation rotation;
        ++nin;
        DDName name = (rpos < rMaxFine) ? 
          DDName(DDSplit(wafer[0]).first, DDSplit(wafer[0]).second) : 
          DDName(DDSplit(wafer[1]).first, DDSplit(wafer[1]).second);
        cpv.position(name, glog.ddname(), copy, tran, rotation);
        if (rpos < rMaxFine) ++nfine;
        else                 ++ncoarse;
#ifdef EDM_ML_DEBUG
        std::cout << "DDHGCalModule: " << name << " number " << copy
              << " positioned in " << glog.ddname() << " at " << tran 
              << " with " << rotation << std::endl;
#endif
      }
    }
      }
    }
  }
#ifdef EDM_ML_DEBUG
  std::cout << "DDHGCalModule: # of columns " << incm << " # of rows " 
        << inrm << " and " << nin << ":" << kount << ":" << ntot 
        << " wafers (" << nfine << ":" << ncoarse << ") for " 
        << glog.ddname() << " R " << rin << ":" << rout << std::endl;
#endif
}