GeoPixelModule.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#include <utility>
 
#include "GeoPixelModule.h"
#include "GeoPixelHybrid.h"
#include "GeoPixelChip.h"
#include "GeoPixelSiCrystal.h"
#include "GeoModelKernel/GeoBox.h"
#include "GeoModelKernel/GeoPhysVol.h"
#include "GeoModelKernel/GeoLogVol.h"
#include "GeoModelKernel/GeoNameTag.h"
#include "GeoModelKernel/GeoIdentifierTag.h"
#include "GeoModelKernel/GeoFullPhysVol.h"
#include "GeoModelKernel/GeoMaterial.h"
#include "GeoModelKernel/GeoTransform.h"
#include "GeoModelKernel/GeoShapeShift.h"
#include "GeoModelKernel/GeoShapeUnion.h"
#include "GaudiKernel/SystemOfUnits.h"
 
using std::max;
 
GeoPixelModule::GeoPixelModule(InDetDD::PixelDetectorManager* ddmgr,
                               PixelGeometryManager* mgr,
                               GeoModelIO::ReadGeoModel* sqliteReader,
                               std::shared_ptr<std::map<std::string, GeoFullPhysVol*>> mapFPV,
                               std::shared_ptr<std::map<std::string, GeoAlignableTransform*>> mapAX,
                               GeoPixelSiCrystal& theSensor) 
  : GeoVPixelFactory (ddmgr, mgr, sqliteReader, std::move(mapFPV), std::move(mapAX))
  , m_theSensor(theSensor)
{
  //
  // Define the log volume in the constructor, so I do it only once.
  //
  // The module orientation is
  // x normal to the detector
  // y in the phi direction
  // z in the eta (z) direction
 
  m_isModule3D=m_theSensor.GetModule3DFlag();
  m_nbModuleSvc = m_gmt_mgr->PixelModuleServiceNumber();
  
  if(!m_sqliteReader) {
    int svcType = (m_isModule3D) ? 1 : 0;
 
    //
    // The Dimensions are in separate routines
    //
    double length = this->Length();
    double thickness = this->Thickness();
    double width = this->Width();
    const GeoMaterial* air = m_mat_mgr->getMaterial("std::Air");
    
    //  const GeoShape * moduleShape = 0;
    std::string logName = m_gmt_mgr->isBarrel() ? "ModuleBrl" : "ModuleEC";
    
    if (ThicknessP() == ThicknessN()) {
      const GeoBox* moduleBox = new GeoBox(thickness/2.,width/2.,length/2.);
      const GeoShape * moduleShape = moduleBox;
      m_theModule = new GeoLogVol(logName,moduleShape,air);
    } 
    else {
      
      // Shift so the center of the box is the center of the sensor.
      double shift = 0.5 * (ThicknessP() - ThicknessN_noSvc());
      //    const GeoShape & shiftedBox = (*moduleBox) << GeoTrf::TranslateX3D(shift);
      //    moduleShape = &shiftedBox;
      
      thickness = ThicknessP()+ThicknessN_noSvc();
      const GeoBox* moduleBox = new GeoBox(thickness/2.,width/2.,length/2.);
      const GeoShape & shiftedBox = (*moduleBox) << GeoTrf::TranslateX3D(shift);
      const GeoShape * moduleShape = &shiftedBox;
      
      if(m_moduleSvcThickness<0.001) {
    m_theModule = new GeoLogVol(logName,moduleShape,air);
      }
      else {
    const GeoShape * gblShape = nullptr;
    gblShape = addShape(gblShape, moduleShape, GeoTrf::Transform3D::Identity() );
    
    double svcWidth = width*.6;
    m_moduleSvcWidth = svcWidth;
    const GeoBox* moduleSvcBox1 = new GeoBox(m_moduleSvcThickness*.5,svcWidth*.25,length*.5);
    double yShift = width*.5-svcWidth*.75;
    double xShift = thickness*.5+m_moduleSvcThickness*.5; 
    gblShape = addShape(gblShape, moduleSvcBox1, (GeoTrf::TranslateX3D(-xShift)*GeoTrf::TranslateY3D(-yShift)) );
    
    const GeoBox* moduleSvcBox2 = new GeoBox(m_moduleSvcThickness*.25,svcWidth*.25,length*.5);
    yShift = width*.5-svcWidth*.25;
    xShift = thickness*.5+m_moduleSvcThickness*.25; 
    gblShape = addShape(gblShape, moduleSvcBox2, (GeoTrf::TranslateX3D(-xShift)*GeoTrf::TranslateY3D(-yShift)) );
    
    for(int iSvc=0; iSvc<m_nbModuleSvc; iSvc++)
    {
      int type = m_gmt_mgr->PixelModuleServiceModuleType(iSvc);
      std::string name = m_gmt_mgr->PixelModuleServiceName(iSvc);
      double offsetX = m_gmt_mgr->PixelModuleServiceOffsetX(iSvc);
 
      if(type==svcType&&(name=="WingFlex"||offsetX<0)) {
        double width_svc = m_gmt_mgr->PixelModuleServiceWidth(iSvc);
        double thick_svc = m_gmt_mgr->PixelModuleServiceThick(iSvc);
        double offsetY = m_gmt_mgr->PixelModuleServiceOffsetY(iSvc);
        double xPos = -0.5*(m_gmt_mgr->PixelBoardThickness(m_isModule3D)-m_gmt_mgr->PixelHybridThickness(m_isModule3D)) - offsetX - thick_svc*.5;
        const GeoBox* moduleSvcBox3 = new GeoBox(thick_svc*.5+.01,width_svc*.5+.01,length*.5+.01);
        gblShape = addShape(gblShape, moduleSvcBox3, (GeoTrf::TranslateX3D(xPos)*GeoTrf::TranslateY3D(offsetY)) );
      }
    }
    
    m_theModule = new GeoLogVol(logName,gblShape,air);
      }
    }
  }
    
}
 
 
GeoVPhysVol* GeoPixelModule::Build( ) {
 
  if(m_sqliteReader) {
    m_theSensor.Build();
    m_id = m_theSensor.getID();
    return nullptr;
  }
 
  GeoFullPhysVol* modulePhys = new GeoFullPhysVol(m_theModule);
  //
  // Place the Si Crystal
  //
  GeoVPhysVol *theSi = m_theSensor.Build();
  m_id = m_theSensor.getID();
  std::string sensorName = m_gmt_mgr->isBarrel() ? "SensorBrl" : "SensorEC";
  GeoNameTag *tag = new GeoNameTag(sensorName);         
  modulePhys->add(tag);
  // We give the barrel sensors an id of 100 and endcap sensors an id of 200 so that they can
  // can be distinguished in the G4 sensitive detector.
  int idTag = 100; // barrel
  if (m_gmt_mgr->isEndcap()) {
    idTag = 200; // endcap
  }
  modulePhys->add(new GeoIdentifierTag(idTag) );
  //Sensor is centered so we don't need the transform.
  //GeoTransform *xformsi = new GeoTransform(GeoTrf::Transform3D());
  //modulePhys->add(xformsi);
  modulePhys->add(theSi );
  //
  // Place the Hybrid
  //
  if (m_gmt_mgr->PixelHybridThickness(m_isModule3D)>0.00001*Gaudi::Units::mm){
    GeoPixelHybrid ph(m_DDmgr, m_gmt_mgr, m_sqliteReader, m_mapFPV, m_mapAX, m_isModule3D);
    double hybxpos = -0.5*(m_gmt_mgr->PixelBoardThickness(m_isModule3D)+m_gmt_mgr->PixelHybridThickness(m_isModule3D));
    GeoTransform* xform = new GeoTransform(GeoTrf::TranslateX3D(hybxpos));
    modulePhys->add(xform);
    modulePhys->add(ph.Build() );
  }
 
  //
  // Place the Chip
  //
  GeoPixelChip pc(m_DDmgr, m_gmt_mgr, m_sqliteReader, m_mapFPV, m_mapAX, m_isModule3D);
  double chipxpos = 0.5*(m_gmt_mgr->PixelBoardThickness(m_isModule3D)+m_gmt_mgr->PixelChipThickness(m_isModule3D))+m_gmt_mgr->PixelChipGap(m_isModule3D);
  double chipypos =m_gmt_mgr->PixelChipOffset(m_isModule3D);
  GeoTransform* xform = new GeoTransform(GeoTrf::TranslateX3D(chipxpos)*GeoTrf::TranslateY3D(chipypos));
  modulePhys->add(xform);
  modulePhys->add(pc.Build() );
 
  //
  // Add the module services
  //
  if(m_nbModuleSvc==0) return modulePhys;
  
  int svcType = (m_isModule3D) ? 1 : 0;
  for(int iSvc=0; iSvc<m_nbModuleSvc; iSvc++)
    {
      int type = m_gmt_mgr->PixelModuleServiceModuleType(iSvc);
      
      if(type==svcType){
    double length = m_gmt_mgr->PixelModuleServiceLength(iSvc);
    double width = m_gmt_mgr->PixelModuleServiceWidth(iSvc);
    double thick = m_gmt_mgr->PixelModuleServiceThick(iSvc);
    double offsetX = m_gmt_mgr->PixelModuleServiceOffsetX(iSvc); 
    double offsetY = m_gmt_mgr->PixelModuleServiceOffsetY(iSvc);
    double offsetZ = m_gmt_mgr->PixelModuleServiceOffsetZ(iSvc);
    std::string name = m_gmt_mgr->PixelModuleServiceName(iSvc);
    std::string material = m_gmt_mgr->PixelModuleServiceMaterial(iSvc);
 
    const GeoBox* svcBox = new GeoBox(thick*.5-0.01,width*.5,length*.5);      
    const GeoMaterial* svcMat = m_mat_mgr->getMaterialForVolume(material,svcBox->volume());
    GeoLogVol* svcLogVol = new GeoLogVol(name, svcBox, svcMat);
    GeoPhysVol* svcPhys = new GeoPhysVol(svcLogVol);
 
    double xPos = -0.5*(m_gmt_mgr->PixelBoardThickness(m_isModule3D)-m_gmt_mgr->PixelHybridThickness(m_isModule3D)) - offsetX - thick*.5;
    double yPos = offsetY;
    double zPos = offsetZ;
    GeoTransform* xform = new GeoTransform(GeoTrf::Translate3D(xPos,yPos,zPos));    
    modulePhys->add(xform);
    modulePhys->add(svcPhys);
      }
    }
 
 
  return modulePhys;
}
 
double GeoPixelModule::ThicknessN_noSvc() {
  //
  // The module envelope is no longer forced to symmetric about its
  // center to allow for room between the module and TMT. ThicknessN
  // is the max of ThicknessP and thickness from the module center to
  // the outer surface of the hybrid plus some safety.
  //
  double safety = 0.01*Gaudi::Units::mm; 
  double thickn = 0.5 * m_gmt_mgr->PixelBoardThickness(m_isModule3D)+ m_gmt_mgr->PixelHybridThickness(m_isModule3D) + safety;
  double thick = max(thickn, ThicknessP()); 
  
  if(m_nbModuleSvc==0) return thick;
  
  double thickSvc=0;
  int svcType = (m_isModule3D) ? 1 : 0;
  for(int iSvc=0; iSvc<m_nbModuleSvc; iSvc++)
    {
      int type = m_gmt_mgr->PixelModuleServiceModuleType(iSvc);
      int fullSize = m_gmt_mgr->PixelModuleServiceFullSize(iSvc);
      if(type==svcType&&fullSize==1){
    double locThick = m_gmt_mgr->PixelModuleServiceThick(iSvc);
    double offsetX = m_gmt_mgr->PixelModuleServiceOffsetX(iSvc);
    double tmp = offsetX+locThick;
    thickSvc = std::max(thickSvc,tmp);
      }
    }
 
  return thick+thickSvc;
 
}
 
 
double GeoPixelModule::ThicknessN() {
  //
  // The module envelope is no longer forced to symmetric about its
  // center to allow for room between the module and TMT. ThicknessN
  // is the max of ThicknessP and thickness from the module center to
  // the outer surface of the hybrid plus some safety.
  //
 
 
  double safety = 0.01*Gaudi::Units::mm; 
  double thickn = 0.5 * m_gmt_mgr->PixelBoardThickness(m_isModule3D)+ m_gmt_mgr->PixelHybridThickness(m_isModule3D) + safety;
  double thick = max(thickn, ThicknessP()); 
 
  if(m_nbModuleSvc==0) return thick;
  
  double thickSvc=0;
  int svcType = (m_isModule3D) ? 1 : 0;
  for(int iSvc=0; iSvc<m_nbModuleSvc; iSvc++)
    {
      int type = m_gmt_mgr->PixelModuleServiceModuleType(iSvc);
      if(type==svcType){
    double locThick = m_gmt_mgr->PixelModuleServiceThick(iSvc);
    double offsetX = m_gmt_mgr->PixelModuleServiceOffsetX(iSvc);
    double tmp = offsetX+locThick;
    thickSvc = std::max(thickSvc,tmp);
      }
    }
  m_moduleSvcThickness = thickSvc;
 
  return thick+thickSvc;
}
 
 
double GeoPixelModule::ThicknessP() {
  //
  // The module envelope is no longer forced to symmetric about its
  // center to allow for room between the module and TMT. ThicknessP
  // is thickness from the module center to the outer surface of the
  // chips plus some safety.
 
  double safety = 0.01*Gaudi::Units::mm;
  double thick = 0.5 * m_gmt_mgr->PixelBoardThickness(m_isModule3D) +
    m_gmt_mgr->PixelChipThickness(m_isModule3D)+m_gmt_mgr->PixelChipGap(m_isModule3D) + safety;
 
  return thick;
}
 
double GeoPixelModule::Thickness() {
  // This is total thickness of the module envelope
  return ThicknessP()+ThicknessN();
}
 
double GeoPixelModule::Width() {
 
  double chipypos =fabs(m_gmt_mgr->PixelChipOffset(m_isModule3D));
  double width = max( max(
                     m_gmt_mgr->PixelBoardWidth(m_isModule3D),
                     m_gmt_mgr->PixelHybridWidth(m_isModule3D)),
                     m_gmt_mgr->PixelChipWidth(m_isModule3D)+2.*chipypos);
  return width;
}
double GeoPixelModule::Length() {
  // balcony is zero
 
  //  std::cout<<m_isModule3D<<" "<<m_gmt_mgr->PixelHybridLength(m_isModule3D)<<" "<<m_gmt_mgr->PixelBoardLength(m_isModule3D)<<" "<<m_gmt_mgr->PixelChipLength(m_isModule3D)<<std::endl;
 
  double length = max( max( //max(
                                m_gmt_mgr->PixelHybridLength(m_isModule3D),
                                m_gmt_mgr->PixelBoardLength(m_isModule3D)),
               //2*m_gmt_mgr->PixelBalcony()),
                       m_gmt_mgr->PixelChipLength(m_isModule3D));
 
  return length;
}
 
Identifier GeoPixelModule::getID() {
  return m_id;
}
 
 
const GeoShape * GeoPixelModule::addShape(const GeoShape * lastShape, const GeoShape * nextShape, const GeoTrf::Transform3D & trans)
{
  const GeoShape * shiftedShape = &(*nextShape << trans);
  if (lastShape) {
    lastShape = &(lastShape->add(*shiftedShape));
  } else {
    lastShape = shiftedShape;
  }
  return lastShape;
}