Singleton class to load & serve a TDatabasePDG. More...

#include <PDGLibrary.h>

Collaboration diagram for genie::PDGLibrary:

Classes
struct	Cleaner

Public Member Functions
TDatabasePDG *	DBase (void)
TParticlePDG *	Find (int pdgc, bool must_exist=true)
void	ReloadDBase (void)
void	AddDarkMatter (double mass, double med_ratio)

Static Public Member Functions
static PDGLibrary *	Instance (void)

Private Member Functions
	PDGLibrary ()
	PDGLibrary (const PDGLibrary &config_pool)
virtual	~PDGLibrary ()
bool	LoadDBase (void)
bool	AddDarkSector ()
bool	AddHNL (void)

Private Attributes
TDatabasePDG *	fDatabasePDG

Static Private Attributes
static PDGLibrary *	fInstance = 0

Friends
struct	Cleaner

Detailed Description

Singleton class to load & serve a TDatabasePDG.

Author: Costas Andreopoulos <c.andreopoulos \at cern.ch> University of Liverpool

Changes required to implement the GENIE Boosted Dark Matter module were installed by Josh Berger (Univ. of Wisconsin)

Changes required to implement the GENIE Dark Neutrino module were installed by Iker de Icaza (Univ. of Sussex)

Changes required to implement the GENIE BeamHNL module were installed by John Plows (Univ. of Oxford)

Created:\n May 06, 2004

License:\n Copyright (c) 2003-2025, The GENIE Collaboration: For the full text of the license visit http://copyright.genie-mc.org

Definition at line 35 of file PDGLibrary.h.

Constructor & Destructor Documentation

◆ PDGLibrary() [1/2]

PDGLibrary::PDGLibrary ( )

private

Definition at line 40 of file PDGLibrary.cxx.

{
  if( ! LoadDBase() ) LOG("PDG", pERROR) << "Could not load PDG data";
 
#ifdef __GENIE_DARK_NEUTRINO_ENABLED__
  LOG("PDG", pINFO) << "Loading Dark sector Info";
  if ( ! AddDarkSector() ) { 
    LOG("PDG", pFATAL) << "Could not load Dark Neutrino data";
    exit(78);
  }
#endif // __GENIE_DARK_NEUTRINO_ENABLED__
 
#ifdef __GENIE_HEAVY_NEUTRAL_LEPTON_ENABLED__
  LOG("PDG", pINFO) << "Loading Heavy Neutral Lepton data";
  if( ! AddHNL() ){
    LOG("PDG", pFATAL) << "Could not load Heavy Neutral Lepton data";
    exit(78);
  }
#endif // #ifdef __GENIE_HEAVY_NEUTRAL_LEPTON_ENABLED__
  
  fInstance =  0;
}

References AddDarkSector(), AddHNL(), fInstance, LoadDBase(), LOG, pERROR, pFATAL, and pINFO.

Referenced by Instance(), and PDGLibrary().

◆ PDGLibrary() [2/2]

genie::PDGLibrary::PDGLibrary ( const PDGLibrary & config_pool )

private

References PDGLibrary().

◆ ~PDGLibrary()

PDGLibrary::~PDGLibrary ( )

privatevirtual

Definition at line 63 of file PDGLibrary.cxx.

{
  fInstance = 0;
}

References fInstance.

Member Function Documentation

◆ AddDarkMatter()

void PDGLibrary::AddDarkMatter	(	double	mass,
		double	med_ratio )

Definition at line 153 of file PDGLibrary.cxx.

{
// Add dark matter particle to PDG database
 
  double med_mass = mass*med_ratio;
  TParticlePDG * dm_particle = fDatabasePDG->GetParticle(kPdgDarkMatter);
  TParticlePDG * med_particle = fDatabasePDG->GetParticle(kPdgMediator);
  if (!dm_particle) {
    // Name Title Mass Stable Width Charge Class PDG
    fDatabasePDG->AddParticle("chi_dm","chi_dm",mass,true,0.,0,"DarkMatter",kPdgDarkMatter);
  }
  else {
    assert(dm_particle->Mass() == mass);
  }
  if (!med_particle) {
    // Name Title Mass Stable Width Charge Class PDG
    fDatabasePDG->AddParticle("Z_prime","Z_prime",med_mass,true,0.,0,"DarkMatter",kPdgMediator);
  }
  else {
    assert(med_particle->Mass() == med_mass);
  }
}

References fDatabasePDG, genie::kPdgDarkMatter, and genie::kPdgMediator.

Referenced by main().

◆ AddDarkSector()

bool PDGLibrary::AddDarkSector ( )

private

Definition at line 193 of file PDGLibrary.cxx.

{
  // Add dark neutrino particles to PDG database
 
  const Registry * reg = AlgConfigPool::Instance()->CommonList("Dark", "Masses");
  if(!reg) {
    LOG("PDG", pERROR) << "The Dark Sector masses not available.";
    return false;
  }
  TParticlePDG * dnu_particle = fDatabasePDG->GetParticle(kPdgDarkNeutrino);
  TParticlePDG * anti_dnu_particle = fDatabasePDG->GetParticle(kPdgAntiDarkNeutrino);
  TParticlePDG * med_particle = fDatabasePDG->GetParticle(kPdgDNuMediator);
  if (!dnu_particle) {
    // Name Title Mass Stable Width Charge Class PDG
    fDatabasePDG->AddParticle("nu_D","#nu_{D}",reg->GetDouble("Dark-NeutrinoMass"),
                              true,0.,0,"DarkNeutrino",kPdgDarkNeutrino);
  }
  if (!anti_dnu_particle) {
    // Name Title Mass Stable Width Charge Class PDG
    fDatabasePDG->AddParticle("nu_D_bar","#bar{#nu}_{D}",reg->GetDouble("Dark-NeutrinoMass"),
                              true,0.,0,"DarkNeutrino",kPdgAntiDarkNeutrino);
  }
  if (!med_particle) {
    // Name Title Mass Stable Width Charge Class PDG
    fDatabasePDG->AddParticle("Z_D","Z_{D}",reg->GetDouble("Dark-MediatorMass"),
                              true,0.,0,"DarkNeutrino",kPdgDNuMediator);
  }
  return true;
}

References genie::AlgConfigPool::CommonList(), fDatabasePDG, genie::Registry::GetDouble(), genie::AlgConfigPool::Instance(), genie::kPdgAntiDarkNeutrino, genie::kPdgDarkNeutrino, genie::kPdgDNuMediator, LOG, and pERROR.

Referenced by PDGLibrary().

◆ AddHNL()

bool PDGLibrary::AddHNL ( void )

private

Definition at line 176 of file PDGLibrary.cxx.

{
  // Add HNL to PDG database
  const Registry * reg = AlgConfigPool::Instance()->CommonList("HNL", "ParameterSpace");
  if (!reg) {
    LOG("PDG", pERROR) << "Cannot find HNL ParameterSpace param_set";
    return false;
  }
  TParticlePDG * hnl = fDatabasePDG->GetParticle(kPdgHNL);
  if (!hnl) {
    // Name Title Mass Stable Width Charge Class PDG
    fDatabasePDG->AddParticle("HNL","HNL",reg->GetDouble("HNL-Mass"),true,0.,0,"HNL",kPdgHNL);
    fDatabasePDG->AddParticle("HNLBar","HNLBar",reg->GetDouble("HNL-Mass"),true,0.,0,"HNL",-1*kPdgHNL);
  }
  return true;
}

References genie::AlgConfigPool::CommonList(), fDatabasePDG, genie::Registry::GetDouble(), genie::AlgConfigPool::Instance(), genie::kPdgHNL, LOG, and pERROR.

Referenced by PDGLibrary().

◆ DBase()

TDatabasePDG * PDGLibrary::DBase ( void )

Definition at line 81 of file PDGLibrary.cxx.

{
  return fDatabasePDG;
}

References fDatabasePDG.

Referenced by genie::evtlib::EventLibraryInterface::LoadRecords(), and genie::evtlib::EvtLibPXSec::LoadXSecs().

◆ Find()

TParticlePDG * PDGLibrary::Find	(	int	pdgc,
		bool	must_exist = true )

Definition at line 86 of file PDGLibrary.cxx.

{
 
  TParticlePDG * ret = fDatabasePDG->GetParticle(pdgc);
  if(ret) return ret;
 
  if ( must_exist ) {
    LOG("PDG", pERROR) << "Requested missing particle with PDG: " << pdgc ;
  }
 
  return ret ;
}

References fDatabasePDG, LOG, and pERROR.

Referenced by genie::HNIntranuke2018::AbsorbHN(), genie::HNIntranuke2025::AbsorbHN(), genie::CEvNSEventGenerator::AddFinalStateNeutrino(), genie::NNBarOscPrimaryVtxGenerator::AddInitialState(), genie::NucleonDecayPrimaryVtxGenerator::AddInitialState(), genie::InitialStateAppender::AddNucleus(), genie::AMNuGammaGenerator::AddRecoilNucleon(), genie::InitialStateAppender::AddStruckParticle(), genie::DMELEventGenerator::AddTargetNucleusRemnant(), genie::DMETargetRemnantGenerator::AddTargetNucleusRemnant(), genie::FermiMover::AddTargetNucleusRemnant(), genie::HadronicSystemGenerator::AddTargetNucleusRemnant(), genie::NuETargetRemnantGenerator::AddTargetNucleusRemnant(), genie::QELEventGenerator::AddTargetNucleusRemnant(), genie::QELEventGeneratorSM::AddTargetNucleusRemnant(), genie::QELEventGeneratorSuSA::AddTargetNucleusRemnant(), genie::AMNuGammaGenerator::AddTargetRemnant(), genie::alvarezruso::ARConstants::ARConstants(), genie::GHepParticle::AssertIsKnownParticle(), INukeNucleonCorr::AvgCorrection(), genie::utils::BindHitNucleon(), genie::utils::BindHitNucleon(), genie::Born::Born(), genie::SppChannel::BranchingRatio(), genie::BostedChristyEMPXSec::BranchingRatios(), genie::hnl::Decayer::CalcPolMag(), genie::hnl::Decayer::CalcPolMod(), genie::SKHadronicSystemGenerator::CalculateHadronicSystem_AtharSingleKaon(), genie::COHHadronicSystemGenerator::CalculateHadronicSystem_BergerSehgalFM(), genie::COHHadronicSystemGenerator::CalculateHadronicSystem_ReinSehgal(), genie::SKKinematicsGenerator::CalculateKin_AtharSingleKaon(), genie::GHepParticle::Charge(), genie::Target::Charge(), CheckDecayerConsistency(), genie::SKKinematicsGenerator::ComputeMaxXSec(), ConvertToGRooTracker(), genie::SmithMonizQELCCPXSec::d3sQES_dQ2dvdkF_SM(), genie::DarkSectorDecayer::DarkMediatorDecayChannels(), Decay(), genie::DarkSectorDecayer::Decay(), genie::BaryonResonanceDecayer::DecayExclusive(), genie::AGKYLowW2019::DecayMethod2(), genie::MECGenerator::DecayNucleonCluster(), genie::HAIntranuke2018::ElasHA(), genie::HAIntranuke2025::ElasHA(), genie::HAIntranuke::ElasHA(), genie::SecondNucleonEmissionI::EmitSecondNucleon(), genie::utils::intranuke::Equilibrium(), genie::PDGCodeList::ExistsInPDGLibrary(), genie::BaryonResonanceDecayer::FinalStateMass(), genie::Interaction::FSPrimLepton(), genie::GalsterELFormFactorsModel::Gen(), genie::hnl::Decayer::GenerateDecayProducts(), genie::NNBarOscPrimaryVtxGenerator::GenerateDecayProducts(), genie::NucleonDecayPrimaryVtxGenerator::GenerateDecayProducts(), genie::MECGenerator::GenerateFermiMomentum(), genie::NucleonDecayPrimaryVtxGenerator::GenerateFermiMomentum(), genie::hnl::Decayer::GenerateMomentum(), genie::flux::GCylindTH1Flux::GenerateNext(), genie::MECGenerator::GenerateNSVInitialHadrons(), genie::QELEventGeneratorSuSA::GenerateNucleon(), GetCommandLineArgs(), genie::MECScaleVsW::GetMapWithLimits(), genie::MECScaleVsW::GetScaling(), genie::AGCharmPythiaBaseHadro2023::Hadronize(), genie::LeptoHadPythia6::Hadronize(), genie::LeptoHadPythia8::Hadronize(), genie::AGKYLowW2019::HadronShowerCharge(), genie::HadronicSystemGenerator::HadronShowerCharge(), genie::Target::HitNucMass(), genie::hnl::FluxCreator::HNLEnergy(), genie::HAIntranuke2018::Inelastic(), genie::HAIntranuke2025::Inelastic(), genie::HAIntranuke::Inelastic(), genie::HAIntranuke2018::InelasticHA(), genie::HAIntranuke2025::InelasticHA(), genie::InitialState::Init(), genie::LwlynSmithQELCCPXSec::Integral(), genie::AlamSimoAtharVacasSKXSec::Integrate(), genie::GHepParticle::IsOnMassShell(), genie::Target::IsParticle(), genie::Target::IsValidNucleus(), genie::FermiMover::KickHitNucleon(), genie::AhrensDMELPXSec::LoadConfig(), genie::AlamSimoAtharVacasSKPXSec2014::LoadConfig(), genie::BostedChristyEMPXSec::LoadConfig(), genie::DarkSectorDecayer::LoadConfig(), genie::Decayer::LoadConfig(), genie::DMElectronPXSec::LoadConfig(), genie::hnl::BRCalculator::LoadConfig(), genie::QPMDMDISPXSec::LoadConfig(), genie::flux::GAtmoFlux::LoadFluxData(), genie::PathLengthList::LoadFromXml(), genie::evtlib::EventLibraryInterface::LoadRecords(), genie::evtlib::EvtLibPXSec::LoadXSecs(), main(), genie::hnl::FluxCreator::MakeTupleFluxEntry(), genie::GHepParticle::Mass(), genie::Target::Mass(), genie::utils::res::Mass(), genie::utils::intranuke2018::MeanFreePath(), genie::utils::intranuke2025::MeanFreePath(), genie::PaisQELLambdaPXSec::MHyperon(), genie::KovalenkoQELCharmPXSec::MRes(), INukeNucleonCorr::mstar(), genie::GHepParticle::Name(), PDGcheck(), genie::AGKYLowW2019::PhaseSpaceDecay(), genie::utils::intranuke2018::PhaseSpaceDecay(), genie::utils::intranuke2025::PhaseSpaceDecay(), genie::utils::intranuke::PhaseSpaceDecay(), genie::utils::intranuke2018::PionProduction(), genie::utils::intranuke2025::PionProduction(), genie::utils::intranuke::PionProduction(), genie::hnl::Decayer::PolarisedDecay(), genie::utils::intranuke::PreEquilibrium(), genie::InitialState::Print(), genie::PathLengthList::Print(), genie::PDGCodeList::Print(), genie::Target::Print(), genie::XclsTag::Print(), genie::InitialState::Probe(), genie::DFRHadronicSystemGenerator::ProcessEventRecord(), genie::DMELEventGenerator::ProcessEventRecord(), genie::DMELKinematicsGenerator::ProcessEventRecord(), genie::IBDKinematicsGenerator::ProcessEventRecord(), genie::QELEventGenerator::ProcessEventRecord(), genie::QELEventGeneratorSM::ProcessEventRecord(), genie::QELKinematicsGenerator::ProcessEventRecord(), genie::SPPEventGenerator::ProcessEventRecord(), genie::KPhaseSpace::Q2Lim(), genie::KPhaseSpace::Q2Lim_W_SPP(), genie::KPhaseSpace::Q2Lim_W_SPP_iso(), genie::utils::mec::Qvalue(), genie::hnl::FluxCreator::ReadBRs(), genie::Interaction::RecoilNucleon(), genie::PathLengthList::SaveAsXml(), SaveGraphsToRootFile(), SaveToPsFile(), genie::BaryonResonanceDecayer::SelectDecayChannel(), genie::MECGenerator::SelectEmpiricalKinematics(), genie::AGKYLowW2019::SelectParticles(), genie::Target::SetHitNucPdg(), genie::SmithMonizUtils::SetInteraction(), INukeOsetFormula::setKinematics(), genie::DMELKinematicsGenerator::SpectralFuncExperimentalCode(), genie::QELKinematicsGenerator::SpectralFuncExperimentalCode(), genie::MKFFCC::tau(), genie::MKFFEM::tau(), TestPythiaTauDecays(), genie::utils::intranuke2018::ThreeBodyKinematics(), genie::utils::intranuke2025::ThreeBodyKinematics(), genie::utils::intranuke::ThreeBodyKinematics(), genie::KPhaseSpace::Threshold(), genie::KPhaseSpace::Threshold_SPP_iso(), genie::utils::intranuke2018::TwoBodyCollision(), genie::utils::intranuke2025::TwoBodyCollision(), genie::utils::intranuke::TwoBodyCollision(), genie::utils::kinematics::W(), genie::GLRESWdecPythia6::Wdecay(), genie::GLRESWdecPythia8::Wdecay(), genie::PhotonCOHWdecPythia6::Wdecay(), genie::PhotonCOHWdecPythia8::Wdecay(), genie::PhotonRESWdecPythia6::Wdecay(), genie::PhotonRESWdecPythia8::Wdecay(), genie::utils::res::Width(), genie::KPhaseSpace::WLim_SPP(), genie::KPhaseSpace::WLim_SPP_iso(), genie::AlamSimoAtharVacasSKPXSec2014::XSec(), genie::EmpiricalMECPXSec2015::XSec(), genie::MKSPPPXSec2020::XSec(), genie::PattonCEvNSPXSec::XSec(), and genie::GEVGDriver::XSecSum().

◆ Instance()

PDGLibrary * PDGLibrary::Instance ( void )

static

Definition at line 68 of file PDGLibrary.cxx.

{
  if(fInstance == 0) {
    LOG("PDG", pINFO) << "PDGLibrary late initialization";
 
    static PDGLibrary::Cleaner cleaner;
    cleaner.DummyMethodAndSilentCompiler();
 
    fInstance = new PDGLibrary;
  }
  return fInstance;
}

References genie::PDGLibrary::Cleaner::DummyMethodAndSilentCompiler(), fInstance, LOG, PDGLibrary(), and pINFO.

◆ LoadDBase()

bool PDGLibrary::LoadDBase ( void )

private

Definition at line 100 of file PDGLibrary.cxx.

{
  fDatabasePDG = TDatabasePDG::Instance();
 
  // loading PDG data from $GENIE/config/
  const char* altpdgtable = gSystem->Getenv("GENIE_PDG_TABLE");
  if ( altpdgtable ) {
    if ( ! (gSystem->AccessPathName(altpdgtable) ) ) {
        LOG("PDG", pINFO) << "Load PDG data from $GENIE_PDG_TABLE: "
                          << altpdgtable;
        fDatabasePDG->ReadPDGTable( altpdgtable );
        return true;
    }
  }
 
  if ( gSystem->Getenv("GENIE") ) {
    string base_dir = string( gSystem->Getenv("GENIE") );
    base_dir += string("/data/evgen/catalogues/pdg/") ; 
 
    string file_name = "genie_pdg_table.txt" ; 
    const Registry * reg = AlgConfigPool::Instance()->CommonList("Param", "PDG");
    if( reg ) {
      file_name = reg -> GetString("PDG-TableName") ;
      LOG("PDG", pINFO) << "Found file name specification: " << file_name ;
 
    }
    
    string path = base_dir + file_name ;
 
    if ( ! (gSystem->AccessPathName(path.c_str()) ) ) {
        LOG("PDG", pINFO) << "Load PDG data from: " << path;
        fDatabasePDG->ReadPDGTable( path.c_str() );
        return true;
    }
  }
 
  // no PDG data in $GENIE/config/ - Try $ROOTSYS/etc/
 
  if(gSystem->Getenv("ROOTSYS")) {
    string base_dir  = string( gSystem->Getenv("ROOTSYS") );
    string path = base_dir  + string("/etc/pdg_table.txt");
 
    if ( !(gSystem->AccessPathName(path.c_str())) ) {
        LOG("PDG", pINFO) << "Load PDG data from: " << path;
        fDatabasePDG->ReadPDGTable( path.c_str() );
        return true;
     }
  }
 
  LOG("PDG", pERROR) << " *** The PDG extensions will not be loaded!! ***";
  return false;
};

References genie::AlgConfigPool::CommonList(), fDatabasePDG, genie::AlgConfigPool::Instance(), LOG, pERROR, and pINFO.

Referenced by PDGLibrary(), and ReloadDBase().

◆ ReloadDBase()

void PDGLibrary::ReloadDBase ( void )

Definition at line 224 of file PDGLibrary.cxx.

{
  if(fDatabasePDG) {
    delete fDatabasePDG;
  }
 
  if( ! LoadDBase() ) LOG("PDG", pERROR) << "Could not load PDG data";
}

References fDatabasePDG, LoadDBase(), LOG, and pERROR.

Referenced by main().

◆ Cleaner

friend struct Cleaner

friend

Definition at line 72 of file PDGLibrary.h.

Member Data Documentation

◆ fDatabasePDG

TDatabasePDG* genie::PDGLibrary::fDatabasePDG

private

Definition at line 61 of file PDGLibrary.h.

Referenced by AddDarkMatter(), AddDarkSector(), AddHNL(), DBase(), Find(), LoadDBase(), and ReloadDBase().

◆ fInstance

PDGLibrary * PDGLibrary::fInstance = 0

staticprivate

Definition at line 60 of file PDGLibrary.h.

Referenced by Instance(), PDGLibrary(), genie::PDGLibrary::Cleaner::~Cleaner(), and ~PDGLibrary().

The documentation for this class was generated from the following files:

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PDGLibrary() [1/2]

◆ PDGLibrary() [2/2]

◆ ~PDGLibrary()

Member Function Documentation

◆ AddDarkMatter()

◆ AddDarkSector()

◆ AddHNL()

◆ DBase()

◆ Find()

◆ Instance()

◆ LoadDBase()

◆ ReloadDBase()

Friends And Related Symbol Documentation

◆ Cleaner

Member Data Documentation

◆ fDatabasePDG

◆ fInstance