Gambit::DecayTable Class Reference

GAMBIT native decay table class. More...

#include <decay_table.hpp>

Collaboration diagram for Gambit::DecayTable:

Classes
class	Entry
	DecayTable entry class. Holds the info on all decays of a given particle. More...

Public Member Functions
SLHAstruct	getSLHAea (int SLHA_version, bool include_zero_bfs=false, const mass_es_pseudonyms &psn=mass_es_pseudonyms()) const
	Output entire decay table as an SLHAea file full of DECAY blocks. More...
void	writeSLHAfile (int SLHA_version, const str &filename, bool include_zero_bfs=false, const mass_es_pseudonyms &psn=mass_es_pseudonyms()) const
	Output entire decay table as an SLHA file full of DECAY blocks. More...
	DecayTable ()
	ConstructorsDefault constructor. More...
	DecayTable (str slha, int context=0, bool force_SM_fermion_gauge_eigenstates=false)
	Create a DecayTable from an SLHA file. More...
	DecayTable (str slha, const std::map< int, int > &PDG_map, int context=0, bool force_SM_fermion_gauge_eigenstates=false)
	Create a DecayTable from an SLHA file, with PDG code remapping. More...
	DecayTable (const SLHAstruct &, int context=0, bool force_SM_fermion_gauge_eigenstates=false)
	Create a DecayTable from an SLHAea object containing DECAY blocks. More...
	DecayTable (const SLHAstruct &, const std::map< int, int > &, int context=0, bool force_SM_fermion_gauge_eigenstates=false)
	Create a DecayTable from an SLHAea object containing DECAY blocks, and remap PDG codes according to provided map. More...
SLHAea::Block	getSLHAea_block (int, std::pair< int, int >, bool include_zero_bfs=false, const mass_es_pseudonyms &psn=mass_es_pseudonyms()) const
	Output a decay table entry as an SLHAea DECAY block, using input parameter to identify the entry. More...
SLHAea::Block	getSLHAea_block (int, str, bool include_zero_bfs=false, const mass_es_pseudonyms &psn=mass_es_pseudonyms()) const
SLHAea::Block	getSLHAea_block (int, str, int, bool include_zero_bfs=false, const mass_es_pseudonyms &psn=mass_es_pseudonyms()) const
Entry &	operator() (std::pair< int, int >)
	Get entry in decay table for a given particle, adding the particle to the table if it is absent. More...
Entry &	operator() (str)
Entry &	operator() (str, int)
const Entry &	operator() (std::pair< int, int >) const
const Entry &	operator() (str) const
const Entry &	operator() (str, int) const
Entry &	at (std::pair< int, int >)
	Get entry in decay table for a give particle, throwing an error if particle is absent. More...
Entry &	at (str)
Entry &	at (str, int)
const Entry &	at (std::pair< int, int >) const
const Entry &	at (str) const
const Entry &	at (str, int) const

Public Attributes
std::map< std::pair< int, int >, Entry >	particles
	The actual underlying map. Just iterate over this directly if you need to iterate over all particles in the table. More...

Detailed Description

GAMBIT native decay table class.

Definition at line 35 of file decay_table.hpp.

Constructor & Destructor Documentation

DecayTable() [1/5]

Gambit::DecayTable::DecayTable ( )

inline

ConstructorsDefault constructor.

Definition at line 45 of file decay_table.hpp.

References at(), getSLHAea(), getSLHAea_block(), operator()(), and writeSLHAfile().

{}

Here is the call graph for this function:

DecayTable() [2/5]

Gambit::DecayTable::DecayTable	(	str	slha,
		int	context = 0,
		bool	force_SM_fermion_gauge_eigenstates = false
	)

Create a DecayTable from an SLHA file.

Definition at line 61 of file decay_table.cpp.

   : DecayTable(read_SLHA(slha), context, force_SM_fermion_gauge_eigenstates)
  {}

DecayTable() [3/5]

Gambit::DecayTable::DecayTable	(	str	slha,
		const std::map< int, int > &	PDG_map,
		int	context = 0,
		bool	force_SM_fermion_gauge_eigenstates = false
	)

Create a DecayTable from an SLHA file, with PDG code remapping.

Definition at line 66 of file decay_table.cpp.

   : DecayTable(read_SLHA(slha), PDG_map, context, force_SM_fermion_gauge_eigenstates)
  {}

DecayTable() [4/5]

Gambit::DecayTable::DecayTable	(	const SLHAstruct &	slha,
		int	context = 0,
		bool	force_SM_fermion_gauge_eigenstates = false
	)

Create a DecayTable from an SLHAea object containing DECAY blocks.

Definition at line 71 of file decay_table.cpp.

References Gambit::get_calculator_info(), LOCAL_INFO, operator()(), and Gambit::utils_error().

  {
    // Extract the calculator info if it exists
    str calculator, calculator_version;
    get_calculator_info(slha, calculator, calculator_version);

    // Iterate over all blocks in the file, ignoring everything except DECAY blocks
    for (auto block = slha.begin(); block != slha.end(); ++block)
    {
      auto block_def = block->find_block_def();
      if (block_def != block->end())
      {
        if(block_def->at(0) == "DECAY")
        {
          // Make sure the block definition has the particle's width and PDG code
          if (block_def->size() < 3) utils_error().raise(LOCAL_INFO,
           "SLHAea object has DECAY block with < 3 entries in its block definition.");
          int pdg = SLHAea::to<int>(block_def->at(1));
          // Add an entry containing the info in this block
          int local_context = context;
          if (force_SM_fermion_gauge_eigenstates)
          {
            int abspdg = std::abs(pdg);
            // Select SM fermions, including 4th gen, and force gauge eigenstates (context = 1).
            if (abspdg < 19 and abspdg != 9 and abspdg != 10) local_context = 1;
          }
          operator()(std::pair<int,int>(pdg,local_context)) = Entry(*block, block_def, context,
           force_SM_fermion_gauge_eigenstates, calculator, calculator_version);
        }
      }
    }
  }

Here is the call graph for this function:

DecayTable() [5/5]

Gambit::DecayTable::DecayTable	(	const SLHAstruct &	slha_in,
		const std::map< int, int > &	PDG_map,
		int	context = 0,
		bool	force_SM_fermion_gauge_eigenstates = false
	)

Create a DecayTable from an SLHAea object containing DECAY blocks, and remap PDG codes according to provided map.

Definition at line 105 of file decay_table.cpp.

References Gambit::get_calculator_info(), LOCAL_INFO, operator()(), and Gambit::utils_error().

  {
    // Make a local copy so we can mess with it
    SLHAstruct slha(slha_in);

    // Extract the calculator info if it exists
    str calculator, calculator_version;
    get_calculator_info(slha, calculator, calculator_version);

    // Iterate over all blocks in the file, ignoring everything except DECAY blocks
    for (auto block = slha.begin(); block != slha.end(); ++block)
    {
      auto block_def = block->find_block_def();
      if (block_def != block->end())
      {
        if(block_def->at(0) == "DECAY")
        {
          // Make sure the block definition has the particle's width and PDG code
          if (block_def->size() < 3) utils_error().raise(LOCAL_INFO, "SLHAea object has DECAY block with < 3 entries in its block definition.");
          int pdg = SLHAea::to<int>(block_def->at(1));
          if (PDG_map.find(pdg) != PDG_map.end())
          {
            pdg = PDG_map.at(pdg);
            (*block_def)[1] = boost::lexical_cast<str>(pdg);
          }
          // Step through the block and convert any final state PDG codes that need to be remapped
          for (auto line = block->begin() + 1; line != block->end(); ++line)
          {
            if (not line->is_comment_line())
            {
              for (int i = 2; i < 2 + SLHAea::to<int>(line->at(1)); i++)
              {
                int local_pdg = SLHAea::to<int>(line->at(i));
                if (PDG_map.find(local_pdg) != PDG_map.end()) (*line)[i] = boost::lexical_cast<str>(PDG_map.at(local_pdg));
              }
            }
          }
          // Add an entry containing the info in this block
          operator()(std::pair<int,int>(pdg,context)) = Entry(*block, block_def, context,
           force_SM_fermion_gauge_eigenstates, calculator, calculator_version);
        }
      }
    }
  }

Here is the call graph for this function:

Member Function Documentation

at() [1/6]

DecayTable::Entry & Gambit::DecayTable::at

(

std::pair< int, int >

p

)

Get entry in decay table for a give particle, throwing an error if particle is absent.

Three access methods: PDG-context integer pair, full particle name, short particle name + index integer.

Definition at line 513 of file decay_table.cpp.

References particles.

Referenced by DecayTable(), Gambit::DecayBit::get_decaytable_as_map(), Gambit::DarkBit::DarkBit_utils::ImportDecays(), Gambit::ColliderBit::L3_Chargino_All_Channels_Conservative_LLike(), Gambit::ColliderBit::L3_Chargino_Leptonic_Conservative_LLike(), Gambit::ColliderBit::L3_Gravitino_LLike(), Gambit::ColliderBit::L3_Neutralino_All_Channels_Conservative_LLike(), Gambit::ColliderBit::L3_Neutralino_Leptonic_Conservative_LLike(), Gambit::ColliderBit::OPAL_Chargino_All_Channels_Conservative_LLike(), Gambit::ColliderBit::OPAL_Chargino_Hadronic_Conservative_LLike(), Gambit::ColliderBit::OPAL_Chargino_Leptonic_Conservative_LLike(), Gambit::ColliderBit::OPAL_Chargino_SemiLeptonic_Conservative_LLike(), Gambit::ColliderBit::OPAL_Neutralino_Hadronic_Conservative_LLike(), Gambit::DarkBit::RD_spectrum_MSSM(), Gambit::DarkBit::TH_ProcessCatalog_DiracSingletDM_Z2(), Gambit::DarkBit::TH_ProcessCatalog_MajoranaSingletDM_Z2(), Gambit::DarkBit::TH_ProcessCatalog_ScalarSingletDM_Z2(), Gambit::DarkBit::TH_ProcessCatalog_ScalarSingletDM_Z3(), and Gambit::DarkBit::TH_ProcessCatalog_VectorSingletDM_Z2().

{ return particles.at(p); }

Here is the caller graph for this function:

at() [2/6]

DecayTable::Entry & Gambit::DecayTable::at

(

str

p

)

Definition at line 514 of file decay_table.cpp.

References Gambit::Models::ParticleDB(), and particles.

{ return particles.at(Models::ParticleDB().pdg_pair(p)); }

Here is the call graph for this function:

at() [3/6]

DecayTable::Entry & Gambit::DecayTable::at	(	str	p,
		int	i
	)

Definition at line 515 of file decay_table.cpp.

References Gambit::Models::ParticleDB(), and particles.

{ return particles.at(Models::ParticleDB().pdg_pair(p,i)); }

Here is the call graph for this function:

at() [4/6]

const DecayTable::Entry & Gambit::DecayTable::at

(

std::pair< int, int >

p

)

const

Definition at line 516 of file decay_table.cpp.

References particles.

{ return particles.at(p); }

at() [5/6]

const DecayTable::Entry & Gambit::DecayTable::at

(

str

p

)

const

Definition at line 517 of file decay_table.cpp.

References Gambit::Models::ParticleDB(), and particles.

{ return particles.at(Models::ParticleDB().pdg_pair(p)); }

Here is the call graph for this function:

at() [6/6]

const DecayTable::Entry & Gambit::DecayTable::at	(	str	p,
		int	i
	)		const

Definition at line 518 of file decay_table.cpp.

References Gambit::Models::ParticleDB(), and particles.

{ return particles.at(Models::ParticleDB().pdg_pair(p,i)); }

Here is the call graph for this function:

getSLHAea()

SLHAstruct Gambit::DecayTable::getSLHAea	(	int	SLHA_version,
		bool	include_zero_bfs = false,
		const mass_es_pseudonyms &	psn = mass_es_pseudonyms()
	)		const

Output entire decay table as an SLHAea file full of DECAY blocks.

Definition at line 162 of file decay_table.cpp.

References Gambit::slhahelp::add_MODSEL_disclaimer(), Gambit::gambit_version(), and particles.

Referenced by DecayTable(), and writeSLHAfile().

  {
    SLHAstruct slha;
    std::map<str, std::set<str> > calculator_map;
    str calculators = "GAMBIT, using: ";
    str versions = gambit_version() + ": ";

    // Add the decay info
    for (auto particle = particles.begin(); particle != particles.end(); ++particle)
    {
      auto entry = particle->second;
      if (entry.calculator != "") calculator_map[entry.calculator].insert(entry.calculator_version);
      slha.push_back(entry.getSLHAea_block(SLHA_version, particle->first, include_zero_bfs, psn));
    }

    // Construct the calculator info
    for (auto be = calculator_map.begin(); be != calculator_map.end(); ++be)
    {
      if (be != calculator_map.begin())
      {
        calculators += " | ";
        versions += " | ";
      }
      calculators += be->first;
      for (auto ver = be->second.begin(); ver != be->second.end(); ++ver)
      {
        if (*ver != "")
        {
          if (ver != be->second.begin()) versions += ", ";
          versions += *ver;
        }
      }
    }

    // Add the calculator info
    SLHAea::Block DCblock("DCINFO");
    DCblock.push_back("BLOCK DCINFO              # Decay Program information");
    SLHAea::Line line1, line2;
    line1 << 1 << calculators << "# Decay calculators";
    line2 << 2 << versions << "# Version numbers";
    DCblock.push_back(line1);
    DCblock.push_back(line2);
    slha.push_front(DCblock);

    // Add a disclaimer about the absence of a MODSEL block
    slhahelp::add_MODSEL_disclaimer(slha, "DecayTable");

    return slha;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getSLHAea_block() [1/3]

SLHAea::Block Gambit::DecayTable::getSLHAea_block	(	int	v,
		std::pair< int, int >	p,
		bool	include_zero_bfs = false,
		const mass_es_pseudonyms &	psn = mass_es_pseudonyms()
	)		const

Output a decay table entry as an SLHAea DECAY block, using input parameter to identify the entry.

Output a decay table entry as an SLHAea DECAY block.

Definition at line 214 of file decay_table.cpp.

References Gambit::Models::ParticleDB(), and particles.

Referenced by DecayTable().

  { return particles.at(p).getSLHAea_block(v, Models::ParticleDB().long_name(p), z, psn); }

Here is the call graph for this function:

Here is the caller graph for this function:

getSLHAea_block() [2/3]

SLHAea::Block Gambit::DecayTable::getSLHAea_block	(	int	v,
		str	p,
		bool	include_zero_bfs = false,
		const mass_es_pseudonyms &	psn = mass_es_pseudonyms()
	)		const

Definition at line 216 of file decay_table.cpp.

References Gambit::Models::ParticleDB(), and particles.

  { return particles.at(Models::ParticleDB().pdg_pair(p)).getSLHAea_block(v, p, z, psn); }

Here is the call graph for this function:

getSLHAea_block() [3/3]

SLHAea::Block Gambit::DecayTable::getSLHAea_block	(	int	v,
		str	p,
		int	i,
		bool	include_zero_bfs = false,
		const mass_es_pseudonyms &	psn = mass_es_pseudonyms()
	)		const

Definition at line 218 of file decay_table.cpp.

References Gambit::Models::ParticleDB(), and particles.

  { return particles.at(Models::ParticleDB().pdg_pair(p,i)).getSLHAea_block(v, Models::ParticleDB().long_name(p,i), z, psn); }

Here is the call graph for this function:

operator()() [1/6]

DecayTable::Entry & Gambit::DecayTable::operator()

(

std::pair< int, int >

p

)

Get entry in decay table for a given particle, adding the particle to the table if it is absent.

Three access methods: PDG-context integer pair, full particle name, short particle name + index integer.

Definition at line 502 of file decay_table.cpp.

References particles.

Referenced by DecayTable().

{ return particles[p]; }

Here is the caller graph for this function:

operator()() [2/6]

DecayTable::Entry & Gambit::DecayTable::operator()

(

str

p

)

Definition at line 503 of file decay_table.cpp.

References Gambit::Models::ParticleDB(), particles, and Gambit::Models::partmap::pdg_pair().

{ return particles[Models::ParticleDB().pdg_pair(p)]; }

Here is the call graph for this function:

operator()() [3/6]

DecayTable::Entry & Gambit::DecayTable::operator()	(	str	p,
		int	i
	)

Definition at line 504 of file decay_table.cpp.

References Gambit::Models::ParticleDB(), particles, and Gambit::Models::partmap::pdg_pair().

{ return particles[Models::ParticleDB().pdg_pair(p,i)]; }

Here is the call graph for this function:

operator()() [4/6]

const DecayTable::Entry & Gambit::DecayTable::operator()

(

std::pair< int, int >

p

)

const

Definition at line 505 of file decay_table.cpp.

References particles.

{ return particles.at(p); }

operator()() [5/6]

const DecayTable::Entry & Gambit::DecayTable::operator()

(

str

p

)

const

Definition at line 506 of file decay_table.cpp.

References Gambit::Models::ParticleDB(), and particles.

{ return particles.at(Models::ParticleDB().pdg_pair(p)); }

Here is the call graph for this function:

operator()() [6/6]

const DecayTable::Entry & Gambit::DecayTable::operator()	(	str	p,
		int	i
	)		const

Definition at line 507 of file decay_table.cpp.

References Gambit::Models::ParticleDB(), and particles.

{ return particles.at(Models::ParticleDB().pdg_pair(p,i)); }

Here is the call graph for this function:

writeSLHAfile()

void Gambit::DecayTable::writeSLHAfile	(	int	SLHA_version,
		const str &	filename,
		bool	include_zero_bfs = false,
		const mass_es_pseudonyms &	psn = mass_es_pseudonyms()
	)		const

Output entire decay table as an SLHA file full of DECAY blocks.

Definition at line 151 of file decay_table.cpp.

References getSLHAea().

Referenced by Gambit::DecayBit::all_decays(), and DecayTable().

  {
    Utils::FileLock mylock(filename);
    mylock.get_lock();
    std::ofstream ofs(filename);
    ofs << getSLHAea(SLHA_version, include_zero_bfs, psn);
    ofs.close();
    mylock.release_lock();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

particles

std::map< std::pair<int,int>, Entry > Gambit::DecayTable::particles

The actual underlying map. Just iterate over this directly if you need to iterate over all particles in the table.

Definition at line 92 of file decay_table.hpp.

Referenced by Gambit::DecayBit::all_decays(), at(), Gambit::DecayTable::Entry::check_particles_exist(), Gambit::DecayBit::get_decaytable_as_map(), getSLHAea(), getSLHAea_block(), and operator()().

---

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

• Elements/include/gambit/Elements/decay_table.hpp
• Elements/src/decay_table.cpp