Thermal-FIST  1.3
Package for hadron resonance gas model applications
Public Types | Public Member Functions | List of all members
thermalfist::ThermalParticle Class Reference

Class containing all information about a particle specie. More...

#include <ThermalParticle.h>

Public Types

enum  ResonanceWidthShape { RelativisticBreitWigner, NonRelativisticBreitWigner }
 Relativistic vs non-relativistic Breit-Wigner shape. More...
 
enum  ResonanceWidthIntegration {
  ZeroWidth, BWTwoGamma, FullInterval, FullIntervalWeighted,
  eBW, eBWconstBR
}
 Treatment of finite resonance widths. More...
 
typedef std::vector< ParticleDecayChannelParticleDecaysVector
 Vector of all decay channels of a particle. More...
 

Public Member Functions

 ThermalParticle (bool Stable=true, std::string Name="hadron", long long PDGID=0, double Deg=1., int Stat=0, double Mass=0., int Strange=0, int Baryon=0, int Charge=0, double AbsS=0., double Width=0., double Threshold=0., int Charm=0, double AbsC=0., int Quark=0)
 Construct a new ThermalParticle object. More...
 
 ~ThermalParticle (void)
 
void FillCoefficients ()
 Fills coefficients for mass integration in the energy independent BW scheme. More...
 
void FillCoefficientsDynamical ()
 Fills coefficients for mass integration in the eBW scheme. More...
 
double TotalWidtheBW (double M) const
 Total width (eBW scheme) at a given mass. More...
 
std::vector< double > BranchingRatiosM (double M, bool eBW=true) const
 (Energy-dependent) branching ratios More...
 
double ThermalMassDistribution (double M, double T, double Mu, double width)
 Mass distribution of a resonance in a thermal environment. More...
 
double ThermalMassDistribution (double M, double T, double Mu)
 Mass distribution of a resonance in a thermal environment. More...
 
void NormalizeBranchingRatios ()
 Normalizes all branching ratios such that they sum up to 100%. More...
 
void RestoreBranchingRatios ()
 Restores all branching ratios to the original values. More...
 
double Density (const ThermalModelParameters &params, IdealGasFunctions::Quantity type=IdealGasFunctions::ParticleDensity, bool useWidth=0, double mu=0.) const
 Computes a specified ideal gas thermodynamic function. More...
 
double DensityCluster (int n, const ThermalModelParameters &params, IdealGasFunctions::Quantity type=IdealGasFunctions::ParticleDensity, bool useWidth=0, double mu=0.) const
 
double chi (int index, const ThermalModelParameters &params, bool useWidth=0, double mu=0.) const
 Computes the ideal gas generalized susceptibility \( \chi_n \equiv \frac{\partial^n p/T^4}{\partial (mu/T)^n} \). More...
 
double ScaledVariance (const ThermalModelParameters &params, bool useWidth=0, double mu=0.) const
 Computes the scaled variance of particle number fluctuations in the ideal gas. Computes the scaled variance ( / ) of particle number fluctuations in the ideal gas. Takes into account chemical non-equilibrium fugacity factors and finite resonance widths. More...
 
double Skewness (const ThermalModelParameters &params, bool useWidth=0, double mu=0.) const
 Computes the normalized skewness of particle number fluctuations in the ideal gas. More...
 
double Kurtosis (const ThermalModelParameters &params, bool useWidth=0, double mu=0.) const
 Computes the normalized excess kurtosis of particle number fluctuations in the ideal gas. More...
 
double FD (double k, double T, double mu, double m) const
 Fermi-Dirac distribution function. More...
 
double GetAbsQ () const
 
double GetCharge (int index) const
 Get the quantum number numbered by the index. More...
 
double GetAbsCharge (int index) const
 Get the absolute value of a quantum number. More...
 
bool IsNeutral () const
 Whether particle is neutral one. More...
 
bool IsStable () const
 Return particle stability flag. More...
 
void SetStable (bool stable=true)
 Sets particle stability flag. More...
 
bool IsAntiParticle () const
 Whether particle is an antiparticle, i.e. its PDG ID is < 0. More...
 
void SetAntiParticle (bool antpar=true)
 Set manually whether particle is an antiparticle. More...
 
const std::string & Name () const
 Particle's name. More...
 
void SetName (const std::string &name)
 Set particle's name. More...
 
long long PdgId () const
 Particle's Particle Data Group (PDG) ID number. More...
 
void SetPdgId (long long PdgId)
 Set particle's particle's Particle Data Group (PDG) ID number. More...
 
double Degeneracy () const
 Particle's internal degeneracy factor. More...
 
void SetDegeneracy (double deg)
 Set particle's internal degeneracy factor. More...
 
int Statistics () const
 Particle's statistics. More...
 
void SetStatistics (int stat)
 Set particle's statistics. More...
 
void UseStatistics (bool enable)
 Use quantum statistics. More...
 
double Mass () const
 Particle's mass [GeV]. More...
 
void SetMass (double mass)
 Set particle's mass [GeV]. More...
 
int BaryonCharge () const
 Particle's baryon number. More...
 
void SetBaryonCharge (int chg)
 Set particle's baryon number. More...
 
int ElectricCharge () const
 Particle's electric charge. More...
 
void SetElectricCharge (int chg)
 Set particle's electric charge. More...
 
int Strangeness () const
 Particle's strangeness. More...
 
void SetStrangenessCharge (int chg)
 Set particle's strangeness. More...
 
int Charm () const
 Particle's charm. More...
 
void SetCharm (int chg)
 Set particle's charm. More...
 
int ConservedCharge (ConservedCharge::Name chg) const
 One of the four QCD conserved charges. More...
 
double ArbitraryCharge () const
 Arbitrary (auxiliary) charge assigned to particle. More...
 
void SetArbitraryCharge (double arbchg)
 Assigns arbitrary (auxiliary) charge to particle. More...
 
double AbsoluteQuark () const
 Absolute light quark content |u,d|. More...
 
void SetAbsoluteQuark (double abschg)
 Set absolute light quark content |u,d|. More...
 
double AbsoluteStrangeness () const
 Absolute strange quark content |s|. More...
 
void SetAbsoluteStrangeness (double abschg)
 Set absolute strange quark content |s|, light quark content then re-evaluted. More...
 
double AbsoluteCharm () const
 Absolute charm quark content |s|. More...
 
void SetAbsoluteCharm (double abschg)
 Set absolute charm quark content |s|, light quark content then re-evaluted. More...
 
bool ZeroWidthEnforced () const
 Whether zero-width approximation is enforced for this particle species. More...
 
double ResonanceWidth () const
 Particle's width at the pole mass (GeV) More...
 
void SetResonanceWidth (double width)
 Sets the particle's width at the pole mass. More...
 
double DecayThresholdMass () const
 The decays threshold mass. More...
 
void SetDecayThresholdMass (double threshold)
 Set the decays threshold mass. More...
 
double DecayThresholdMassDynamical () const
 
void SetDecayThresholdMassDynamical (double threshold)
 Set the threshold mass manually for use in the eBW scheme. More...
 
void CalculateAndSetDynamicalThreshold ()
 
ResonanceWidthShape GetResonanceWidthShape () const
 Resonance width profile in use. More...
 
void SetResonanceWidthShape (ResonanceWidthShape shape)
 Set the resonance width profile to use. More...
 
ResonanceWidthIntegration GetResonanceWidthIntegrationType () const
 Resonance width integration scheme used to treat finite resonance widths. More...
 
void SetResonanceWidthIntegrationType (ResonanceWidthIntegration type)
 Set the ResonanceWidthIntegration scheme used to treat finite resonance widths. More...
 
double MassDistribution (double m) const
 
double MassDistribution (double m, double width) const
 
double Weight () const
 Particle's weight. More...
 
void SetWeight (double weight)
 Set particle's weight factor. More...
 
ParticleDecayType::DecayType DecayType () const
 Decay type of the particle. More...
 
void SetDecayType (ParticleDecayType::DecayType type)
 Set particle's Decay Type. More...
 
const ParticleDecaysVectorDecays () const
 A vector of particle's decays. More...
 
ParticleDecaysVectorDecays ()
 Returns a non-const reference to Decays() More...
 
void SetDecays (const ParticleDecaysVector &Decays)
 Set the Decays vector. More...
 
void ClearDecays ()
 Remove all decays. More...
 
void ReadDecays (std::string filename="")
 Read decays from a file and assign them to the particle. More...
 
void CalculateThermalBranchingRatios (const ThermalModelParameters &params, bool useWidth=0, double mu=0.)
 Computes average decay branching ratios by integrating over the thermal mass distribution. More...
 
void SetCalculationType (IdealGasFunctions::QStatsCalculationType type)
 Sets the CalculationType() method to evaluate quantum statistics. More...
 
IdealGasFunctions::QStatsCalculationType CalculationType () const
 Method to evaluate quantum statistics. More...
 
int ClusterExpansionOrder () const
 Number of terms in the cluster expansion method. More...
 
void SetClusterExpansionOrder (int order)
 Set ClusterExpansionOrder() More...
 
std::vector< double > BranchingRatioWeights (const std::vector< double > &ms) const
 
const std::vector< double > & Nch () const
 
std::vector< double > & Nch ()
 
const std::vector< double > & DeltaNch () const
 
std::vector< double > & DeltaNch ()
 
ThermalParticle GenerateAntiParticle () const
 Generates the anti-particle to the current particle specie. More...
 
bool operator== (const ThermalParticle &rhs) const
 
bool operator!= (const ThermalParticle &rhs) const
 
const ParticleDecaysVectorDecaysOriginal () const
 A backup copy of particle's decays. More...
 
ParticleDecaysVectorDecaysOriginal ()
 
void SetDecaysOriginal (const ParticleDecaysVector &DecaysOrig)
 

Detailed Description

Class containing all information about a particle specie.

Also contains implementation of calculation of various thermodynamic quantities in an ideal gas in the grand canonical ensemble.

Examples:
BagModelFit.cpp, CalculationTmu.cpp, and cpc4-mcHRG.cpp.

Definition at line 63 of file ThermalParticle.h.

Member Typedef Documentation

Vector of all decay channels of a particle.

Definition at line 67 of file ThermalParticle.h.

Member Enumeration Documentation

Treatment of finite resonance widths.

Enumerator
ZeroWidth 

Zero-width approximation.

BWTwoGamma 

Energy-independent Breit-Wigner in +-2 interval.

FullInterval 

Energy-independent Breit-Wigner in full energy interval.

FullIntervalWeighted 

Energy-independent Breit-Wigner in full energy interval with weighted branching ratios.

eBW 

Energy-dependent Breit-Wigner scheme (eBW)

eBWconstBR 

Energy-dependent Breit-Wigner scheme (eBW) with constant branching ratios when evaluating feeddown.

Definition at line 82 of file ThermalParticle.h.

Relativistic vs non-relativistic Breit-Wigner shape.

Enumerator
RelativisticBreitWigner 
NonRelativisticBreitWigner 

Definition at line 73 of file ThermalParticle.h.

Constructor & Destructor Documentation

thermalfist::ThermalParticle::ThermalParticle ( bool  Stable = true,
std::string  Name = "hadron",
long long  PDGID = 0,
double  Deg = 1.,
int  Stat = 0,
double  Mass = 0.,
int  Strange = 0,
int  Baryon = 0,
int  Charge = 0,
double  AbsS = 0.,
double  Width = 0.,
double  Threshold = 0.,
int  Charm = 0,
double  AbsC = 0.,
int  Quark = 0 
)

Construct a new ThermalParticle object.

Parameters
StableParticle's stability flag
NameParticle's name
PDGIDParticle's PDG ID
DegParticle's internal degeneracy
StatStatistics: 1 – Fermi-Dirac, -1 – Bose-Einstein, 0 - Maxwell-Boltzmann
MassParticle's mass
StrangeParticle's strangeness
BaryonParticle's baryon number
ChargeParticle's electric charge
AbsSParticle's strange quark content
WidthParticle's width
ThresholdParticle's decays threshold
CharmParticle's charm
AbsCParticle's charm quark content
QuarkParticle's light quark content

Definition at line 26 of file ThermalParticle.cpp.

thermalfist::ThermalParticle::~ThermalParticle ( void  )

Definition at line 53 of file ThermalParticle.cpp.

Member Function Documentation

double thermalfist::ThermalParticle::AbsoluteCharm ( ) const
inline

Absolute charm quark content |s|.

Definition at line 432 of file ThermalParticle.h.

double thermalfist::ThermalParticle::AbsoluteQuark ( ) const
inline

Absolute light quark content |u,d|.

Definition at line 420 of file ThermalParticle.h.

double thermalfist::ThermalParticle::AbsoluteStrangeness ( ) const
inline

Absolute strange quark content |s|.

Definition at line 426 of file ThermalParticle.h.

double thermalfist::ThermalParticle::ArbitraryCharge ( ) const
inline

Arbitrary (auxiliary) charge assigned to particle.

Returns
Arbitrary (auxiliary) charge

Definition at line 410 of file ThermalParticle.h.

int thermalfist::ThermalParticle::BaryonCharge ( ) const
inline

Particle's baryon number.

Examples:
CalculationTmu.cpp, cpc1-HRG-TDep.cpp, cpc2-chi2-vs-T.cpp, and cpc4-mcHRG.cpp.

Definition at line 380 of file ThermalParticle.h.

std::vector< double > thermalfist::ThermalParticle::BranchingRatiosM ( double  M,
bool  eBW = true 
) const

(Energy-dependent) branching ratios

Parameters
MEnergy [GeV]
eBWWhether branching ratios are energy-dependent or not
Returns
std::vector<double> A vector of branching ratios for all decay channels

Definition at line 531 of file ThermalParticle.cpp.

std::vector< double > thermalfist::ThermalParticle::BranchingRatioWeights ( const std::vector< double > &  ms) const

Definition at line 196 of file ThermalParticle.cpp.

void thermalfist::ThermalParticle::CalculateAndSetDynamicalThreshold ( )

Evaluate the threshold mass as the minimum threshold among all the decay channels

Definition at line 90 of file ThermalParticle.cpp.

void thermalfist::ThermalParticle::CalculateThermalBranchingRatios ( const ThermalModelParameters params,
bool  useWidth = 0,
double  mu = 0. 
)

Computes average decay branching ratios by integrating over the thermal mass distribution.

To be later used when evaluating feeddown contributions.

Parameters
paramsStructure containing the temperature value and the chemical factors.
useWidthWhether finite widths are taken into account.
muChemical potential.

Definition at line 159 of file ThermalParticle.cpp.

IdealGasFunctions::QStatsCalculationType thermalfist::ThermalParticle::CalculationType ( ) const
inline

Method to evaluate quantum statistics.

Cluster expansion or numerical integration using the quadratures.

Returns
IdealGasFunctions::QStatsCalculationType

Definition at line 618 of file ThermalParticle.h.

int thermalfist::ThermalParticle::Charm ( ) const
inline

Particle's charm.

Definition at line 397 of file ThermalParticle.h.

double thermalfist::ThermalParticle::chi ( int  index,
const ThermalModelParameters params,
bool  useWidth = 0,
double  mu = 0. 
) const

Computes the ideal gas generalized susceptibility \( \chi_n \equiv \frac{\partial^n p/T^4}{\partial (mu/T)^n} \).

Computes the generalized susceptibility \( \chi_n \equiv \frac{\partial^n p/T^4}{\partial (mu/T)^n} \) of the corresponding ideal gas. Takes into account chemical non-equilibrium fugacity factors and finite resonance widths.

Parameters
indexOrder of the susceptibility.
paramsStructure containing the temperature value and the chemical factors.
useWidthWhether finite widths are taken into account.
muChemical potential.
Returns
Value of the computed susceptility.

Definition at line 767 of file ThermalParticle.cpp.

void thermalfist::ThermalParticle::ClearDecays ( )
inline

Remove all decays.

Definition at line 578 of file ThermalParticle.h.

int thermalfist::ThermalParticle::ClusterExpansionOrder ( ) const
inline

Number of terms in the cluster expansion method.

Returns
Number of terms in the cluster expansion method.

Definition at line 625 of file ThermalParticle.h.

int thermalfist::ThermalParticle::ConservedCharge ( ConservedCharge::Name  chg) const

One of the four QCD conserved charges.

Definition at line 576 of file ThermalParticle.cpp.

const ParticleDecaysVector& thermalfist::ThermalParticle::Decays ( ) const
inline

A vector of particle's decays.

A vector of ParticleDecay objects corresponding to all decay channels of the particle.

Returns
const std::vector<ParticleDecay>&

Definition at line 563 of file ThermalParticle.h.

ParticleDecaysVector& thermalfist::ThermalParticle::Decays ( )
inline

Returns a non-const reference to Decays()

Definition at line 566 of file ThermalParticle.h.

const ParticleDecaysVector& thermalfist::ThermalParticle::DecaysOriginal ( ) const
inline

A backup copy of particle's decays.

Definition at line 582 of file ThermalParticle.h.

ParticleDecaysVector& thermalfist::ThermalParticle::DecaysOriginal ( )
inline

Definition at line 583 of file ThermalParticle.h.

double thermalfist::ThermalParticle::DecayThresholdMass ( ) const
inline

The decays threshold mass.

The threshold mass for calculation in the energy-independent Breit-Wigner scheme

Returns
Threshold mass

Definition at line 462 of file ThermalParticle.h.

double thermalfist::ThermalParticle::DecayThresholdMassDynamical ( ) const
inline

Returns threshold mass as the minimum threshold among all the decay channels. Used in the eBW scheme

Definition at line 479 of file ThermalParticle.h.

ParticleDecayType::DecayType thermalfist::ThermalParticle::DecayType ( ) const
inline

Decay type of the particle.

Returns
Decay type of the particle.

Definition at line 550 of file ThermalParticle.h.

double thermalfist::ThermalParticle::Degeneracy ( ) const
inline

Particle's internal degeneracy factor.

Definition at line 338 of file ThermalParticle.h.

const std::vector<double>& thermalfist::ThermalParticle::DeltaNch ( ) const
inline

Definition at line 635 of file ThermalParticle.h.

std::vector<double>& thermalfist::ThermalParticle::DeltaNch ( )
inline

Definition at line 636 of file ThermalParticle.h.

double thermalfist::ThermalParticle::Density ( const ThermalModelParameters params,
IdealGasFunctions::Quantity  type = IdealGasFunctions::ParticleDensity,
bool  useWidth = 0,
double  mu = 0. 
) const

Computes a specified ideal gas thermodynamic function.

Computes a specified ideal gas thermodynamic function. Takes into account chemical non-equilibrium fugacity factors and finite resonance widths.

Parameters
paramsStructure containing the temperature value and the chemical factors.
typeThe type of the thermodynamic function calculated.
useWidthWhether finite widths are taken into account.
muChemical potential.
Returns
Value of the computed thermodynamic function.

Definition at line 594 of file ThermalParticle.cpp.

double thermalfist::ThermalParticle::DensityCluster ( int  n,
const ThermalModelParameters params,
IdealGasFunctions::Quantity  type = IdealGasFunctions::ParticleDensity,
bool  useWidth = 0,
double  mu = 0. 
) const

Computes contribution of a single term in the cluster expansion to the quantity which is to be computed by the Density() method.

Parameters
nNumber of the term.
paramsStructure containing the temperature value and the chemical factors.
typeThe type of the thermodynamic function calculated.
useWidthWhether finite widths are taken into account.
muChemical potential.
Returns
Value of the computed term.

Definition at line 649 of file ThermalParticle.cpp.

int thermalfist::ThermalParticle::ElectricCharge ( ) const
inline

Particle's electric charge.

Examples:
cpc4-mcHRG.cpp.

Definition at line 386 of file ThermalParticle.h.

double thermalfist::ThermalParticle::FD ( double  k,
double  T,
double  mu,
double  m 
) const

Fermi-Dirac distribution function.

Parameters
kMomentum [GeV]
TTemperature [GeV]
muChemical potential [GeV]
mMass [GeV]
Returns
Computed Fermi-Dirac function.

Definition at line 741 of file ThermalParticle.cpp.

void thermalfist::ThermalParticle::FillCoefficients ( )

Fills coefficients for mass integration in the energy independent BW scheme.

Definition at line 318 of file ThermalParticle.cpp.

void thermalfist::ThermalParticle::FillCoefficientsDynamical ( )

Fills coefficients for mass integration in the eBW scheme.

Definition at line 343 of file ThermalParticle.cpp.

ThermalParticle thermalfist::ThermalParticle::GenerateAntiParticle ( ) const

Generates the anti-particle to the current particle specie.

Note: Decay channels of anti-particle are NOT generated by this method and have to be set elsewhere.

Returns
ThermalParticle Antiparticle

Definition at line 227 of file ThermalParticle.cpp.

double thermalfist::ThermalParticle::GetAbsCharge ( int  index) const

Get the absolute value of a quantum number.

Parameters
index0 – absolute baryon number, 1 – absolute electric charge, 2 – strange quark content, 3 – charm quark content
Returns
Particle's absolute value of a quantum number

Definition at line 759 of file ThermalParticle.cpp.

double thermalfist::ThermalParticle::GetAbsQ ( ) const

Computes the light quark content as follows: |u,d| = 3 * |B| - |s| - |c| where |B| is the absolute baryon number and |s| and |c| is the stange and charm quark contents, respectively.

Returns
Computed light quark content.

Definition at line 746 of file ThermalParticle.cpp.

double thermalfist::ThermalParticle::GetCharge ( int  index) const

Get the quantum number numbered by the index.

Parameters
index0 – baryon number, 1 – electric charge, 2 – strangeness, 3 – charm
Returns
Particle's quantum number

Definition at line 751 of file ThermalParticle.cpp.

ResonanceWidthIntegration thermalfist::ThermalParticle::GetResonanceWidthIntegrationType ( ) const
inline

Resonance width integration scheme used to treat finite resonance widths.

Returns
ResonanceWidthIntegration

Definition at line 510 of file ThermalParticle.h.

ResonanceWidthShape thermalfist::ThermalParticle::GetResonanceWidthShape ( ) const
inline

Resonance width profile in use.

Can be relativistic or non-relativistic Breit-Wigner

Returns
ResonanceWidthShape Width profile used

Definition at line 495 of file ThermalParticle.h.

bool thermalfist::ThermalParticle::IsAntiParticle ( ) const
inline

Whether particle is an antiparticle, i.e. its PDG ID is < 0.

Definition at line 320 of file ThermalParticle.h.

bool thermalfist::ThermalParticle::IsNeutral ( ) const

Whether particle is neutral one.

Returns
true Particle is neutral (all quantum numbers are zero).
false Particle is not neutral (anti-particle exists).

Definition at line 589 of file ThermalParticle.cpp.

bool thermalfist::ThermalParticle::IsStable ( ) const
inline

Return particle stability flag.

Definition at line 314 of file ThermalParticle.h.

double thermalfist::ThermalParticle::Kurtosis ( const ThermalModelParameters params,
bool  useWidth = 0,
double  mu = 0. 
) const

Computes the normalized excess kurtosis of particle number fluctuations in the ideal gas.

Computes the normalized excess kurtosis ( / ) of particle number fluctuations in the ideal gas. Takes into account chemical non-equilibrium fugacity factors and finite resonance widths.

Parameters
paramsStructure containing the temperature value and the chemical factors.
useWidthWhether finite widths are taken into account.
muChemical potential.
Returns
Value of the computed normalized excess kurtosis.

Definition at line 730 of file ThermalParticle.cpp.

double thermalfist::ThermalParticle::Mass ( ) const
inline

Particle's mass [GeV].

Examples:
BagModelFit.cpp, and cpc2-chi2-vs-T.cpp.

Definition at line 374 of file ThermalParticle.h.

double thermalfist::ThermalParticle::MassDistribution ( double  m) const

Resonance mass distribution: Relativistic or non-relativistic Breit-Wigner evaluated at the given mass m (GeV) and pole mass's width

Parameters
mMass (GeV)
Returns
Mass distribution

Definition at line 115 of file ThermalParticle.cpp.

double thermalfist::ThermalParticle::MassDistribution ( double  m,
double  width 
) const

Definition at line 120 of file ThermalParticle.cpp.

const std::string& thermalfist::ThermalParticle::Name ( ) const
inline

Particle's name.

Examples:
PCE-Saha-LHC.cpp.

Definition at line 326 of file ThermalParticle.h.

const std::vector<double>& thermalfist::ThermalParticle::Nch ( ) const
inline

Definition at line 632 of file ThermalParticle.h.

std::vector<double>& thermalfist::ThermalParticle::Nch ( )
inline

Definition at line 633 of file ThermalParticle.h.

void thermalfist::ThermalParticle::NormalizeBranchingRatios ( )

Normalizes all branching ratios such that they sum up to 100%.

Definition at line 298 of file ThermalParticle.cpp.

bool thermalfist::ThermalParticle::operator!= ( const ThermalParticle rhs) const
inline

Definition at line 650 of file ThermalParticle.h.

bool thermalfist::ThermalParticle::operator== ( const ThermalParticle rhs) const

Definition at line 255 of file ThermalParticle.cpp.

long long thermalfist::ThermalParticle::PdgId ( ) const
inline

Particle's Particle Data Group (PDG) ID number.

Definition at line 332 of file ThermalParticle.h.

void thermalfist::ThermalParticle::ReadDecays ( std::string  filename = "")

Read decays from a file and assign them to the particle.

Definition at line 138 of file ThermalParticle.cpp.

double thermalfist::ThermalParticle::ResonanceWidth ( ) const
inline

Particle's width at the pole mass (GeV)

Definition at line 441 of file ThermalParticle.h.

void thermalfist::ThermalParticle::RestoreBranchingRatios ( )

Restores all branching ratios to the original values.

Definition at line 309 of file ThermalParticle.cpp.

double thermalfist::ThermalParticle::ScaledVariance ( const ThermalModelParameters params,
bool  useWidth = 0,
double  mu = 0. 
) const

Computes the scaled variance of particle number fluctuations in the ideal gas. Computes the scaled variance ( / ) of particle number fluctuations in the ideal gas. Takes into account chemical non-equilibrium fugacity factors and finite resonance widths.

Parameters
paramsStructure containing the temperature value and the chemical factors.
useWidthWhether finite widths are taken into account.
muChemical potential.
Returns
Value of the computed scaled variance.

Definition at line 709 of file ThermalParticle.cpp.

void thermalfist::ThermalParticle::SetAbsoluteCharm ( double  abschg)
inline

Set absolute charm quark content |s|, light quark content then re-evaluted.

Definition at line 435 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetAbsoluteQuark ( double  abschg)
inline

Set absolute light quark content |u,d|.

Definition at line 423 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetAbsoluteStrangeness ( double  abschg)
inline

Set absolute strange quark content |s|, light quark content then re-evaluted.

Definition at line 429 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetAntiParticle ( bool  antpar = true)
inline

Set manually whether particle is an antiparticle.

Definition at line 323 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetArbitraryCharge ( double  arbchg)
inline

Assigns arbitrary (auxiliary) charge to particle.

Parameters
Arbitrary(auxiliary) charge

Definition at line 417 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetBaryonCharge ( int  chg)
inline

Set particle's baryon number.

Definition at line 383 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetCalculationType ( IdealGasFunctions::QStatsCalculationType  type)
inline

Sets the CalculationType() method to evaluate quantum statistics.

Parameters
typeMethod to evaluate quantum statistics.

Definition at line 608 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetCharm ( int  chg)
inline

Set particle's charm.

Definition at line 400 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetClusterExpansionOrder ( int  order)
inline

Set ClusterExpansionOrder()

Definition at line 628 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetDecays ( const ParticleDecaysVector Decays)
inline

Set the Decays vector.

Sets all decays of the particle

Parameters
DecaysParticleDecay vector containing all particle decays

Definition at line 575 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetDecaysOriginal ( const ParticleDecaysVector DecaysOrig)
inline

Definition at line 584 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetDecayThresholdMass ( double  threshold)

Set the decays threshold mass.

If width is non-zero, the coefficients used for mass integration in the energy independent scheme are re-evaluated

Parameters
thresholdThreshold mass (GeV)

Definition at line 73 of file ThermalParticle.cpp.

void thermalfist::ThermalParticle::SetDecayThresholdMassDynamical ( double  threshold)

Set the threshold mass manually for use in the eBW scheme.

Definition at line 82 of file ThermalParticle.cpp.

void thermalfist::ThermalParticle::SetDecayType ( ParticleDecayType::DecayType  type)
inline

Set particle's Decay Type.

Definition at line 553 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetDegeneracy ( double  deg)
inline

Set particle's internal degeneracy factor.

Definition at line 341 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetElectricCharge ( int  chg)
inline

Set particle's electric charge.

Definition at line 389 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetMass ( double  mass)

Set particle's mass [GeV].

Definition at line 567 of file ThermalParticle.cpp.

void thermalfist::ThermalParticle::SetName ( const std::string &  name)
inline

Set particle's name.

Definition at line 329 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetPdgId ( long long  PdgId)
inline

Set particle's particle's Particle Data Group (PDG) ID number.

Definition at line 335 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetResonanceWidth ( double  width)

Sets the particle's width at the pole mass.

If width is non-zero, the coefficients used for mass integration are re-evaluated

Parameters
widthWidth (GeV)

Definition at line 64 of file ThermalParticle.cpp.

void thermalfist::ThermalParticle::SetResonanceWidthIntegrationType ( ResonanceWidthIntegration  type)

Set the ResonanceWidthIntegration scheme used to treat finite resonance widths.

Parameters
typeResonanceWidthIntegration scheme

Definition at line 107 of file ThermalParticle.cpp.

void thermalfist::ThermalParticle::SetResonanceWidthShape ( ResonanceWidthShape  shape)

Set the resonance width profile to use.

Parameters
shapeRelativistic or non-relativistic Breit-Wigner

Definition at line 99 of file ThermalParticle.cpp.

void thermalfist::ThermalParticle::SetStable ( bool  stable = true)
inline

Sets particle stability flag.

Examples:
cpc4-mcHRG.cpp.

Definition at line 317 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetStatistics ( int  stat)
inline

Set particle's statistics.

1 – Fermi-Dirac -1 – Bose-Einstein 0 - Maxwell-Boltzmann

Parameters
statStatistics

Definition at line 363 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetStrangenessCharge ( int  chg)
inline

Set particle's strangeness.

Definition at line 394 of file ThermalParticle.h.

void thermalfist::ThermalParticle::SetWeight ( double  weight)
inline

Set particle's weight factor.

Definition at line 543 of file ThermalParticle.h.

double thermalfist::ThermalParticle::Skewness ( const ThermalModelParameters params,
bool  useWidth = 0,
double  mu = 0. 
) const

Computes the normalized skewness of particle number fluctuations in the ideal gas.

Computes the normalized skewness ( / ) of particle number fluctuations in the ideal gas. Takes into account chemical non-equilibrium fugacity factors and finite resonance widths.

Parameters
paramsStructure containing the temperature value and the chemical factors.
useWidthWhether finite widths are taken into account.
muChemical potential.
Returns
Value of the computed normalized skewness.

Definition at line 719 of file ThermalParticle.cpp.

int thermalfist::ThermalParticle::Statistics ( ) const
inline

Particle's statistics.

1 – Fermi-Dirac, -1 – Bose-Einstein, 0 - Maxwell-Boltzmann

Returns
Particle's statistics

Definition at line 352 of file ThermalParticle.h.

int thermalfist::ThermalParticle::Strangeness ( ) const
inline

Particle's strangeness.

Examples:
cpc4-mcHRG.cpp.

Definition at line 392 of file ThermalParticle.h.

double thermalfist::ThermalParticle::ThermalMassDistribution ( double  M,
double  T,
double  Mu,
double  width 
)

Mass distribution of a resonance in a thermal environment.

Mass distribution of a resonance in a thermal environment (not normalized!). Width is specified manually.

Parameters
MMass [GeV]
TTemperature [GeV]
MuChemical potential [GeV]
widthResonance width [GeV]
Returns
Mass distribution function

Definition at line 552 of file ThermalParticle.cpp.

double thermalfist::ThermalParticle::ThermalMassDistribution ( double  M,
double  T,
double  Mu 
)

Mass distribution of a resonance in a thermal environment.

Mass distribution of a resonance in a thermal environment (not normalized!). Energy-dependent width is computed automatically.

Parameters
MMass [GeV]
TTemperature [GeV]
MuChemical potential [GeV]
Returns
Mass distribution function (not normalized!)

Definition at line 557 of file ThermalParticle.cpp.

double thermalfist::ThermalParticle::TotalWidtheBW ( double  M) const

Total width (eBW scheme) at a given mass.

Definition at line 510 of file ThermalParticle.cpp.

void thermalfist::ThermalParticle::UseStatistics ( bool  enable)

Use quantum statistics.

Parameters
enabletrue – use quantum statistics false – use Maxwell-Boltzmann statistics

Definition at line 562 of file ThermalParticle.cpp.

double thermalfist::ThermalParticle::Weight ( ) const
inline

Particle's weight.

Multiplies the degeneracy factor, equal to one by default. Currently not used.

Returns
Weight.

Definition at line 540 of file ThermalParticle.h.

bool thermalfist::ThermalParticle::ZeroWidthEnforced ( ) const

Whether zero-width approximation is enforced for this particle species.

Definition at line 57 of file ThermalParticle.cpp.


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