PrintMaterialBudgetInfo Class Reference

Inheritance diagram for PrintMaterialBudgetInfo:

Public Member Functions
	PrintMaterialBudgetInfo (edm::ParameterSet const &p)
	~PrintMaterialBudgetInfo () override
Public Member Functions inherited from SimWatcher
virtual void	beginRun (edm::EventSetup const &)
bool	isMT () const
const SimWatcher &	operator= (const SimWatcher &)=delete
virtual void	registerConsumes (edm::ConsumesCollector)
	SimWatcher ()
	SimWatcher (const SimWatcher &)=delete
virtual	~SimWatcher ()
Public Member Functions inherited from Observer< const BeginOfJob *>
	Observer ()
void	slotForUpdate (const BeginOfJob * iT)
virtual	~Observer ()
Public Member Functions inherited from Observer< const BeginOfRun *>
	Observer ()
void	slotForUpdate (const BeginOfRun * iT)
virtual	~Observer ()

Private Member Functions
void	dumpElementMassFraction (std::ostream &elementOut=G4cout)
void	dumpHeader (std::ostream &out=G4cout)
void	dumpHierarchyLeaf (G4VPhysicalVolume *pv, G4LogicalVolume *lv, unsigned int leafDepth, std::ostream &weightOut=G4cout, std::ostream &texOut=G4cout)
void	dumpLaTeXFooter (std::ostream &out=G4cout)
void	dumpLaTeXHeader (std::ostream &out=G4cout)
void	printInfo (G4VPhysicalVolume *pv, G4LogicalVolume *lv, unsigned int leafDepth, std::ostream &weightOut=G4cout, std::ostream &texOut=G4cout)
std::string	stringLaTeXSuperscript (std::string stringname)
std::string	stringLaTeXUnderscore (std::string stringname)
void	update (const BeginOfJob *job) override
	This routine will be called when the appropriate signal arrives. More...
void	update (const BeginOfRun *run) override
	This routine will be called when the appropriate signal arrives. More...

Private Attributes
std::vector< std::string >	elementNames
std::ofstream	elementOutputFile
std::vector< double >	elementTotalWeight
std::vector< double >	elementWeightFraction
G4NavigationHistory	fHistory
unsigned int	levelFound
std::string	name
int	nchar
std::ofstream	texOutputFile
mpvpv	thePVTree
bool	volumeFound
std::ofstream	weightOutputFile

Additional Inherited Members
Protected Member Functions inherited from SimWatcher
void	setMT (bool val)

Detailed Description

Definition at line 41 of file PrintMaterialBudgetInfo.cc.

Constructor & Destructor Documentation

PrintMaterialBudgetInfo()

PrintMaterialBudgetInfo::PrintMaterialBudgetInfo

(

edm::ParameterSet const &

p

)

Definition at line 84 of file PrintMaterialBudgetInfo.cc.

References elementNames, elementOutputFile, elementTotalWeight, elementWeightFraction, ecalTB2006H4_GenSimDigiReco_cfg::G4cout, name, nchar, AlCaHLTBitMon_ParallelJobs::p, AlCaHLTBitMon_QueryRunRegistry::string, texOutputFile, volumeFound, and weightOutputFile.

                                                                         {
  name = p.getUntrackedParameter<std::string>("Name", "*");
  nchar = name.find('*');
  name.assign(name, 0, nchar);
  G4cout << "PrintMaterialBudget selected volume " << name << G4endl;
  volumeFound = false;
  std::string weightFileName = name + ".weight";
  weightOutputFile.open(weightFileName.c_str());
  std::string elementFileName = name + ".element";
  elementOutputFile.open(elementFileName.c_str());
  std::string texFileName = name + "_table.tex";
  texOutputFile.open(texFileName.c_str());
  G4cout << "PrintMaterialBudget output file " << weightFileName << G4endl;
  G4cout << "PrintMaterialBudget output file " << elementFileName << G4endl;
  G4cout << "PrintMaterialBudget output file " << texFileName << G4endl;
  elementNames.clear();
  elementTotalWeight.clear();
  elementWeightFraction.clear();
}

~PrintMaterialBudgetInfo()

PrintMaterialBudgetInfo::~PrintMaterialBudgetInfo ( )

override

Definition at line 104 of file PrintMaterialBudgetInfo.cc.

{}

Member Function Documentation

dumpElementMassFraction()

void PrintMaterialBudgetInfo::dumpElementMassFraction ( std::ostream &  elementOut = G4cout )

private

Definition at line 289 of file PrintMaterialBudgetInfo.cc.

References mps_setup::append, elementNames, elementTotalWeight, elementWeightFraction, createfilelist::int, findQualityFiles::size, and generateEDF::totalWeight.

Referenced by update().

                                                                            {
  // calculate mass fraction
  double totalWeight = 0.0;
  double totalFraction = 0.0;
  for (unsigned int iElement = 0; iElement < (unsigned int)elementTotalWeight.size(); iElement++) {
    totalWeight += elementTotalWeight[iElement];
  }
  // calculate element mass fractions
  for (unsigned int iElement = 0; iElement < (unsigned int)elementTotalWeight.size(); iElement++) {
    elementWeightFraction[iElement] = elementTotalWeight[iElement] / totalWeight;
    totalFraction += elementWeightFraction[iElement];
  }
  // header
  elementOut << "Element"
             << "\t\t"
             << "Index"
             << "\t"
             << "Total Mass"
             << "\t"
             << "Mass Fraction "
             << "\t" << G4endl;
  // dump
  for (unsigned int iElement = 0; iElement < (unsigned int)elementTotalWeight.size(); iElement++) {
    if (elementNames[iElement] != "rr") {
      if (elementNames[iElement].size() < 8)
        elementNames[iElement].append("\t");
      elementOut << elementNames[iElement] << "\t" << iElement << "\t"
                 << G4BestUnit(elementTotalWeight[iElement], "Mass") << "\t" << elementWeightFraction[iElement]
                 << G4endl;
    }
  }
  elementOut << "\n\t\tTotal Weight without Air " << G4BestUnit(totalWeight, "Mass") << "\tTotal Fraction "
             << totalFraction << G4endl;
}

dumpHeader()

void PrintMaterialBudgetInfo::dumpHeader ( std::ostream &  out = G4cout )

private

Definition at line 132 of file PrintMaterialBudgetInfo.cc.

References MillePedeFileConverter_cfg::out.

Referenced by update().

                                                        {
  out << "Geom."
      << "\t"
      << "Volume"
      << "\t"
      << "\t"
      << "Copy"
      << "\t"
      << "Solid"
      << "\t"
      << "\t"
      << "Material"
      << "\t"
      << "Density"
      << "\t"
      << "\t"
      << "Mass"
      << "\t"
      << "\t" << G4endl;
  out << "Level"
      << "\t"
      << "Name"
      << "\t"
      << "\t"
      << "Number"
      << "\t"
      << "Name"
      << "\t"
      << "\t"
      << "Name"
      << "\t"
      << "\t"
      << "[g/cm3]"
      << "\t"
      << "\t"
      << "[g]    "
      << "\t"
      << "\t" << G4endl;
}

dumpHierarchyLeaf()

void PrintMaterialBudgetInfo::dumpHierarchyLeaf ( G4VPhysicalVolume *  pv, G4LogicalVolume *  lv, unsigned int  leafDepth, std::ostream &  weightOut = G4cout, std::ostream &  texOut = G4cout  )

private

Definition at line 211 of file PrintMaterialBudgetInfo.cc.

References levelFound, name, nchar, printInfo(), AlCaHLTBitMon_QueryRunRegistry::string, and volumeFound.

Referenced by update().

                                                                                                                   {
  if (volumeFound && (leafDepth <= levelFound))
    return;
  if (volumeFound && (leafDepth > levelFound))
    printInfo(pv, lv, leafDepth, weightOut, texOut);

  // choose mother volume
  std::string lvname = lv->GetName();
  lvname.assign(lvname, 0, nchar);
  if (lvname == name) {
    volumeFound = true;
    levelFound = leafDepth;
    printInfo(pv, lv, leafDepth, weightOut, texOut);
    texOut << "      \\hline" << G4endl;
  }

  //----- Get LV daughters from list of PV daughters
  mmlvpv lvpvDaughters;
  std::set<G4LogicalVolume*> lvDaughters;
  int NoDaughters = lv->GetNoDaughters();
  while ((NoDaughters--) > 0) {
    G4VPhysicalVolume* pvD = lv->GetDaughter(NoDaughters);
    lvpvDaughters.insert(mmlvpv::value_type(pvD->GetLogicalVolume(), pvD));
    lvDaughters.insert(pvD->GetLogicalVolume());
  }

  std::set<G4LogicalVolume*>::const_iterator scite;
  mmlvpv::const_iterator mmcite;

  //----- Dump daughters PV and LV
  for (scite = lvDaughters.begin(); scite != lvDaughters.end(); scite++) {
    std::pair<mmlvpv::iterator, mmlvpv::iterator> mmER = lvpvDaughters.equal_range(*scite);
    //----- Dump daughters PV of this LV
    for (mmcite = mmER.first; mmcite != mmER.second; mmcite++)
      dumpHierarchyLeaf((*mmcite).second, *scite, leafDepth + 1, weightOut, texOut);
  }
}

dumpLaTeXFooter()

void PrintMaterialBudgetInfo::dumpLaTeXFooter ( std::ostream &  out = G4cout )

private

Definition at line 206 of file PrintMaterialBudgetInfo.cc.

References MillePedeFileConverter_cfg::out.

Referenced by update().

                                                             {
  out << "      \\hline" << G4endl << "    \\end{tabular}" << G4endl << "  \\end{center}" << G4endl << "\\end{table}"
      << G4endl;
}

dumpLaTeXHeader()

void PrintMaterialBudgetInfo::dumpLaTeXHeader ( std::ostream &  out = G4cout )

private

Definition at line 172 of file PrintMaterialBudgetInfo.cc.

References name, and MillePedeFileConverter_cfg::out.

Referenced by update().

                                                             {
  out << "\\begin{table}[h!]" << G4endl << "  \\caption{\\textsf {" << name << "} volume list.}" << G4endl
      << "  \\label{tab: " << name << "}" << G4endl << "  \\begin{center}" << G4endl << "    \\begin{tabular}{ccccccc}"
      << G4endl << "      \\hline" << G4endl;
  out << "      Geom."
      << "\t & "
      << "      Volume"
      << "\t & "
      << "      Copy"
      << "\t & "
      << "      Solid"
      << "\t & "
      << "      Material"
      << "\t & "
      << "      Density"
      << "\t & "
      << "      Mass"
      << "\t \\\\ " << G4endl;
  out << "      Level"
      << "\t & "
      << "      Name"
      << "\t & "
      << "      Number"
      << "\t & "
      << "      Name"
      << "\t & "
      << "      Name"
      << "\t & "
      << "                "
      << "\t & "
      << "                "
      << "\t \\\\ " << G4endl << "      \\hline\\hline" << G4endl;
}

printInfo()

void PrintMaterialBudgetInfo::printInfo ( G4VPhysicalVolume *  pv, G4LogicalVolume *  lv, unsigned int  leafDepth, std::ostream &  weightOut = G4cout, std::ostream &  texOut = G4cout  )

private

Definition at line 250 of file PrintMaterialBudgetInfo.cc.

References fastSimProducer_cff::density, elementNames, elementTotalWeight, createfilelist::int, AlCaHLTBitMon_QueryRunRegistry::string, stringLaTeXSuperscript(), and stringLaTeXUnderscore().

Referenced by dumpHierarchyLeaf().

                                                                                                                   {
  double density = lv->GetMaterial()->GetDensity();
  double weight = lv->GetMass(false, false);

  std::string volumeName = lv->GetName();
  if (volumeName.size() < 8)
    volumeName.append("\t");

  std::string solidName = lv->GetSolid()->GetName();
  if (solidName.size() < 8)
    solidName.append("\t");

  std::string materialName = lv->GetMaterial()->GetName();
  if (materialName.size() < 8)
    materialName.append("\t");

  //----- dump info
  weightOut << leafDepth << "\t" << volumeName << "\t" << pv->GetCopyNo() << "\t" << solidName << "\t" << materialName
            << "\t" << G4BestUnit(density, "Volumic Mass") << "\t" << G4BestUnit(weight, "Mass") << "\t" << G4endl;
  //
  texOut << "\t" << leafDepth << "\t & " << stringLaTeXUnderscore(volumeName) << "\t & " << pv->GetCopyNo() << "\t & "
         << stringLaTeXUnderscore(solidName) << "\t & " << stringLaTeXUnderscore(materialName) << "\t & "
         << stringLaTeXSuperscript(G4BestUnit(density, "Volumic Mass")) << "\t & "
         << stringLaTeXSuperscript(G4BestUnit(weight, "Mass")) << "\t \\\\ " << G4endl;
  //
  for (unsigned int iElement = 0; iElement < (unsigned int)lv->GetMaterial()->GetNumberOfElements(); iElement++) {
    // exclude Air in element weight fraction computation
    if (materialName.find("Air")) {
      std::string elementName = lv->GetMaterial()->GetElement(iElement)->GetName();
      double elementMassFraction = lv->GetMaterial()->GetFractionVector()[iElement];
      double elementWeight = weight * elementMassFraction;
      unsigned int elementIndex = (unsigned int)lv->GetMaterial()->GetElement(iElement)->GetIndex();
      elementNames[elementIndex] = elementName;
      elementTotalWeight[elementIndex] += elementWeight;
    }
  }
}

stringLaTeXSuperscript()

std::string PrintMaterialBudgetInfo::stringLaTeXSuperscript ( std::string  stringname )

private

Definition at line 339 of file PrintMaterialBudgetInfo.cc.

References mps_fire::i, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by printInfo().

                                                                              {
  // To replace 'm3' with 'm$^3$' to compile LaTeX output
  std::string stringoutput = stringname.substr(0, 1);

  for (unsigned int i = 1; i < stringname.length(); i++) {
    if (stringname.substr(i - 1, 1) == "m" && stringname.substr(i, 1) == "3") {
      stringoutput += "$^3$";
    } else {
      stringoutput += stringname.substr(i, 1);
    }
  }

  return stringoutput;
}

stringLaTeXUnderscore()

std::string PrintMaterialBudgetInfo::stringLaTeXUnderscore ( std::string  stringname )

private

Definition at line 324 of file PrintMaterialBudgetInfo.cc.

References mps_fire::i, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by printInfo().

                                                                             {
  // To replace '\' with '\_' to compile LaTeX output
  std::string stringoutput;

  for (unsigned int i = 0; i < stringname.length(); i++) {
    if (stringname.substr(i, 1) == "_") {
      stringoutput += "\\_";
    } else {
      stringoutput += stringname.substr(i, 1);
    }
  }

  return stringoutput;
}

update() [1/2]

void PrintMaterialBudgetInfo::update ( const BeginOfJob *  )

inlineoverrideprivatevirtual

This routine will be called when the appropriate signal arrives.

Implements Observer< const BeginOfJob *>.

Definition at line 49 of file PrintMaterialBudgetInfo.cc.

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), progressbar.ProgressBar::finish(), and MatrixUtil.Steps::overwrite().

{}

update() [2/2]

void PrintMaterialBudgetInfo::update ( const BeginOfRun *  )

overrideprivatevirtual

This routine will be called when the appropriate signal arrives.

Implements Observer< const BeginOfRun *>.

Definition at line 106 of file PrintMaterialBudgetInfo.cc.

References cms::cuda::assert(), dumpElementMassFraction(), dumpHeader(), dumpHierarchyLeaf(), dumpLaTeXFooter(), dumpLaTeXHeader(), elementNames, elementOutputFile, elementTotalWeight, elementWeightFraction, suppress, texOutputFile, and weightOutputFile.

Referenced by progressbar.ProgressBar::__next__(), MatrixUtil.Matrix::__setitem__(), MatrixUtil.Steps::__setitem__(), progressbar.ProgressBar::finish(), and MatrixUtil.Steps::overwrite().

                                                          {
  [[clang::suppress]] G4Random::setTheEngine(new CLHEP::RanecuEngine);
  // Physical Volume
  G4VPhysicalVolume* theTopPV =
      G4TransportationManager::GetTransportationManager()->GetNavigatorForTracking()->GetWorldVolume();
  assert(theTopPV);
  // Logical Volume
  G4LogicalVolume* lv = theTopPV->GetLogicalVolume();
  unsigned int leafDepth = 0;
  // the first time fill the vectors of elements
  if (elementNames.empty() && elementTotalWeight.empty() && elementWeightFraction.empty()) {
    for (unsigned int iElement = 0; iElement < G4Element::GetNumberOfElements();
         iElement++) {  // first element in table is 0
      elementNames.push_back("rr");
      elementTotalWeight.push_back(0);
      elementWeightFraction.push_back(0);
    }
  }
  dumpHeader(weightOutputFile);
  dumpLaTeXHeader(texOutputFile);
  dumpHierarchyLeaf(theTopPV, lv, leafDepth, weightOutputFile, texOutputFile);
  dumpElementMassFraction(elementOutputFile);
  dumpLaTeXFooter(texOutputFile);
  //
}

Member Data Documentation

elementNames

std::vector<std::string> PrintMaterialBudgetInfo::elementNames

private

Definition at line 76 of file PrintMaterialBudgetInfo.cc.

Referenced by dumpElementMassFraction(), printInfo(), PrintMaterialBudgetInfo(), and update().

elementOutputFile

std::ofstream PrintMaterialBudgetInfo::elementOutputFile

private

Definition at line 74 of file PrintMaterialBudgetInfo.cc.

Referenced by PrintMaterialBudgetInfo(), and update().

elementTotalWeight

std::vector<double> PrintMaterialBudgetInfo::elementTotalWeight

private

Definition at line 77 of file PrintMaterialBudgetInfo.cc.

Referenced by dumpElementMassFraction(), printInfo(), PrintMaterialBudgetInfo(), and update().

elementWeightFraction

std::vector<double> PrintMaterialBudgetInfo::elementWeightFraction

private

Definition at line 78 of file PrintMaterialBudgetInfo.cc.

Referenced by dumpElementMassFraction(), PrintMaterialBudgetInfo(), and update().

fHistory

G4NavigationHistory PrintMaterialBudgetInfo::fHistory

private

Definition at line 70 of file PrintMaterialBudgetInfo.cc.

levelFound

unsigned int PrintMaterialBudgetInfo::levelFound

private

Definition at line 72 of file PrintMaterialBudgetInfo.cc.

Referenced by dumpHierarchyLeaf().

name

std::string PrintMaterialBudgetInfo::name

private

Definition at line 67 of file PrintMaterialBudgetInfo.cc.

Referenced by dirstructure.Directory::__create_pie_image(), dqm_interfaces.DirID::__eq__(), dirstructure.Directory::__get_full_path(), dirstructure.Comparison::__get_img_name(), dirstructure.Comparison::__make_image(), dirstructure.Directory::__repr__(), dqm_interfaces.DirID::__repr__(), dirstructure.Comparison::__repr__(), config.CFG::__str__(), dirstructure.Directory::calcStats(), validation.Sample::digest(), dumpHierarchyLeaf(), dumpLaTeXHeader(), utils.StatisticalTest::get_status(), VIDSelectorBase.VIDSelectorBase::initialize(), dirstructure.Directory::print_report(), and PrintMaterialBudgetInfo().

nchar

int PrintMaterialBudgetInfo::nchar

private

Definition at line 68 of file PrintMaterialBudgetInfo.cc.

Referenced by dumpHierarchyLeaf(), and PrintMaterialBudgetInfo().

texOutputFile

std::ofstream PrintMaterialBudgetInfo::texOutputFile

private

Definition at line 75 of file PrintMaterialBudgetInfo.cc.

Referenced by PrintMaterialBudgetInfo(), and update().

thePVTree

mpvpv PrintMaterialBudgetInfo::thePVTree

private

Definition at line 69 of file PrintMaterialBudgetInfo.cc.

volumeFound

bool PrintMaterialBudgetInfo::volumeFound

private

Definition at line 71 of file PrintMaterialBudgetInfo.cc.

Referenced by dumpHierarchyLeaf(), and PrintMaterialBudgetInfo().

weightOutputFile

std::ofstream PrintMaterialBudgetInfo::weightOutputFile

private

Definition at line 73 of file PrintMaterialBudgetInfo.cc.

Referenced by PrintMaterialBudgetInfo(), and update().