smash::IsoParticleType Class Reference

#include <isoparticletype.h>

IsoParticleType is a class to represent isospin multiplets.

It is similar to ParticleType, but refers to whole multiplets instead of single particle states.

Definition at line 29 of file isoparticletype.h.

Classes
struct	ParticleNotFoundFailure
	Throw when requested particle could not be found. More...

Public Member Functions
	IsoParticleType (const std::string &n, double m, double w, unsigned int s, Parity p)
	Creates a fully initialized IsoParticleType object. More...
	IsoParticleType (const IsoParticleType &)=delete
	Copies are not allowed as they break intended use. More...
IsoParticleType &	operator= (const IsoParticleType &)=delete
	Assignment is not allowed, see copy constructor above. More...
	IsoParticleType (IsoParticleType &&)=default
	Move constructor of IsoParticleType (needed for std::sort) More...
IsoParticleType &	operator= (IsoParticleType &&)=default
	Move constructor of IsoParticleType "="-operator (needed for std::sort) More...
bool	operator== (const IsoParticleType &rhs) const
	Returns whether the two IsoParticleType objects have the same PDG code for their first state; if so, it is the same iso multiplet. More...
const std::string &	name () const
	Returns the name of the multiplet. More...
const std::string	name_filtered_prime () const
	Returns the name of the multiplet, after replacing "'" with "_prime". More...
double	mass () const
	Returns the (average) multiplet mass. More...
double	width () const
	Returns the (average) multiplet width. More...
int	isospin () const
	Returns twice the total isospin of the multiplet. More...
unsigned int	spin () const
	Returns twice the spin of the multiplet. More...
Parity	parity () const
bool	is_hadron () const
ParticleTypePtrList	get_states () const
	Returns list of states that form part of the multiplet. More...
void	add_state (const ParticleType &type)
	Add a new state to an existing multiplet (and check if isospin symmetry is fulfilled). More...
const IsoParticleType *	anti_multiplet () const
	Return a multiplet of antiparticles, if it is different from the original multiplet. More...
bool	has_anti_multiplet () const
	Check if there is a multiplet of antiparticles, which is different from the original multiplet. More...
double	get_integral_NR (double sqrts)
	Look up the tabulated resonance integral for the XX -> NR cross section. More...
double	get_integral_RR (IsoParticleType *type_res_2, double sqrts)
	Look up the tabulated resonance integral for the XX -> RR cross section. More...
double	get_integral_RK (double sqrts)
	Look up the tabulated resonance integral for the XX -> RK cross section. More...
double	get_integral_piR (double sqrts)
	Look up the tabulated resonance integral for the XX -> piR cross section. More...
double	get_integral_rhoR (double sqrts)
	Look up the tabulated resonance integral for the XX -> rhoR cross section. More...

Static Public Member Functions
static const IsoParticleTypeList &	list_all ()
	Returns a list of all IsoParticleTypes. More...
static const std::vector< const IsoParticleType * >	list_baryon_resonances ()
	Returns a list of all IsoParticleTypes that are baryon resonances. More...
static const IsoParticleType *	try_find (const std::string &name)
	Returns the IsoParticleType pointer for the given name. More...
static const IsoParticleType &	find (const std::string &name)
	Returns the IsoParticleType object for the given name. More...
static IsoParticleType *	find (const ParticleType &type)
	Returns the IsoParticleType object for the given type. More...
static bool	exists (const std::string &name)
	Returns whether the ParticleType with the given pdgcode exists. More...
static const ParticleTypePtr	find_state (const std::string &name)
	Returns the ParticleType object for the given name, by first finding the correct multiplet and then looking for the desired state. More...
static void	create_multiplet (const ParticleType &type)
	Add a new multiplet to the global list of IsoParticleTypes, which contains type. More...
static void	tabulate_integrals (sha256::Hash hash, const std::filesystem::path &tabulations_path)
	Tabulate all relevant integrals. More...

Static Private Member Functions
static IsoParticleType &	find_private (const std::string &name)
	Private version of the 'find' method that returns a non-const reference. More...

Private Attributes
std::string	name_
	name of the multiplet More...
double	mass_
	(average) mass of the multiplet More...
double	width_
	(average) width of the multiplet More...
unsigned int	spin_
	twice the spin of the multiplet More...
Parity	parity_
	parity of the multiplet More...
ParticleTypePtrList	states_
	list of states that are contained in the multiplet More...
Tabulation *	XS_piR_tabulation_ = nullptr
	A tabulation of the spectral integral for the dpi -> d'pi cross sections. More...
Tabulation *	XS_RK_tabulation_ = nullptr
	A tabulation of the spectral integral for the NK -> RK cross sections. More...
Tabulation *	XS_NR_tabulation_ = nullptr
	A tabulation for the NN -> NR cross sections, where R is a resonance from this multiplet. More...
Tabulation *	XS_DeltaR_tabulation_ = nullptr
	A tabulation for the NN -> RΔ cross sections, where R is a resonance from this multiplet. More...
Tabulation *	XS_rhoR_tabulation_ = nullptr
	A tabulation for the ρρ integrals. More...

Constructor & Destructor Documentation

IsoParticleType() [1/3]

smash::IsoParticleType::IsoParticleType	(	const std::string &	n,
		double	m,
		double	w,
		unsigned int	s,
		Parity	p
	)

Creates a fully initialized IsoParticleType object.

Parameters

n	The name of the multiplet.
m	The (average) mass of the multiplet.
w	The (average) width of the multiplet.
s	Twice the spin of the multiplet.
p	Parity of the multiplet.

Definition at line 37 of file isoparticletype.cc.

    : name_(n), mass_(m), width_(w), spin_(s), parity_(p) {}

IsoParticleType() [2/3]

smash::IsoParticleType::IsoParticleType ( const IsoParticleType &  )

delete

Copies are not allowed as they break intended use.

Instead use a const-ref or ParticleTypePtr (as returned from operator&).

IsoParticleType() [3/3]

smash::IsoParticleType::IsoParticleType ( IsoParticleType &&  )

default

Move constructor of IsoParticleType (needed for std::sort)

Member Function Documentation

operator=() [1/2]

IsoParticleType& smash::IsoParticleType::operator= ( const IsoParticleType &  )

delete

Assignment is not allowed, see copy constructor above.

operator=() [2/2]

IsoParticleType& smash::IsoParticleType::operator= ( IsoParticleType &&  )

default

Move constructor of IsoParticleType "="-operator (needed for std::sort)

operator==()

bool smash::IsoParticleType::operator== ( const IsoParticleType &  rhs ) const

inline

Returns whether the two IsoParticleType objects have the same PDG code for their first state; if so, it is the same iso multiplet.

Parameters

rhs	The other multiplet.

Definition at line 62 of file isoparticletype.h.

                                                    {
    return states_[0]->pdgcode() == rhs.states_[0]->pdgcode();
  }

name()

const std::string& smash::IsoParticleType::name ( ) const

inline

Returns the name of the multiplet.

Definition at line 67 of file isoparticletype.h.

{ return name_; }

name_filtered_prime()

const std::string smash::IsoParticleType::name_filtered_prime ( ) const

inline

Returns the name of the multiplet, after replacing "'" with "_prime".

This function is meant to be used when creating file names. The motivation of this replacement is that handling files whose names contain an apostrophe "'" can be problematic, especially for administrators of computer clusters that rely on a set of well tested scripts to copy or move large amount of data between different storage devices.

Definition at line 79 of file isoparticletype.h.

                                              {
    std::string tmp_s = name_;
    std::size_t found_position = tmp_s.find("'");
    if (found_position != std::string::npos) {
      tmp_s.erase(found_position, 1);
      tmp_s.insert(found_position, "_prime");
    }
    return tmp_s;
  }

mass()

double smash::IsoParticleType::mass ( ) const

inline

Returns the (average) multiplet mass.

Definition at line 90 of file isoparticletype.h.

{ return mass_; }

width()

double smash::IsoParticleType::width ( ) const

inline

Returns the (average) multiplet width.

Definition at line 93 of file isoparticletype.h.

{ return width_; }

isospin()

int smash::IsoParticleType::isospin ( ) const

inline

Returns twice the total isospin of the multiplet.

Definition at line 96 of file isoparticletype.h.

{ return states_.size() - 1; }

spin()

unsigned int smash::IsoParticleType::spin ( ) const

inline

Returns twice the spin of the multiplet.

All particles in the multiplet are required to have the same spin.

Definition at line 102 of file isoparticletype.h.

{ return spin_; }

parity()

Parity smash::IsoParticleType::parity ( ) const

inline

Returns

The parity of the multiplet.

Definition at line 107 of file isoparticletype.h.

{ return parity_; }

is_hadron()

bool smash::IsoParticleType::is_hadron ( ) const

inline

Returns

Is this a hadron multiplet?

Definition at line 112 of file isoparticletype.h.

{ return states_[0]->is_hadron(); }

get_states()

ParticleTypePtrList smash::IsoParticleType::get_states ( ) const

inline

Returns list of states that form part of the multiplet.

Definition at line 115 of file isoparticletype.h.

{ return states_; }

add_state()

void smash::IsoParticleType::add_state

(

const ParticleType &

type

)

Add a new state to an existing multiplet (and check if isospin symmetry is fulfilled).

Parameters

type	The particle state to be added.

Definition at line 139 of file isoparticletype.cc.

                                                        {
  states_.push_back(&type);
 
  // check if isospin symmetry is fulfilled
  if (std::abs(mass() - type.mass()) > really_small) {
    logg[LParticleType].warn()
        << "Isospin symmetry is broken by mass of " << type.name() << ": "
        << type.mass() << " vs. " << mass();
  }
  if (std::abs(width() - type.width_at_pole()) > really_small) {
    logg[LParticleType].warn()
        << "Isospin symmetry is broken by width of " << type.name() << ": "
        << type.width_at_pole() << " vs. " << width();
  }
  if (spin() != type.spin()) {
    logg[LParticleType].error()
        << "Isospin symmetry is broken by spin of " << type.name() << ": "
        << type.spin() << " vs. " << spin();
  }
}

anti_multiplet()

const IsoParticleType * smash::IsoParticleType::anti_multiplet

(

)

const

Return a multiplet of antiparticles, if it is different from the original multiplet.

Otherwise, return a nullptr.

Definition at line 105 of file isoparticletype.cc.

                                                             {
  if (states_[0]->has_antiparticle()) {
    ParticleTypePtr anti = states_[0]->get_antiparticle();
    if (states_[0]->name() != multiplet_name(anti->name())) {
      return anti->iso_multiplet();
    } else {
      return nullptr;
    }
  } else {
    return nullptr;
  }
}

has_anti_multiplet()

bool smash::IsoParticleType::has_anti_multiplet

(

)

const

Check if there is a multiplet of antiparticles, which is different from the original multiplet.

Definition at line 118 of file isoparticletype.cc.

                                               {
  return anti_multiplet() != nullptr;
}

list_all()

const IsoParticleTypeList & smash::IsoParticleType::list_all ( )

static

Returns a list of all IsoParticleTypes.

Definition at line 41 of file isoparticletype.cc.

{ return iso_type_list; }

list_baryon_resonances()

const std::vector< const IsoParticleType * > smash::IsoParticleType::list_baryon_resonances ( )

static

Returns a list of all IsoParticleTypes that are baryon resonances.

Definition at line 23 of file isoparticletype.cc.

                                        {
  if (iso_baryon_resonances.empty()) {
    // Initialize.
    for (const auto &res : IsoParticleType::list_all()) {
      const auto baryon_number = res.states_[0]->pdgcode().baryon_number();
      if (res.states_[0]->is_stable() || (baryon_number <= 0)) {
        continue;
      }
      iso_baryon_resonances.push_back(&res);
    }
  }
  return iso_baryon_resonances;
}

try_find()

const IsoParticleType * smash::IsoParticleType::try_find ( const std::string &  name )

static

Returns the IsoParticleType pointer for the given name.

If the particle type is not found, an invalid pointer is returned. You can convert the pointer to a bool to check whether it is valid.

Parameters

name	The name of the particle type.

Note

The complexity of the search is \(\mathcal O(\log N)\).

Definition at line 56 of file isoparticletype.cc.

                                                                      {
  return try_find_private(name);
}

find() [1/2]

const IsoParticleType & smash::IsoParticleType::find ( const std::string &  name )

static

Returns the IsoParticleType object for the given name.

Parameters

name	The name of the of the particle type to be found.

Exceptions

ParticleNotFoundFailure

if name not found.

Note

The complexity of the search is \(\mathcal O(\log N)\).

Definition at line 60 of file isoparticletype.cc.

                                                                  {
  const auto found = try_find_private(name);
  if (!found) {
    throw ParticleNotFoundFailure("Isospin multiplet " + name + " not found!");
  }
  return *found;
}

find() [2/2]

IsoParticleType * smash::IsoParticleType::find ( const ParticleType &  type )

static

Returns the IsoParticleType object for the given type.

Parameters

type	The particle type to be found.

Exceptions

ParticleNotFoundFailure

if type not found.

Note

The complexity of the search is \(\mathcal O(\log N)\).

Definition at line 133 of file isoparticletype.cc.

                                                               {
  std::string multiname = multiplet_name(type.name());
  IsoParticleType &multiplet = find_private(multiname);
  return &multiplet;
}

exists()

bool smash::IsoParticleType::exists ( const std::string &  name )

static

Returns whether the ParticleType with the given pdgcode exists.

Parameters

name	The name of the particle type to be found.

Note

The complexity of the search is \(\mathcal O(\log N)\).

Definition at line 77 of file isoparticletype.cc.

                                                  {
  const auto found = try_find_private(name);
  return found;
}

find_state()

const ParticleTypePtr smash::IsoParticleType::find_state ( const std::string &  name )

static

Returns the ParticleType object for the given name, by first finding the correct multiplet and then looking for the desired state.

Parameters

name	The name of the particle state to be found.

Exceptions

std::runtime_error

if name is not found.

Definition at line 122 of file isoparticletype.cc.

                                                                    {
  const auto name = multiplet_name(n);
  const IsoParticleType &multiplet = IsoParticleType::find(name);
  auto found = std::find_if(multiplet.states_.begin(), multiplet.states_.end(),
                            [&n](ParticleTypePtr p) { return p->name() == n; });
  if (found == multiplet.states_.end()) {
    throw std::runtime_error("Isospin state " + n + " not found!");
  }
  return *found;
}

create_multiplet()

void smash::IsoParticleType::create_multiplet ( const ParticleType &  type )

static

Add a new multiplet to the global list of IsoParticleTypes, which contains type.

If the multiplet exists already, the type will be added to it.

Parameters

type	The multiplet to be created.

Definition at line 160 of file isoparticletype.cc.

                                                               {
  // create multiplet if it does not exist yet
  std::string multiname = multiplet_name(type.name());
  if (!exists(multiname)) {
    iso_type_list.emplace_back(multiname, type.mass(), type.width_at_pole(),
                               type.spin(), type.parity());
    logg[LParticleType].debug()
        << "Creating isospin multiplet " << multiname
        << " [ m = " << type.mass() << ", Γ = " << type.width_at_pole() << " ]";
  }
 
  // sort the iso-type list by name
  std::sort(iso_type_list.begin(), iso_type_list.end(),
            [](const IsoParticleType &l, const IsoParticleType &r) {
              return l.name() < r.name();
            });
 
  // add the specific type to the multiplet
  IsoParticleType &multiplet = find_private(multiname);
  multiplet.add_state(type);
}

tabulate_integrals()

void smash::IsoParticleType::tabulate_integrals ( sha256::Hash  hash, const std::filesystem::path &  tabulations_path  )

static

Tabulate all relevant integrals.

Parameters

hash	The hash of the particle properties. This is used to determine whether a cached tabulation can be reused or not.
tabulations_path	The path to the directory where the tabulations are cached.

Definition at line 271 of file isoparticletype.cc.

                                                                {
  // To avoid race conditions, make sure we are the only ones currently storing
  // tabulations. Otherwise, we ignore any stored tabulations and don't store
  // our results.
  FileLock lock(tabulations_path / "tabulations.lock");
  const std::filesystem::path &dir = lock.acquire() ? tabulations_path : "";
 
  const auto nuc = IsoParticleType::try_find("N");
  const auto pion = IsoParticleType::try_find("π");
  const auto kaon = IsoParticleType::try_find("K");
  const auto delta = IsoParticleType::try_find("Δ");
  const auto rho = IsoParticleType::try_find("ρ");
  const auto h1 = IsoParticleType::try_find("h₁(1170)");
  for (const auto &res : IsoParticleType::list_baryon_resonances()) {
    const auto antires = res->anti_multiplet();
    if (nuc) {
      cache_integral(NR_tabulations, dir, hash, *nuc, *res, antires, false);
    }
    if (pion) {
      cache_integral(piR_tabulations, dir, hash, *pion, *res, antires, false);
    }
    if (kaon) {
      cache_integral(RK_tabulations, dir, hash, *kaon, *res, antires, false);
    }
    if (delta) {
      cache_integral(DeltaR_tabulations, dir, hash, *delta, *res, antires,
                     true);
    }
  }
  if (rho) {
    cache_integral(rhoR_tabulations, dir, hash, *rho, *rho, nullptr, true);
  }
  if (rho && h1) {
    cache_integral(rhoR_tabulations, dir, hash, *rho, *h1, nullptr, true);
  }
}

get_integral_NR()

double smash::IsoParticleType::get_integral_NR

(

double

sqrts

)

Look up the tabulated resonance integral for the XX -> NR cross section.

Parameters

sqrts

The center-of-mass energy.

Definition at line 309 of file isoparticletype.cc.

                                                    {
  if (XS_NR_tabulation_ == nullptr) {
    const auto res = states_[0]->iso_multiplet();
    XS_NR_tabulation_ = &NR_tabulations.at(res->name());
  }
  return XS_NR_tabulation_->get_value_linear(sqrts);
}

get_integral_RR()

double smash::IsoParticleType::get_integral_RR	(	IsoParticleType *	type_res_2,
		double	sqrts
	)

Look up the tabulated resonance integral for the XX -> RR cross section.

Parameters

type_res_2	Type of the two resonances in the final state.
sqrts	The center-of-mass energy.

Definition at line 341 of file isoparticletype.cc.

                                                      {
  const auto res = states_[0]->iso_multiplet();
  if (type_res_2->states_[0]->is_Delta()) {
    if (XS_DeltaR_tabulation_ == nullptr) {
      XS_DeltaR_tabulation_ = &DeltaR_tabulations.at(res->name());
    }
    return XS_DeltaR_tabulation_->get_value_linear(sqrts);
  }
  if (type_res_2->name() == "ρ") {
    if (XS_rhoR_tabulation_ == nullptr) {
      XS_rhoR_tabulation_ = &rhoR_tabulations.at(res->name());
    }
    return XS_rhoR_tabulation_->get_value_linear(sqrts);
  }
  if (type_res_2->name() == "h₁(1170)") {
    if (XS_rhoR_tabulation_ == nullptr) {
      XS_rhoR_tabulation_ = &rhoR_tabulations.at(res->name());
    }
    return XS_rhoR_tabulation_->get_value_linear(sqrts);
  }
  std::stringstream err;
  err << "RR=" << name() << type_res_2->name() << " is not implemented";
  throw std::runtime_error(err.str());
}

get_integral_RK()

double smash::IsoParticleType::get_integral_RK

(

double

sqrts

)

Look up the tabulated resonance integral for the XX -> RK cross section.

Parameters

sqrts

The center-of-mass energy.

Definition at line 325 of file isoparticletype.cc.

                                                    {
  if (XS_RK_tabulation_ == nullptr) {
    const auto res = states_[0]->iso_multiplet();
    XS_RK_tabulation_ = &RK_tabulations.at(res->name());
  }
  return XS_RK_tabulation_->get_value_linear(sqrts);
}

get_integral_piR()

double smash::IsoParticleType::get_integral_piR

(

double

sqrts

)

Look up the tabulated resonance integral for the XX -> piR cross section.

Parameters

sqrts

The center-of-mass energy.

Definition at line 317 of file isoparticletype.cc.

                                                     {
  if (XS_piR_tabulation_ == nullptr) {
    const auto res = states_[0]->iso_multiplet();
    XS_piR_tabulation_ = &piR_tabulations.at(res->name());
  }
  return XS_piR_tabulation_->get_value_linear(sqrts);
}

get_integral_rhoR()

double smash::IsoParticleType::get_integral_rhoR

(

double

sqrts

)

Look up the tabulated resonance integral for the XX -> rhoR cross section.

Parameters

sqrts

The center-of-mass energy.

Definition at line 333 of file isoparticletype.cc.

                                                      {
  if (XS_rhoR_tabulation_ == nullptr) {
    const auto res = states_[0]->iso_multiplet();
    XS_rhoR_tabulation_ = &rhoR_tabulations.at(res->name());
  }
  return XS_rhoR_tabulation_->get_value_linear(sqrts);
}

find_private()

IsoParticleType & smash::IsoParticleType::find_private ( const std::string &  name )

staticprivate

Private version of the 'find' method that returns a non-const reference.

Parameters

[in]

name

The name of the of the particle type to be found.

Exceptions

ParticleNotFoundFailure

if name not found.

Definition at line 68 of file isoparticletype.cc.

                                                                    {
  auto found = try_find_private(name);
  if (!found) {
    throw ParticleNotFoundFailure("Isospin multiplet " + name +
                                  " not found (privately)!");
  }
  return *found;
}

Member Data Documentation

name_

std::string smash::IsoParticleType::name_

private

name of the multiplet

Definition at line 256 of file isoparticletype.h.

mass_

double smash::IsoParticleType::mass_

private

(average) mass of the multiplet

Definition at line 258 of file isoparticletype.h.

width_

double smash::IsoParticleType::width_

private

(average) width of the multiplet

Definition at line 260 of file isoparticletype.h.

spin_

unsigned int smash::IsoParticleType::spin_

private

twice the spin of the multiplet

Definition at line 262 of file isoparticletype.h.

parity_

Parity smash::IsoParticleType::parity_

private

parity of the multiplet

Definition at line 264 of file isoparticletype.h.

states_

ParticleTypePtrList smash::IsoParticleType::states_

private

list of states that are contained in the multiplet

Definition at line 266 of file isoparticletype.h.

XS_piR_tabulation_

Tabulation* smash::IsoParticleType::XS_piR_tabulation_ = nullptr

private

A tabulation of the spectral integral for the dpi -> d'pi cross sections.

Definition at line 269 of file isoparticletype.h.

XS_RK_tabulation_

Tabulation* smash::IsoParticleType::XS_RK_tabulation_ = nullptr

private

A tabulation of the spectral integral for the NK -> RK cross sections.

Definition at line 271 of file isoparticletype.h.

XS_NR_tabulation_

Tabulation* smash::IsoParticleType::XS_NR_tabulation_ = nullptr

private

A tabulation for the NN -> NR cross sections, where R is a resonance from this multiplet.

Definition at line 276 of file isoparticletype.h.

XS_DeltaR_tabulation_

Tabulation* smash::IsoParticleType::XS_DeltaR_tabulation_ = nullptr

private

A tabulation for the NN -> RΔ cross sections, where R is a resonance from this multiplet.

Definition at line 281 of file isoparticletype.h.

XS_rhoR_tabulation_

Tabulation* smash::IsoParticleType::XS_rhoR_tabulation_ = nullptr

private

A tabulation for the ρρ integrals.

Definition at line 285 of file isoparticletype.h.

---

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

• src/include/smash/isoparticletype.h
• src/isoparticletype.cc