Pythia8Interface/src/Py8HMC3InterfaceBase.cc

0001 #include <memory>
0002 #include <string>
0003
0004 #include "GeneratorInterface/Pythia8Interface/interface/Py8HMC3InterfaceBase.h"
0005 #include "GeneratorInterface/Pythia8Interface/interface/SLHAReaderBase.h"
0006
0007 #include "FWCore/Utilities/interface/Exception.h"
0008 #include "FWCore/MessageLogger/interface/MessageLogger.h"
0009 #include <filesystem>
0010
0011 using namespace Pythia8;
0012
0013 namespace gen {
0014
0015   Py8HMC3InterfaceBase::Py8HMC3InterfaceBase(edm::ParameterSet const& ps)
0016       : BaseHadronizer(ps), useEvtGen(false), evtgenDecays(nullptr) {
0017     fParameters = ps;
0018
0019     pythiaPylistVerbosity = ps.getUntrackedParameter<int>("pythiaPylistVerbosity", 0);
0020     pythiaHepMCVerbosity = ps.getUntrackedParameter<bool>("pythiaHepMCVerbosity", false);
0021     pythiaHepMCVerbosityParticles = ps.getUntrackedParameter<bool>("pythiaHepMCVerbosityParticles", false);
0022     maxEventsToPrint = ps.getUntrackedParameter<int>("maxEventsToPrint", 0);
0023     p8RndmEngine_ = std::make_shared<P8RndmEngine>();
0024
0025     //if (pythiaHepMCVerbosityParticles)
0026     //  ascii_io = new HepMC::IO_AsciiParticles("cout", std::ios::out);
0027
0028     if (ps.exists("useEvtGenPlugin")) {
0029       useEvtGen = true;
0030       auto env = std::getenv("EVTGENDATA");
0031       if (not env) {
0032         throw cms::Exception("EvtGenMissingEnv") << "The environment variable EVTGENDATA must be defined";
0033       }
0034       string evtgenpath(env);
0035       evtgenDecFile = evtgenpath + string("/DECAY_2010.DEC");
0036       evtgenPdlFile = evtgenpath + string("/evt.pdl");
0037
0038       if (ps.exists("evtgenDecFile")) {
0039         edm::FileInPath decay_table(ps.getParameter<std::string>("evtgenDecFile"));
0040         evtgenDecFile = decay_table.fullPath();
0041       }
0042
0043       if (ps.exists("evtgenPdlFile")) {
0044         edm::FileInPath pdt(ps.getParameter<std::string>("evtgenPdlFile"));
0045         evtgenPdlFile = pdt.fullPath();
0046       }
0047
0048       if (ps.exists("evtgenUserFile")) {
0049         std::vector<std::string> user_decays = ps.getParameter<std::vector<std::string> >("evtgenUserFile");
0050         for (unsigned int i = 0; i < user_decays.size(); i++) {
0051           edm::FileInPath user_decay(user_decays.at(i));
0052           evtgenUserFiles.push_back(user_decay.fullPath());
0053         }
0054       }
0055
0056       if (ps.exists("evtgenUserFileEmbedded")) {
0057         std::vector<std::string> user_decay_lines =
0058             ps.getParameter<std::vector<std::string> >("evtgenUserFileEmbedded");
0059         char tempslhaname[] = "pythia8evtgenXXXXXX";
0060         int fd = mkstemp(tempslhaname);
0061
0062         for (unsigned int i = 0; i < user_decay_lines.size(); i++) {
0063           user_decay_lines.at(i) += "\n";
0064           write(fd, user_decay_lines.at(i).c_str(), user_decay_lines.at(i).size());
0065         }
0066         close(fd);
0067         evtgenUserFiles.push_back(std::string(tempslhaname));
0068       }
0069     }
0070   }
0071
0072   bool Py8HMC3InterfaceBase::readSettings(int) {
0073     //Pythia 8's default value for first argument to constructor
0074     const string xmlDir = "../share/Pythia8/xmldoc";
0075     bool printBanner = true;
0076     if (fParameters.exists("printBanner")) {
0077       printBanner = fParameters.getUntrackedParameter<bool>("printBanner");
0078     }
0079     if (!fMasterGen.get())
0080       fMasterGen = std::make_unique<Pythia>(xmlDir, printBanner);
0081     fDecayer = std::make_unique<Pythia>(xmlDir, printBanner);
0082
0083     //add settings for resonance decay filter
0084     fMasterGen->settings.addFlag("BiasedTauDecayer:filter", false);
0085     fMasterGen->settings.addFlag("BiasedTauDecayer:eDecays", true);
0086     fMasterGen->settings.addFlag("BiasedTauDecayer:muDecays", true);
0087
0088     //add settings for resonance decay filter
0089     fMasterGen->settings.addFlag("ResonanceDecayFilter:filter", false);
0090     fMasterGen->settings.addFlag("ResonanceDecayFilter:exclusive", false);
0091     fMasterGen->settings.addFlag("ResonanceDecayFilter:eMuAsEquivalent", false);
0092     fMasterGen->settings.addFlag("ResonanceDecayFilter:eMuTauAsEquivalent", false);
0093     fMasterGen->settings.addFlag("ResonanceDecayFilter:allNuAsEquivalent", false);
0094     fMasterGen->settings.addFlag("ResonanceDecayFilter:udscAsEquivalent", false);
0095     fMasterGen->settings.addFlag("ResonanceDecayFilter:udscbAsEquivalent", false);
0096     fMasterGen->settings.addFlag("ResonanceDecayFilter:wzAsEquivalent", false);
0097     fMasterGen->settings.addMVec("ResonanceDecayFilter:mothers", std::vector<int>(), false, false, 0, 0);
0098     fMasterGen->settings.addMVec("ResonanceDecayFilter:daughters", std::vector<int>(), false, false, 0, 0);
0099
0100     //add settings for PT filter
0101     fMasterGen->settings.addFlag("PTFilter:filter", false);
0102     fMasterGen->settings.addMode("PTFilter:quarkToFilter", 5, true, true, 3, 6);
0103     fMasterGen->settings.addParm("PTFilter:scaleToFilter", 0.4, true, true, 0.0, 10.);
0104     fMasterGen->settings.addParm("PTFilter:quarkRapidity", 10.0, true, true, 0.0, 10.);
0105     fMasterGen->settings.addParm("PTFilter:quarkPt", -.1, true, true, -.1, 100.);
0106
0107     //add settings for RecoilToTop tool
0108     fMasterGen->settings.addFlag("TopRecoilHook:doTopRecoilIn", false);
0109     fMasterGen->settings.addFlag("TopRecoilHook:useOldDipoleIn", false);
0110     fMasterGen->settings.addFlag("TopRecoilHook:doListIn", false);
0111
0112     //add settings for powheg resonance scale calculation
0113     fMasterGen->settings.addFlag("POWHEGres:calcScales", false);
0114     fMasterGen->settings.addFlag("POWHEG:bb4l", false);
0115     fMasterGen->settings.addFlag("POWHEG:bb4l:FSREmission:veto", false);
0116     fMasterGen->settings.addFlag("POWHEG:bb4l:FSREmission:vetoQED", false);
0117     fMasterGen->settings.addFlag("POWHEG:bb4l:DEBUG", false);
0118     fMasterGen->settings.addFlag("POWHEG:bb4l:ScaleResonance:veto", false);
0119     fMasterGen->settings.addFlag("POWHEG:bb4l:FSREmission:vetoDipoleFrame", false);
0120     fMasterGen->settings.addFlag("POWHEG:bb4l:FSREmission:pTpythiaVeto", false);
0121     fMasterGen->settings.addParm("POWHEG:bb4l:pTminVeto", 10.0, true, true, 0.0, 10.);
0122     fMasterGen->settings.addFlag("POWHEG:bb4l:vetoAllRadtypes", false);
0123
0124     fMasterGen->setRndmEnginePtr(p8RndmEngine_);
0125     fDecayer->setRndmEnginePtr(p8RndmEngine_);
0126
0127     fMasterGen->readString("Next:numberShowEvent = 0");
0128     fDecayer->readString("Next:numberShowEvent = 0");
0129
0130     edm::ParameterSet currentParameters;
0131     if (randomIndex() >= 0) {
0132       std::vector<edm::ParameterSet> randomizedParameters =
0133           fParameters.getParameter<std::vector<edm::ParameterSet> >("RandomizedParameters");
0134       currentParameters = randomizedParameters[randomIndex()];
0135     } else {
0136       currentParameters = fParameters;
0137     }
0138
0139     ParameterCollector pCollector = currentParameters.getParameter<edm::ParameterSet>("PythiaParameters");
0140
0141     for (ParameterCollector::const_iterator line = pCollector.begin(); line != pCollector.end(); ++line) {
0142       if (line->find("Random:") != std::string::npos)
0143         throw cms::Exception("PythiaError") << "Attempted to set random number "
0144                                                "using Pythia commands. Please use "
0145                                                "the RandomNumberGeneratorService."
0146                                             << std::endl;
0147
0148       if (!fMasterGen->readString(*line))
0149         throw cms::Exception("PythiaError") << "Pythia 8 did not accept \"" << *line << "\"." << std::endl;
0150
0151       if (line->find("ParticleDecays:") != std::string::npos) {
0152         if (!fDecayer->readString(*line))
0153           throw cms::Exception("PythiaError") << "Pythia 8 Decayer did not accept \"" << *line << "\"." << std::endl;
0154       }
0155     }
0156
0157     slhafile_.clear();
0158
0159     if (currentParameters.exists("SLHAFileForPythia8")) {
0160       std::string slhafilenameshort = currentParameters.getParameter<std::string>("SLHAFileForPythia8");
0161       edm::FileInPath f1(slhafilenameshort);
0162
0163       fMasterGen->settings.mode("SLHA:readFrom", 2);
0164       fMasterGen->settings.word("SLHA:file", f1.fullPath());
0165     } else if (currentParameters.exists("SLHATableForPythia8")) {
0166       std::string slhatable = currentParameters.getParameter<std::string>("SLHATableForPythia8");
0167
0168       makeTmpSLHA(slhatable);
0169     } else if (currentParameters.exists("SLHATreeForPythia8")) {
0170       auto slhaReaderParams = currentParameters.getParameter<edm::ParameterSet>("SLHATreeForPythia8");
0171       std::unique_ptr<SLHAReaderBase> reader =
0172           SLHAReaderFactory::get()->create(slhaReaderParams.getParameter<std::string>("name"), slhaReaderParams);
0173
0174       makeTmpSLHA(reader->getSLHA(currentParameters.getParameter<std::string>("ConfigDescription")));
0175     }
0176
0177     return true;
0178   }
0179
0180   void Py8HMC3InterfaceBase::makeTmpSLHA(const std::string& slhatable) {
0181     char tempslhaname[] = "pythia8SLHAtableXXXXXX";
0182     int fd = mkstemp(tempslhaname);
0183     write(fd, slhatable.c_str(), slhatable.size());
0184     close(fd);
0185
0186     slhafile_ = tempslhaname;
0187
0188     fMasterGen->settings.mode("SLHA:readFrom", 2);
0189     fMasterGen->settings.word("SLHA:file", slhafile_);
0190   }
0191
0192   bool Py8HMC3InterfaceBase::declareStableParticles(const std::vector<int>& pdgIds) {
0193     for (size_t i = 0; i < pdgIds.size(); i++) {
0194       int PyID = pdgIds[i];
0195       std::ostringstream pyCard;
0196       pyCard << PyID << ":mayDecay=false";
0197
0198       if (fMasterGen->particleData.isParticle(PyID)) {
0199         fMasterGen->readString(pyCard.str());
0200       } else {
0201         edm::LogWarning("DataNotUnderstood") << "Pythia8 does not "
0202                                              << "recognize particle id = " << PyID << std::endl;
0203       }
0204       // alternative:
0205       // set the 2nd input argument warn=false
0206       // - this way Py8 will NOT print warnings about unknown particle code(s)
0207       // fMasterPtr->readString( pyCard.str(), false )
0208     }
0209
0210     return true;
0211   }
0212
0213   bool Py8HMC3InterfaceBase::declareSpecialSettings(const std::vector<std::string>& settings) {
0214     for (unsigned int iss = 0; iss < settings.size(); iss++) {
0215       if (settings[iss].find("QED-brem-off") != std::string::npos) {
0216         fMasterGen->readString("TimeShower:QEDshowerByL=off");
0217       } else {
0218         size_t fnd1 = settings[iss].find("Pythia8:");
0219         if (fnd1 != std::string::npos) {
0220           std::string value = settings[iss].substr(fnd1 + 8);
0221           fDecayer->readString(value);
0222         }
0223       }
0224     }
0225     return true;
0226   }
0227
0228   void Py8HMC3InterfaceBase::statistics() {
0229     fMasterGen->stat();
0230     return;
0231   }
0232
0233 }  // namespace gen