Base class for decayer classes. Implements common configuration, allowing users to toggle on/off flags for particles and decay channels. Is a concerete implementation of the EventRecordVisitorI interface. More...

#include <Decayer.h>

Inheritance diagram for genie::Decayer:

[legend]

Collaboration diagram for genie::Decayer:

[legend]

Public Member Functions
virtual	~Decayer ()
void	Configure (const Registry &config)
void	Configure (string config)
Public Member Functions inherited from genie::EventRecordVisitorI
virtual	~EventRecordVisitorI ()
virtual void	ProcessEventRecord (GHepRecord *event_rec) const =0
Public Member Functions inherited from genie::Algorithm
virtual	~Algorithm ()
virtual void	FindConfig (void)
virtual const Registry &	GetConfig (void) const
Registry *	GetOwnedConfig (void)
virtual const AlgId &	Id (void) const
	Get algorithm ID.
virtual AlgStatus_t	GetStatus (void) const
	Get algorithm status.
virtual bool	AllowReconfig (void) const
virtual AlgCmp_t	Compare (const Algorithm *alg) const
	Compare with input algorithm.
virtual void	SetId (const AlgId &id)
	Set algorithm ID.
virtual void	SetId (string name, string config)
const Algorithm *	SubAlg (const RgKey &registry_key) const
void	AdoptConfig (void)
void	AdoptSubstructure (void)
virtual void	Print (ostream &stream) const
	Print algorithm info.

Protected Member Functions
	Decayer ()
	Decayer (string name)
	Decayer (string name, string config)
virtual void	LoadConfig (void)
virtual bool	ToBeDecayed (int pdgc, GHepStatus_t ist) const
virtual bool	IsUnstable (int pdgc) const
virtual bool	IsHandled (int pdgc) const =0
virtual void	InhibitDecay (int pdgc, TDecayChannel *dc=0) const =0
virtual void	UnInhibitDecay (int pdgc, TDecayChannel *dc=0) const =0
Protected Member Functions inherited from genie::EventRecordVisitorI
	EventRecordVisitorI ()
	EventRecordVisitorI (string name)
	EventRecordVisitorI (string name, string config)
Protected Member Functions inherited from genie::Algorithm
	Algorithm ()
	Algorithm (string name)
	Algorithm (string name, string config)
void	Initialize (void)
void	DeleteConfig (void)
void	DeleteSubstructure (void)
Registry *	ExtractLocalConfig (const Registry &in) const
Registry *	ExtractLowerConfig (const Registry &in, const string &alg_key) const
	Split an incoming configuration Registry into a block valid for the sub-algo identified by alg_key.
template<class T>
bool	GetParam (const RgKey &name, T &p, bool is_top_call=true) const
template<class T>
bool	GetParamDef (const RgKey &name, T &p, const T &def) const
template<class T>
int	GetParamVect (const std::string &comm_name, std::vector< T > &v, bool is_top_call=true) const
	Handle to load vectors of parameters.
int	GetParamVectKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const
template<class T>
int	GetParamMat (const std::string &comm_name, TMatrixT< T > &mat, bool is_top_call=true) const
	Handle to load matrix of parameters.
template<class T>
int	GetParamMatSym (const std::string &comm_name, TMatrixTSym< T > &mat, bool is_top_call=true) const
int	GetParamMatKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const
int	AddTopRegistry (Registry *rp, bool owns=true)
	add registry with top priority, also update ownership
int	AddLowRegistry (Registry *rp, bool owns=true)
	add registry with lowest priority, also update ownership
int	MergeTopRegistry (const Registry &r)
int	AddTopRegisties (const vector< Registry * > &rs, bool owns=false)
	Add registries with top priority, also udated Ownerships.

Protected Attributes
bool	fGenerateWeighted
	generate weighted or unweighted decays?
bool	fRunBefHadroTransp
	is invoked before or after FSI?
PDGCodeList	fParticlesToDecay
	list of particles to be decayed
PDGCodeList	fParticlesNotToDecay
	list of particles for which decay is inhibited
Protected Attributes inherited from genie::Algorithm
bool	fAllowReconfig
bool	fOwnsSubstruc
	true if it owns its substructure (sub-algs,...)
AlgId	fID
	algorithm name and configuration set
vector< Registry * >	fConfVect
vector< bool >	fOwnerships
	ownership for every registry in fConfVect
AlgStatus_t	fStatus
	algorithm execution status
AlgMap *	fOwnedSubAlgMp
	local pool for owned sub-algs (taken out of the factory pool)

Additional Inherited Members
Static Public Member Functions inherited from genie::Algorithm
static string	BuildParamVectKey (const std::string &comm_name, unsigned int i)
static string	BuildParamVectSizeKey (const std::string &comm_name)
static string	BuildParamMatKey (const std::string &comm_name, unsigned int i, unsigned int j)
static string	BuildParamMatRowSizeKey (const std::string &comm_name)
static string	BuildParamMatColSizeKey (const std::string &comm_name)

Detailed Description

Base class for decayer classes. Implements common configuration, allowing users to toggle on/off flags for particles and decay channels. Is a concerete implementation of the EventRecordVisitorI interface.

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

Created:\n November 14, 2018

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 34 of file Decayer.h.

Constructor & Destructor Documentation

◆ ~Decayer()

Decayer::~Decayer ( )

virtual

Definition at line 46 of file Decayer.cxx.

{
 
}

◆ Decayer() [1/3]

Decayer::Decayer ( )

protected

Definition at line 28 of file Decayer.cxx.

                 :
EventRecordVisitorI()
{
 
}

References genie::EventRecordVisitorI::EventRecordVisitorI().

Referenced by genie::BaryonResonanceDecayer::BaryonResonanceDecayer(), genie::BaryonResonanceDecayer::BaryonResonanceDecayer(), genie::Pythia6Decayer2023::Pythia6Decayer2023(), genie::Pythia6Decayer2023::Pythia6Decayer2023(), genie::Pythia8Decayer2023::Pythia8Decayer2023(), and genie::Pythia8Decayer2023::Pythia8Decayer2023().

◆ Decayer() [2/3]

Decayer::Decayer ( string name )

protected

Definition at line 34 of file Decayer.cxx.

                            :
EventRecordVisitorI(name)
{
 
}

References genie::EventRecordVisitorI::EventRecordVisitorI().

◆ Decayer() [3/3]

Decayer::Decayer	(	string	name,
		string	config )

protected

Definition at line 40 of file Decayer.cxx.

                                           :
EventRecordVisitorI(name, config)
{
 
}

References genie::EventRecordVisitorI::EventRecordVisitorI().

Member Function Documentation

◆ Configure() [1/2]

void Decayer::Configure ( const Registry & config )

virtual

Configure the algorithm with an external registry The registry is merged with the top level registry if it is owned, Otherwise a copy of it is added with the highest priority

Reimplemented from genie::Algorithm.

Definition at line 119 of file Decayer.cxx.

{
  Algorithm::Configure(config);
  this->LoadConfig();
 
  fAllowReconfig = false;
}

References genie::Algorithm::Configure(), genie::Algorithm::fAllowReconfig, and LoadConfig().

◆ Configure() [2/2]

void Decayer::Configure ( string config )

virtual

Configure the algorithm from the AlgoConfigPool based on param_set string given in input An algorithm contains a vector of registries coming from different xml configuration files, which are loaded according a very precise prioriy This methods will load a number registries in order of priority: 1) "Tunable" parameter set from CommonParametes. This is loaded with the highest prioriry and it is designed to be used for tuning procedure Usage not expected from the user. 2) For every string defined in "CommonParame" the corresponding parameter set will be loaded from CommonParameter.xml 3) parameter set specified by the config string and defined in the xml file of the algorithm 4) if config is not "Default" also the Default parameter set from the same xml file will be loaded Effectively this avoids the repetion of a parameter when it is not changed in the requested configuration

Reimplemented from genie::Algorithm.

Definition at line 127 of file Decayer.cxx.

{
  Algorithm::Configure(config);
  this->LoadConfig();
 
  fAllowReconfig = false;
}

References genie::Algorithm::Configure(), genie::Algorithm::fAllowReconfig, and LoadConfig().

◆ InhibitDecay()

virtual void genie::Decayer::InhibitDecay	(	int	pdgc,
		TDecayChannel *	dc = 0 ) const

protectedpure virtual

Implemented in genie::BaryonResonanceDecayer, genie::Pythia6Decayer2023, and genie::Pythia8Decayer2023.

Referenced by LoadConfig(), and TestPythiaTauDecays().

◆ IsHandled()

virtual bool genie::Decayer::IsHandled ( int pdgc ) const

protectedpure virtual

Implemented in genie::BaryonResonanceDecayer, genie::Pythia6Decayer2023, and genie::Pythia8Decayer2023.

◆ IsUnstable()

bool Decayer::IsUnstable ( int pdgc ) const

protectedvirtual

Definition at line 87 of file Decayer.cxx.

{
  // ROOT's TParticlepdg::Lifetime() does not work properly
  // do something else instead (temporarily)
  //
  // TParticlePDG * ppdg = PDGLibrary::Instance()->Find(pdg_code);
  //if( ppdg->Lifetime() < fMaxLifetime ) { /* ... */ };
  //
 
  // <temp/>
  if( fRunBefHadroTransp ) {
    //
    // Run *before* the hadron transport MC
    // At this point we decay only baryon resonances
    //
    bool decay = utils::res::IsBaryonResonance(pdg_code);
    return decay;
  }
  else {
    //
    // Run *after* the hadron transport MC
    // At this point we decay only particles in the fParticlesToDecay
    // PDGCodeList (filled in from config inputs)
    //
    bool decay = fParticlesToDecay.ExistsInPDGCodeList(pdg_code);
    return decay;
  }
  // </temp>
 
  return false;
}

References fParticlesToDecay, fRunBefHadroTransp, and genie::utils::res::IsBaryonResonance().

Referenced by ToBeDecayed().

◆ LoadConfig()

void Decayer::LoadConfig ( void )

protectedvirtual

Reimplemented in genie::BaryonResonanceDecayer.

Definition at line 135 of file Decayer.cxx.

{
  // Get the specified maximum lifetime tmax (decay with lifetime < tmax)
  //
  //fMaxLifetime = fConfig->GetDoubleDef("MaxLifetime", 1e-9);
 
  // Check whether to generate weighted or unweighted particle decays
  fGenerateWeighted = false ;
  //this->GetParam("GenerateWeighted", fGenerateWeighted, false);
 
  // Check whether the module is being run before or after the hadron
  // transport (intranuclear rescattering) module.
  //
  // If it is run before the hadron transport (and after the hadronization)
  // step it should decay only "unstable" particles (marked as hadrons in
  // the nucleus) which would typically decay within the time required to
  // exit the nucleus - so, the algorithm wouldn't decay particles that
  // have to be rescattered first. In case that the generated event is off
  // a free nucleon target, thi instance of the algorithm should do nothing.
  //
  // If it is run after the hadon transport, then it should decay all the
  // 'unstable' particles marked as 'present in the final state' and which
  // should be decay before the event is passed to the detector particle
  // transport MC.
  //
 
  this->GetParam("RunBeforeHadronTransport", fRunBefHadroTransp) ;
 
  // Allow user to specify a list of particles to be decayed
  //
  RgKeyList klist = GetConfig().FindKeys("DecayParticleWithCode=");
  RgKeyList::const_iterator kiter = klist.begin();
  for( ; kiter != klist.end(); ++kiter) {
    RgKey key = *kiter;
    bool decay = GetConfig().GetBool(key);
    vector<string> kv = utils::str::Split(key,"=");
    assert(kv.size()==2);
    int pdgc = atoi(kv[1].c_str());
    TParticlePDG * p = PDGLibrary::Instance()->Find(pdgc);
    if ( ! p ) {
      LOG("Decay",pFATAL) << "No PDGLibrary entry for pdgc=" << pdgc
                          << " (" << kv[1].c_str()
                          << "), check CommonDecay.xml";
      continue;
    }
    if(decay) {
       LOG("Decay", pDEBUG)
            << "Configured to decay " <<  p->GetName();
       fParticlesToDecay.push_back(pdgc);
       this->UnInhibitDecay(pdgc);
    }
    else {
       LOG("Decay", pDEBUG)
            << "Configured to inhibit decays for  " <<  p->GetName();
       fParticlesNotToDecay.push_back(pdgc);
       this->InhibitDecay(pdgc);
    }// decay?
  }// key iterator
 
  // Allow user to inhibit certain decay channels
  //
  klist = GetConfig().FindKeys("InhibitDecay/");
  kiter = klist.begin();
  for( ; kiter != klist.end(); ++kiter) {
    RgKey key = *kiter;
    if(GetConfig().GetBool(key)) {
      string filtkey = utils::str::FilterString("InhibitDecay/", key);
      vector<string> kv = utils::str::Split(filtkey,",");
      assert(kv.size()==2);
      int pdgc = atoi(utils::str::FilterString("Particle=",kv[0]).c_str());
      int dc   = atoi(utils::str::FilterString("Channel=", kv[1]).c_str());
      TParticlePDG * p = PDGLibrary::Instance()->Find(pdgc);
      if(!p) continue;
      LOG("Decay", pINFO)
         << "Configured to inhibit " <<  p->GetName()
         << "'s decay channel " << dc;
      this->InhibitDecay(pdgc, p->DecayChannel(dc));
    }//val[key]=true?
  }//key iterator
 
 
  sort(fParticlesToDecay.begin(),    fParticlesToDecay.end());
  sort(fParticlesNotToDecay.begin(), fParticlesNotToDecay.end());
 
  // Print-out for only one of the two instances of this module
  if(!fRunBefHadroTransp) {
    LOG("Decay", pNOTICE)
       << "\nConfigured to decay: " << fParticlesToDecay
       << "\nConfigured to inhibit decays of: " << fParticlesNotToDecay
       << "\n";
  }
}

References fGenerateWeighted, genie::utils::str::FilterString(), genie::PDGLibrary::Find(), genie::Registry::FindKeys(), fParticlesNotToDecay, fParticlesToDecay, fRunBefHadroTransp, genie::Registry::GetBool(), genie::Algorithm::GetConfig(), genie::Algorithm::GetParam(), InhibitDecay(), genie::PDGLibrary::Instance(), LOG, pDEBUG, pFATAL, pINFO, pNOTICE, genie::utils::str::Split(), and UnInhibitDecay().

Referenced by Configure(), Configure(), and genie::BaryonResonanceDecayer::LoadConfig().

◆ ToBeDecayed()

bool Decayer::ToBeDecayed	(	int	pdgc,
		GHepStatus_t	ist ) const

protectedvirtual

Definition at line 51 of file Decayer.cxx.

{
  // Check whether it is "unstable" (definition can vary)
 
  bool is_unstable = this->IsUnstable(pdg_code);
 
  LOG("Decay", pDEBUG)
    << "Particle is unstable? "
    << ((is_unstable) ? "Yes" : "No");
 
  if(!is_unstable) return false;
 
  // Check whether the given unstable particle
  // has the appropriate status code to be decayed
 
  bool to_be_decayed = false;
 
  if(fRunBefHadroTransp) {
    to_be_decayed =
      (status_code == kIStHadronInTheNucleus    ||
       status_code == kIStPreDecayResonantState ||
       status_code == kIStStableFinalState);
  }
  else {
    to_be_decayed =
      (status_code == kIStStableFinalState);
  }
 
  LOG("Decay", pDEBUG)
      << "Particle to be decayed "
      << "[" << ((fRunBefHadroTransp) ? "Before" : "After") << " FSI]? "
      << ((to_be_decayed) ? "Yes" : "No");
 
  return to_be_decayed;
}

References fRunBefHadroTransp, IsUnstable(), genie::kIStHadronInTheNucleus, genie::kIStPreDecayResonantState, genie::kIStStableFinalState, LOG, and pDEBUG.

Referenced by genie::BaryonResonanceDecayer::ProcessEventRecord(), genie::Pythia6Decayer2023::ProcessEventRecord(), and genie::Pythia8Decayer2023::ProcessEventRecord().

◆ UnInhibitDecay()

virtual void genie::Decayer::UnInhibitDecay	(	int	pdgc,
		TDecayChannel *	dc = 0 ) const

protectedpure virtual

Implemented in genie::BaryonResonanceDecayer, genie::Pythia6Decayer2023, and genie::Pythia8Decayer2023.

Referenced by LoadConfig(), and TestPythiaTauDecays().

Member Data Documentation

◆ fGenerateWeighted

bool genie::Decayer::fGenerateWeighted

protected

generate weighted or unweighted decays?

Definition at line 56 of file Decayer.h.

Referenced by genie::BaryonResonanceDecayer::DecayExclusive(), and LoadConfig().

◆ fParticlesNotToDecay

PDGCodeList genie::Decayer::fParticlesNotToDecay

protected

list of particles for which decay is inhibited

Definition at line 59 of file Decayer.h.

Referenced by LoadConfig().

◆ fParticlesToDecay

PDGCodeList genie::Decayer::fParticlesToDecay

protected

list of particles to be decayed

Definition at line 58 of file Decayer.h.

Referenced by IsUnstable(), and LoadConfig().

◆ fRunBefHadroTransp

bool genie::Decayer::fRunBefHadroTransp

protected

is invoked before or after FSI?

Definition at line 57 of file Decayer.h.

Referenced by genie::Pythia6Decayer2023::Decay(), genie::Pythia8Decayer2023::Decay(), genie::BaryonResonanceDecayer::DecayExclusive(), IsUnstable(), LoadConfig(), genie::BaryonResonanceDecayer::ProcessEventRecord(), genie::Pythia6Decayer2023::ProcessEventRecord(), genie::Pythia8Decayer2023::ProcessEventRecord(), and ToBeDecayed().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~Decayer()

◆ Decayer() [1/3]

◆ Decayer() [2/3]

◆ Decayer() [3/3]

Member Function Documentation

◆ Configure() [1/2]

◆ Configure() [2/2]

◆ InhibitDecay()

◆ IsHandled()

◆ IsUnstable()

◆ LoadConfig()

◆ ToBeDecayed()

◆ UnInhibitDecay()

Member Data Documentation

◆ fGenerateWeighted

◆ fParticlesNotToDecay

◆ fParticlesToDecay

◆ fRunBefHadroTransp