PrintGeomSummary.cc

Go to the documentation of this file.

#include "SimG4Core/Notification/interface/BeginOfRun.h"
#include "SimG4Core/Notification/interface/Observer.h"
#include "SimG4Core/Watcher/interface/SimWatcher.h"

#include "FWCore/Framework/interface/EventSetup.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "Geometry/Records/interface/IdealGeometryRecord.h"
#include "DetectorDescription/Core/interface/DDCompactView.h"
#include "DetectorDescription/Core/interface/DDFilter.h"
#include "DetectorDescription/Core/interface/DDFilteredView.h"
#include "DetectorDescription/Core/interface/DDLogicalPart.h"
#include "DetectorDescription/Core/interface/DDSolid.h"
#include "DetectorDescription/Core/interface/DDSolidShapes.h"
#include "DetectorDescription/Core/interface/DDSplit.h"
#include "DetectorDescription/Core/interface/DDValue.h"

#include "G4Run.hh"
#include "G4PhysicalVolumeStore.hh"
#include "G4LogicalVolumeStore.hh"
#include "G4VPhysicalVolume.hh"
#include "G4LogicalVolume.hh"
#include "G4VSolid.hh"
#include "G4Material.hh"
#include "G4NavigationHistory.hh"
#include "G4Track.hh"
#include "G4VisAttributes.hh"
#include "G4UserLimits.hh"
#include "G4TransportationManager.hh"

#include <algorithm>
#include <iostream>
#include <vector>
#include <map>
#include <set>
#include <string>

class PrintGeomSummary : public SimWatcher, public Observer<const BeginOfRun*> {
public:
  PrintGeomSummary(edm::ParameterSet const& p);
  ~PrintGeomSummary() override = default;

  void registerConsumes(edm::ConsumesCollector) override;
  void beginRun(edm::EventSetup const&) override;

private:
  void update(const BeginOfRun* run) override;
  void addSolid(const DDLogicalPart& part);
  void fillLV(G4LogicalVolume* lv);
  void fillPV(G4VPhysicalVolume* pv);
  void dumpSummary(std::ostream& out, std::string name);
  G4VPhysicalVolume* getTopPV();
  void addName(std::string name);
  void printSummary(std::ostream& out);

private:
  edm::ESGetToken<DDCompactView, IdealGeometryRecord> ddcompToken_;
  std::vector<std::string> nodeNames_;
  std::map<DDSolidShape, std::string> solidShape_;
  std::map<std::string, DDSolidShape> solidMap_;
  G4VPhysicalVolume* theTopPV_;
  std::vector<G4LogicalVolume*> lvs_, touch_;
  std::vector<G4VSolid*> sls_;
  std::vector<G4VPhysicalVolume*> pvs_;
  std::map<DDSolidShape, std::pair<int, int>> kount_;
};

PrintGeomSummary::PrintGeomSummary(const edm::ParameterSet& p) : theTopPV_(nullptr) {
  std::vector<std::string> defNames;
  nodeNames_ = p.getUntrackedParameter<std::vector<std::string>>("NodeNames", defNames);
  G4cout << "PrintGeomSummary:: initialised for " << nodeNames_.size() << " nodes:" << G4endl;
  for (unsigned int ii = 0; ii < nodeNames_.size(); ii++)
    G4cout << "Node[" << ii << "] : " << nodeNames_[ii] << G4endl;

  solidShape_[DDSolidShape::ddbox] = "Box";
  solidShape_[DDSolidShape::ddtubs] = "Tube";
  solidShape_[DDSolidShape::ddtrap] = "Trapezoid";
  solidShape_[DDSolidShape::ddcons] = "Cone";
  solidShape_[DDSolidShape::ddpolycone_rz] = "Polycone_rz";
  solidShape_[DDSolidShape::ddpolyhedra_rz] = "Polyhedra_rz";
  solidShape_[DDSolidShape::ddpolycone_rrz] = "Polycone_rrz";
  solidShape_[DDSolidShape::ddpolyhedra_rrz] = "Polyhedra_rrz";
  solidShape_[DDSolidShape::ddtorus] = "Torus";
  solidShape_[DDSolidShape::ddunion] = "UnionSolid";
  solidShape_[DDSolidShape::ddsubtraction] = "SubtractionSolid";
  solidShape_[DDSolidShape::ddintersection] = "IntersectionSolid";
  solidShape_[DDSolidShape::ddshapeless] = "ShapelessSolid";
  solidShape_[DDSolidShape::ddpseudotrap] = "PseudoTrapezoid";
  solidShape_[DDSolidShape::ddtrunctubs] = "TruncatedTube";
  solidShape_[DDSolidShape::ddsphere] = "Sphere";
  solidShape_[DDSolidShape::ddellipticaltube] = "EllipticalTube";
  solidShape_[DDSolidShape::ddcuttubs] = "CutTubs";
  solidShape_[DDSolidShape::ddextrudedpolygon] = "ExtrudedPolygon";
  solidShape_[DDSolidShape::dd_not_init] = "Unknown";
}

void PrintGeomSummary::registerConsumes(edm::ConsumesCollector cc) {
  ddcompToken_ = cc.esConsumes<DDCompactView, IdealGeometryRecord, edm::Transition::BeginRun>();
  G4cout << "PrintGeomSummary::Initialize ESGetToken for DDCompactView" << G4endl;
}

void PrintGeomSummary::beginRun(edm::EventSetup const& es) {
  const DDCompactView* cpv = &es.getData(ddcompToken_);

  const auto& gra = cpv->graph();

  using Graph = DDCompactView::Graph;
  using adjl_iterator = Graph::const_adj_iterator;

  Graph::index_type i = 0;
  solidMap_.clear();
  for (adjl_iterator git = gra.begin(); git != gra.end(); ++git) {
    const DDLogicalPart& ddLP = gra.nodeData(git);
    addSolid(ddLP);
    ++i;
    if (!git->empty()) {
      // ask for children of ddLP
      for (Graph::edge_list::const_iterator cit = git->begin(); cit != git->end(); ++cit) {
        const DDLogicalPart& ddcurLP = gra.nodeData(cit->first);
        addSolid(ddcurLP);
      }
    }
  }
  G4cout << "Finds " << solidMap_.size() << " different solids in the tree" << G4endl;
}

void PrintGeomSummary::update(const BeginOfRun* run) {
  theTopPV_ = getTopPV();
  if (theTopPV_) {
    lvs_.clear();
    sls_.clear();
    touch_.clear();
    fillLV(theTopPV_->GetLogicalVolume());
    std::string name = theTopPV_->GetName();
    dumpSummary(G4cout, name);

    pvs_.clear();
    fillPV(theTopPV_);
    G4cout << " Number of G4VPhysicalVolume's for " << name << ": " << pvs_.size() << G4endl;

    for (unsigned int k = 0; k < nodeNames_.size(); ++k) {
      const G4LogicalVolumeStore* lvs = G4LogicalVolumeStore::GetInstance();
      std::vector<G4LogicalVolume*>::const_iterator lvcite;
      for (lvcite = lvs->begin(); lvcite != lvs->end(); lvcite++) {
        if ((*lvcite)->GetName() == (G4String)(nodeNames_[k])) {
          lvs_.clear();
          sls_.clear();
          touch_.clear();
          fillLV(*lvcite);
          dumpSummary(G4cout, nodeNames_[k]);
        }
      }
      const G4PhysicalVolumeStore* pvs = G4PhysicalVolumeStore::GetInstance();
      std::vector<G4VPhysicalVolume*>::const_iterator pvcite;
      for (pvcite = pvs->begin(); pvcite != pvs->end(); pvcite++) {
        if ((*pvcite)->GetName() == (G4String)(nodeNames_[k])) {
          pvs_.clear();
          fillPV(*pvcite);
          G4cout << " Number of G4VPhysicalVolume's for " << nodeNames_[k] << ": " << pvs_.size() << G4endl;
        }
      }
    }
  }
}

void PrintGeomSummary::addSolid(const DDLogicalPart& part) {
  const DDSolid& solid = part.solid();
  std::map<DDSolidShape, std::string>::iterator it = solidShape_.find(solid.shape());
  std::string name = solid.name().name();
  if (it == solidShape_.end())
    solidMap_[name] = DDSolidShape::dd_not_init;
  else
    solidMap_[name] = it->first;
  //G4cout << "Solid " << name << " is of shape " << solidMap_[name] << G4endl;
}

void PrintGeomSummary::fillLV(G4LogicalVolume* lv) {
  if (std::find(lvs_.begin(), lvs_.end(), lv) == lvs_.end())
    lvs_.push_back(lv);
  G4VSolid* sl = lv->GetSolid();
  if (std::find(sls_.begin(), sls_.end(), sl) == sls_.end())
    sls_.push_back(sl);
  touch_.push_back(lv);
  for (int ii = 0; ii < (int)(lv->GetNoDaughters()); ii++)
    fillLV(lv->GetDaughter(ii)->GetLogicalVolume());
}

void PrintGeomSummary::fillPV(G4VPhysicalVolume* pv) {
  if (std::find(pvs_.begin(), pvs_.end(), pv) == pvs_.end())
    pvs_.push_back(pv);
  for (int ii = 0; ii < (int)(pv->GetLogicalVolume()->GetNoDaughters()); ii++)
    fillPV(pv->GetLogicalVolume()->GetDaughter(ii));
}

void PrintGeomSummary::dumpSummary(std::ostream& out, std::string name) {
  //---------- Dump number of objects of each class
  out << G4endl << G4endl << "@@@@@@@@@@@@@@@@@@ Dumping Summary For Node " << name << G4endl;
  out << " Number of G4VSolid's: " << sls_.size() << G4endl;
  out << " Number of G4LogicalVolume's: " << lvs_.size() << G4endl;
  out << " Number of Touchable's: " << touch_.size() << G4endl;
  //First the solids
  out << G4endl << "Occurence of each type of shape among Solids" << G4endl;
  kount_.clear();
  for (std::vector<G4VSolid*>::iterator it = sls_.begin(); it != sls_.end(); ++it) {
    std::string name = (*it)->GetName();
    addName(name);
  }
  printSummary(out);
  //Then the logical volumes
  out << G4endl << "Occurence of each type of shape among Logical Volumes" << G4endl;
  kount_.clear();
  for (std::vector<G4LogicalVolume*>::iterator it = lvs_.begin(); it != lvs_.end(); ++it) {
    std::string name = ((*it)->GetSolid())->GetName();
    addName(name);
  }
  printSummary(out);
  //Finally the touchables
  out << G4endl << "Occurence of each type of shape among Touchables" << G4endl;
  kount_.clear();
  for (std::vector<G4LogicalVolume*>::iterator it = touch_.begin(); it != touch_.end(); ++it) {
    std::string name = ((*it)->GetSolid())->GetName();
    addName(name);
  }
  printSummary(out);
}

G4VPhysicalVolume* PrintGeomSummary::getTopPV() {
  return G4TransportationManager::GetTransportationManager()->GetNavigatorForTracking()->GetWorldVolume();
}

void PrintGeomSummary::addName(std::string name) {
  bool refl(false);
  if (name.find("_refl") < name.size()) {
    refl = true;
    name = name.substr(0, (name.find("_refl")));
  }
  std::map<std::string, DDSolidShape>::const_iterator jt = solidMap_.find(name);
  DDSolidShape shape = (jt == solidMap_.end()) ? DDSolidShape::dd_not_init : jt->second;
  std::map<DDSolidShape, std::pair<int, int>>::iterator itr = kount_.find(shape);
  if (itr == kount_.end()) {
    kount_[shape] = (refl) ? std::pair<int, int>(0, 1) : std::pair<int, int>(1, 0);
  } else {
    kount_[shape] = (refl) ? std::pair<int, int>(((itr->second).first), ++((itr->second).second))
                           : std::pair<int, int>(++((itr->second).first), ((itr->second).second));
  }
}

void PrintGeomSummary::printSummary(std::ostream& out) {
  int k(0);
  for (std::map<DDSolidShape, std::pair<int, int>>::iterator itr = kount_.begin(); itr != kount_.end(); ++itr, ++k) {
    std::string shape = solidShape_[itr->first];
    out << "Shape [" << k << "]  " << shape << " # " << (itr->second).first << " : " << (itr->second).second << G4endl;
  }
}

#include "SimG4Core/Watcher/interface/SimWatcherFactory.h"
#include "FWCore/PluginManager/interface/ModuleDef.h"

DEFINE_SIMWATCHER(PrintGeomSummary);