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< ParticleDecayChannel >	ParticleDecaysVector
	Vector of all decay channels of a particle.

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.

	~ThermalParticle (void)

void	FillCoefficients ()
	Fills coefficients for mass integration in the energy independent BW scheme.

void	FillCoefficientsDynamical ()
	Fills coefficients for mass integration in the eBW scheme.

double	TotalWidtheBW (double M) const
	Total width (eBW scheme) at a given mass.

std::vector< double >	BranchingRatiosM (double M, bool eBW=true) const
	(Energy-dependent) branching ratios

double	ThermalMassDistribution (double M, double T, double Mu, double width)
	Mass distribution of a resonance in a thermal environment.

double	ThermalMassDistribution (double M, double T, double Mu)
	Mass distribution of a resonance in a thermal environment.

void	NormalizeBranchingRatios ()
	Normalizes all branching ratios such that they sum up to 100%.

void	RestoreBranchingRatios ()
	Restores all branching ratios to the original values.

double	Density (const ThermalModelParameters &params, IdealGasFunctions::Quantity type=IdealGasFunctions::ParticleDensity, bool useWidth=0, double mu=0.) const
	Computes a specified ideal gas thermodynamic function.

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} \).

double	chiDimensionfull (int index, const ThermalModelParameters &params, bool useWidth=0, double mu=0.) const
	Computes the ideal gas dimensionfull susceptibility \( \chi_n \equiv \frac{\partial^n p}{\partial mu^n} \).

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 (\chi_2 / \chi_1) of particle number fluctuations in the ideal gas. Takes into account chemical non-equilibrium fugacity factors and finite resonance widths.

double	Skewness (const ThermalModelParameters &params, bool useWidth=0, double mu=0.) const
	Computes the normalized skewness of particle number fluctuations in the ideal gas.

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.

double	FD (double k, double T, double mu, double m) const
	Fermi-Dirac distribution function.

double	GetAbsQ () const

double	GetCharge (int index) const
	Get the quantum number numbered by the index.

double	GetAbsCharge (int index) const
	Get the absolute value of a quantum number.

bool	IsNeutral () const
	Whether particle is neutral one.

bool	IsStable () const
	Return particle stability flag.

void	SetStable (bool stable=true)
	Sets particle stability flag.

bool	IsAntiParticle () const
	Whether particle is an antiparticle, i.e. its PDG ID is < 0.

void	SetAntiParticle (bool antpar=true)
	Set manually whether particle is an antiparticle.

const std::string &	Name () const
	Particle's name.

void	SetName (const std::string &name)
	Set particle's name.

long long	PdgId () const
	Particle's Particle Data Group (PDG) ID number.

void	SetPdgId (long long PdgId)
	Set particle's particle's Particle Data Group (PDG) ID number.

double	Degeneracy () const
	Particle's internal degeneracy factor.

void	SetDegeneracy (double deg)
	Set particle's internal degeneracy factor.

int	Statistics () const
	Particle's statistics.

void	SetStatistics (int stat)
	Set particle's statistics.

void	UseStatistics (bool enable)
	Use quantum statistics.

double	Mass () const
	Particle's mass [GeV].

void	SetMass (double mass)
	Set particle's mass [GeV].

int	BaryonCharge () const
	Particle's baryon number.

void	SetBaryonCharge (int chg)
	Set particle's baryon number.

int	ElectricCharge () const
	Particle's electric charge.

void	SetElectricCharge (int chg)
	Set particle's electric charge.

int	Strangeness () const
	Particle's strangeness.

void	SetStrangenessCharge (int chg)
	Set particle's strangeness.

int	Charm () const
	Particle's charm.

void	SetCharm (int chg)
	Set particle's charm.

int	ConservedCharge (ConservedCharge::Name chg) const
	One of the four QCD conserved charges.

double	ArbitraryCharge () const
	Arbitrary (auxiliary) charge assigned to particle.

void	SetArbitraryCharge (double arbchg)
	Assigns arbitrary (auxiliary) charge to particle.

double	AbsoluteQuark () const
	Absolute light quark content \|u,d\|.

void	SetAbsoluteQuark (double abschg)
	Set absolute light quark content \|u,d\|.

double	AbsoluteStrangeness () const
	Absolute strange quark content \|s\|.

void	SetAbsoluteStrangeness (double abschg)
	Set absolute strange quark content \|s\|, light quark content then re-evaluted.

double	AbsoluteCharm () const
	Absolute charm quark content \|s\|.

void	SetAbsoluteCharm (double abschg)
	Set absolute charm quark content \|s\|, light quark content then re-evaluted.

bool	ZeroWidthEnforced () const
	Whether zero-width approximation is enforced for this particle species.

double	ResonanceWidth () const
	Particle's width at the pole mass (GeV)

void	SetResonanceWidth (double width)
	Sets the particle's width at the pole mass.

double	DecayThresholdMass () const
	The decays threshold mass.

void	SetDecayThresholdMass (double threshold)
	Set the decays threshold mass.

double	DecayThresholdMassDynamical () const

void	SetDecayThresholdMassDynamical (double threshold)
	Set the threshold mass manually for use in the eBW scheme.

void	CalculateAndSetDynamicalThreshold ()

ResonanceWidthShape	GetResonanceWidthShape () const
	Resonance width profile in use.

void	SetResonanceWidthShape (ResonanceWidthShape shape)
	Set the resonance width profile to use.

ResonanceWidthIntegration	GetResonanceWidthIntegrationType () const
	Resonance width integration scheme used to treat finite resonance widths.

void	SetResonanceWidthIntegrationType (ResonanceWidthIntegration type)
	Set the ResonanceWidthIntegration scheme used to treat finite resonance widths.

double	MassDistribution (double m) const

double	MassDistribution (double m, double width) const

double	Weight () const
	Particle's weight.

void	SetWeight (double weight)
	Set particle's weight factor.

ParticleDecayType::DecayType	DecayType () const
	Decay type of the particle.

void	SetDecayType (ParticleDecayType::DecayType type)
	Set particle's Decay Type.

const ParticleDecaysVector &	Decays () const
	A vector of particle's decays.

ParticleDecaysVector &	Decays ()
	Returns a non-const reference to Decays()

void	SetDecays (const ParticleDecaysVector &Decays)
	Set the Decays vector.

void	ClearDecays ()
	Remove all decays.

const ParticleDecaysVector &	DecaysOriginal () const
	A backup copy of particle's decays.

ParticleDecaysVector &	DecaysOriginal ()

void	SetDecaysOriginal (const ParticleDecaysVector &DecaysOrig)

void	ReadDecays (std::string filename="")
	Read decays from a file and assign them to the particle.

void	CalculateThermalBranchingRatios (const ThermalModelParameters &params, bool useWidth=0, double mu=0.)
	Computes average decay branching ratios by integrating over the thermal mass distribution.

void	SetCalculationType (IdealGasFunctions::QStatsCalculationType type)
	Sets the CalculationType() method to evaluate quantum statistics.

IdealGasFunctions::QStatsCalculationType	CalculationType () const
	Method to evaluate quantum statistics.

int	ClusterExpansionOrder () const
	Number of terms in the cluster expansion method.

void	SetClusterExpansionOrder (int order)
	Set ClusterExpansionOrder()

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.

bool	operator== (const ThermalParticle &rhs) const

bool	operator!= (const ThermalParticle &rhs) const

GeneralizedDensity *	GetGeneralizedDensity () const
	Getter/Setter for the generalized density object.

void	SetGeneralizedDensity (GeneralizedDensity *density_model)

void	ClearGeneralizedDensity ()
	Clear the generalized density.

void	SetMagneticField (double B=0.0, int lmax=1)
	Sets the value of magnetic field and the number of Landau levels to include.

void	ClearMagneticField ()
	Clears the magnetic field.

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

◆ ParticleDecaysVector

typedef std::vector<ParticleDecayChannel> thermalfist::ThermalParticle::ParticleDecaysVector

Vector of all decay channels of a particle.

Definition at line 67 of file ThermalParticle.h.

Member Enumeration Documentation

◆ ResonanceWidthIntegration

enum thermalfist::ThermalParticle::ResonanceWidthIntegration

Treatment of finite resonance widths.

Enumerator
ZeroWidth	Zero-width approximation.
BWTwoGamma	Energy-independent Breit-Wigner in +-2\Gamma 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.

◆ ResonanceWidthShape

enum thermalfist::ThermalParticle::ResonanceWidthShape

Relativistic vs non-relativistic Breit-Wigner shape.

Enumerator
RelativisticBreitWigner
NonRelativisticBreitWigner

Definition at line 73 of file ThermalParticle.h.

Constructor & Destructor Documentation

◆ ThermalParticle()

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

Stable	Particle's stability flag
Name	Particle's name
PDGID	Particle's PDG ID
Deg	Particle's internal degeneracy
Stat	Statistics: 1 – Fermi-Dirac, -1 – Bose-Einstein, 0 - Maxwell-Boltzmann
Mass	Particle's mass
Strange	Particle's strangeness
Baryon	Particle's baryon number
Charge	Particle's electric charge
AbsS	Particle's strange quark content
Width	Particle's width
Threshold	Particle's decays threshold
Charm	Particle's charm
AbsC	Particle's charm quark content
Quark	Particle's light quark content

Definition at line 26 of file ThermalParticle.cpp.

◆ ~ThermalParticle()

thermalfist::ThermalParticle::~ThermalParticle ( void )

Definition at line 55 of file ThermalParticle.cpp.

Member Function Documentation

◆ AbsoluteCharm()

double thermalfist::ThermalParticle::AbsoluteCharm ( ) const

inline

Absolute charm quark content |s|.

Definition at line 448 of file ThermalParticle.h.

◆ AbsoluteQuark()

double thermalfist::ThermalParticle::AbsoluteQuark ( ) const

inline

Absolute light quark content |u,d|.

Definition at line 436 of file ThermalParticle.h.

◆ AbsoluteStrangeness()

double thermalfist::ThermalParticle::AbsoluteStrangeness ( ) const

inline

Absolute strange quark content |s|.

Definition at line 442 of file ThermalParticle.h.

◆ ArbitraryCharge()

double thermalfist::ThermalParticle::ArbitraryCharge ( ) const

inline

Arbitrary (auxiliary) charge assigned to particle.

Returns: Arbitrary (auxiliary) charge

Definition at line 426 of file ThermalParticle.h.

◆ BaryonCharge()

int thermalfist::ThermalParticle::BaryonCharge ( ) const

inline

Particle's baryon number.

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

Definition at line 396 of file ThermalParticle.h.

◆ BranchingRatiosM()

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

(Energy-dependent) branching ratios

Parameters

M	Energy [GeV]
eBW	Whether branching ratios are energy-dependent or not

Returns: std::vector<double> A vector of branching ratios for all decay channels

Definition at line 521 of file ThermalParticle.cpp.

◆ BranchingRatioWeights()

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

Definition at line 200 of file ThermalParticle.cpp.

◆ CalculateAndSetDynamicalThreshold()

void thermalfist::ThermalParticle::CalculateAndSetDynamicalThreshold ( )

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

Definition at line 92 of file ThermalParticle.cpp.

◆ CalculateThermalBranchingRatios()

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

params	Structure containing the temperature value and the chemical factors.
useWidth	Whether finite widths are taken into account.
mu	Chemical potential.

Definition at line 163 of file ThermalParticle.cpp.

◆ CalculationType()

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 634 of file ThermalParticle.h.

◆ Charm()

int thermalfist::ThermalParticle::Charm ( ) const

inline

Particle's charm.

Definition at line 413 of file ThermalParticle.h.

◆ chi()

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

index	Order of the susceptibility.
params	Structure containing the temperature value and the chemical factors.
useWidth	Whether finite widths are taken into account.
mu	Chemical potential.

Returns: Value of the computed susceptility.

Definition at line 771 of file ThermalParticle.cpp.

◆ chiDimensionfull()

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

Computes the ideal gas dimensionfull susceptibility \( \chi_n \equiv \frac{\partial^n p}{\partial mu^n} \).

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

Parameters

index	Order of the susceptibility.
params	Structure containing the temperature value and the chemical factors.
useWidth	Whether finite widths are taken into account.
mu	Chemical potential.

Returns: Value of the computed susceptility [GeV^{4-n].

Definition at line 703 of file ThermalParticle.cpp.

◆ ClearDecays()

void thermalfist::ThermalParticle::ClearDecays ( )

inline

Remove all decays.

Definition at line 594 of file ThermalParticle.h.

◆ ClearGeneralizedDensity()

void thermalfist::ThermalParticle::ClearGeneralizedDensity ( )

Clear the generalized density.

Definition at line 780 of file ThermalParticle.cpp.

◆ ClearMagneticField()

void thermalfist::ThermalParticle::ClearMagneticField ( )

inline

Clears the magnetic field.

Definition at line 681 of file ThermalParticle.h.

◆ ClusterExpansionOrder()

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 641 of file ThermalParticle.h.

◆ ConservedCharge()

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

One of the four QCD conserved charges.

Definition at line 566 of file ThermalParticle.cpp.

◆ Decays() [1/2]

ParticleDecaysVector & thermalfist::ThermalParticle::Decays ( )

inline

Returns a non-const reference to Decays()

Definition at line 582 of file ThermalParticle.h.

◆ Decays() [2/2]

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 579 of file ThermalParticle.h.

◆ DecaysOriginal() [1/2]

ParticleDecaysVector & thermalfist::ThermalParticle::DecaysOriginal ( )

inline

Definition at line 599 of file ThermalParticle.h.

◆ DecaysOriginal() [2/2]

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

inline

A backup copy of particle's decays.

Definition at line 598 of file ThermalParticle.h.

◆ DecayThresholdMass()

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 478 of file ThermalParticle.h.

◆ DecayThresholdMassDynamical()

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 495 of file ThermalParticle.h.

◆ DecayType()

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

inline

Decay type of the particle.

Returns: Decay type of the particle.

Definition at line 566 of file ThermalParticle.h.

◆ Degeneracy()

double thermalfist::ThermalParticle::Degeneracy ( ) const

inline

Particle's internal degeneracy factor.

Definition at line 354 of file ThermalParticle.h.

◆ DeltaNch() [1/2]

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

inline

Definition at line 652 of file ThermalParticle.h.

◆ DeltaNch() [2/2]

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

inline

Definition at line 651 of file ThermalParticle.h.

◆ Density()

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

params	Structure containing the temperature value and the chemical factors.
type	The type of the thermodynamic function calculated.
useWidth	Whether finite widths are taken into account.
mu	Chemical potential.

Returns: Value of the computed thermodynamic function.

Definition at line 584 of file ThermalParticle.cpp.

◆ DensityCluster()

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

n	Number of the term.
params	Structure containing the temperature value and the chemical factors.
type	The type of the thermodynamic function calculated.
useWidth	Whether finite widths are taken into account.
mu	Chemical potential.

Returns: Value of the computed term.

Definition at line 643 of file ThermalParticle.cpp.

◆ ElectricCharge()

int thermalfist::ThermalParticle::ElectricCharge ( ) const

inline

Particle's electric charge.

Examples: cpc4-mcHRG.cpp.

Definition at line 402 of file ThermalParticle.h.

◆ FD()

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

Fermi-Dirac distribution function.

Parameters

k	Momentum [GeV]
T	Temperature [GeV]
mu	Chemical potential [GeV]
m	Mass [GeV]

Returns: Computed Fermi-Dirac function.

Definition at line 745 of file ThermalParticle.cpp.

◆ FillCoefficients()

void thermalfist::ThermalParticle::FillCoefficients ( )

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

Definition at line 322 of file ThermalParticle.cpp.

◆ FillCoefficientsDynamical()

void thermalfist::ThermalParticle::FillCoefficientsDynamical ( )

Fills coefficients for mass integration in the eBW scheme.

Definition at line 347 of file ThermalParticle.cpp.

◆ GenerateAntiParticle()

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 231 of file ThermalParticle.cpp.

◆ GetAbsCharge()

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

Get the absolute value of a quantum number.

Parameters

index 0 – 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 763 of file ThermalParticle.cpp.

◆ GetAbsQ()

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 750 of file ThermalParticle.cpp.

◆ GetCharge()

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

Get the quantum number numbered by the index.

Parameters

index 0 – baryon number, 1 – electric charge, 2 – strangeness, 3 – charm

Returns: Particle's quantum number

Definition at line 755 of file ThermalParticle.cpp.

◆ GetGeneralizedDensity()

GeneralizedDensity * thermalfist::ThermalParticle::GetGeneralizedDensity ( ) const

inline

Getter/Setter for the generalized density object.

Definition at line 669 of file ThermalParticle.h.

◆ GetResonanceWidthIntegrationType()

ResonanceWidthIntegration thermalfist::ThermalParticle::GetResonanceWidthIntegrationType ( ) const

inline

Resonance width integration scheme used to treat finite resonance widths.

Returns: ResonanceWidthIntegration

Definition at line 526 of file ThermalParticle.h.

◆ GetResonanceWidthShape()

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 511 of file ThermalParticle.h.

◆ IsAntiParticle()

bool thermalfist::ThermalParticle::IsAntiParticle ( ) const

inline

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

Definition at line 336 of file ThermalParticle.h.

◆ IsNeutral()

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 579 of file ThermalParticle.cpp.

◆ IsStable()

bool thermalfist::ThermalParticle::IsStable ( ) const

inline

Return particle stability flag.

Definition at line 330 of file ThermalParticle.h.

◆ Kurtosis()

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 (\chi_4 / \chi_2) of particle number fluctuations in the ideal gas. Takes into account chemical non-equilibrium fugacity factors and finite resonance widths.

Parameters

params	Structure containing the temperature value and the chemical factors.
useWidth	Whether finite widths are taken into account.
mu	Chemical potential.

Returns: Value of the computed normalized excess kurtosis.

Definition at line 734 of file ThermalParticle.cpp.

◆ Mass()

double thermalfist::ThermalParticle::Mass ( ) const

inline

Particle's mass [GeV].

Examples: BagModelFit.cpp.

Definition at line 390 of file ThermalParticle.h.

◆ MassDistribution() [1/2]

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

m	Mass (GeV)

Returns: Mass distribution

Definition at line 117 of file ThermalParticle.cpp.

◆ MassDistribution() [2/2]

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

Definition at line 122 of file ThermalParticle.cpp.

◆ Name()

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

inline

Particle's name.

Examples: PCE-Saha-LHC.cpp.

Definition at line 342 of file ThermalParticle.h.

◆ Nch() [1/2]

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

inline

Definition at line 649 of file ThermalParticle.h.

◆ Nch() [2/2]

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

inline

Definition at line 648 of file ThermalParticle.h.

◆ NormalizeBranchingRatios()

void thermalfist::ThermalParticle::NormalizeBranchingRatios ( )

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

Definition at line 302 of file ThermalParticle.cpp.

◆ operator!=()

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

inline

Definition at line 666 of file ThermalParticle.h.

◆ operator==()

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

Definition at line 259 of file ThermalParticle.cpp.

◆ PdgId()

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

inline

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

Definition at line 348 of file ThermalParticle.h.

◆ ReadDecays()

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

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

Definition at line 140 of file ThermalParticle.cpp.

◆ ResonanceWidth()

double thermalfist::ThermalParticle::ResonanceWidth ( ) const

inline

Particle's width at the pole mass (GeV)

Definition at line 457 of file ThermalParticle.h.

◆ RestoreBranchingRatios()

void thermalfist::ThermalParticle::RestoreBranchingRatios ( )

Restores all branching ratios to the original values.

Definition at line 313 of file ThermalParticle.cpp.

◆ ScaledVariance()

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 (\chi_2 / \chi_1) of particle number fluctuations in the ideal gas. Takes into account chemical non-equilibrium fugacity factors and finite resonance widths.

Parameters

params	Structure containing the temperature value and the chemical factors.
useWidth	Whether finite widths are taken into account.
mu	Chemical potential.

Returns: Value of the computed scaled variance.

Definition at line 713 of file ThermalParticle.cpp.

◆ SetAbsoluteCharm()

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

inline

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

Definition at line 451 of file ThermalParticle.h.

◆ SetAbsoluteQuark()

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

inline

Set absolute light quark content |u,d|.

Definition at line 439 of file ThermalParticle.h.

◆ SetAbsoluteStrangeness()

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

inline

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

Definition at line 445 of file ThermalParticle.h.

◆ SetAntiParticle()

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

inline

Set manually whether particle is an antiparticle.

Definition at line 339 of file ThermalParticle.h.

◆ SetArbitraryCharge()

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

inline

Assigns arbitrary (auxiliary) charge to particle.

Parameters

Arbitrary (auxiliary) charge

Definition at line 433 of file ThermalParticle.h.

◆ SetBaryonCharge()

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

inline

Set particle's baryon number.

Definition at line 399 of file ThermalParticle.h.

◆ SetCalculationType()

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

inline

Sets the CalculationType() method to evaluate quantum statistics.

Parameters

type	Method to evaluate quantum statistics.

Definition at line 624 of file ThermalParticle.h.

◆ SetCharm()

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

inline

Set particle's charm.

Definition at line 416 of file ThermalParticle.h.

◆ SetClusterExpansionOrder()

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

inline

Set ClusterExpansionOrder()

Definition at line 644 of file ThermalParticle.h.

◆ SetDecays()

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

inline

Set the Decays vector.

Sets all decays of the particle

Parameters

Decays ParticleDecay vector containing all particle decays

Definition at line 591 of file ThermalParticle.h.

◆ SetDecaysOriginal()

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

inline

Definition at line 600 of file ThermalParticle.h.

◆ SetDecayThresholdMass()

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

threshold Threshold mass (GeV)

Definition at line 75 of file ThermalParticle.cpp.

◆ SetDecayThresholdMassDynamical()

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

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

Definition at line 84 of file ThermalParticle.cpp.

◆ SetDecayType()

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

inline

Set particle's Decay Type.

Definition at line 569 of file ThermalParticle.h.

◆ SetDegeneracy()

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

inline

Set particle's internal degeneracy factor.

Definition at line 357 of file ThermalParticle.h.

◆ SetElectricCharge()

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

inline

Set particle's electric charge.

Definition at line 405 of file ThermalParticle.h.

◆ SetGeneralizedDensity()

void thermalfist::ThermalParticle::SetGeneralizedDensity ( GeneralizedDensity * density_model )

Definition at line 787 of file ThermalParticle.cpp.

◆ SetMagneticField()

void thermalfist::ThermalParticle::SetMagneticField	(	double	B = 0.0,
		int	lmax = 1 )

Sets the value of magnetic field and the number of Landau levels to include.

Definition at line 792 of file ThermalParticle.cpp.

◆ SetMass()

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

Set particle's mass [GeV].

Definition at line 557 of file ThermalParticle.cpp.

◆ SetName()

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

inline

Set particle's name.

Definition at line 345 of file ThermalParticle.h.

◆ SetPdgId()

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

inline

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

Definition at line 351 of file ThermalParticle.h.

◆ SetResonanceWidth()

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

width Width (GeV)

Definition at line 66 of file ThermalParticle.cpp.

◆ SetResonanceWidthIntegrationType()

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

Set the ResonanceWidthIntegration scheme used to treat finite resonance widths.

Parameters

type	ResonanceWidthIntegration scheme

Definition at line 109 of file ThermalParticle.cpp.

◆ SetResonanceWidthShape()

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

Set the resonance width profile to use.

Parameters

shape Relativistic or non-relativistic Breit-Wigner

Definition at line 101 of file ThermalParticle.cpp.

◆ SetStable()

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

inline

Sets particle stability flag.

Definition at line 333 of file ThermalParticle.h.

◆ SetStatistics()

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

inline

Set particle's statistics.

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

Parameters

stat	Statistics

Definition at line 379 of file ThermalParticle.h.

◆ SetStrangenessCharge()

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

inline

Set particle's strangeness.

Definition at line 410 of file ThermalParticle.h.

◆ SetWeight()

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

inline

Set particle's weight factor.

Definition at line 559 of file ThermalParticle.h.

◆ Skewness()

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 (\chi_3 / \chi_2) of particle number fluctuations in the ideal gas. Takes into account chemical non-equilibrium fugacity factors and finite resonance widths.

Parameters

params	Structure containing the temperature value and the chemical factors.
useWidth	Whether finite widths are taken into account.
mu	Chemical potential.

Returns: Value of the computed normalized skewness.

Definition at line 723 of file ThermalParticle.cpp.

◆ Statistics()

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 368 of file ThermalParticle.h.

◆ Strangeness()

int thermalfist::ThermalParticle::Strangeness ( ) const

inline

Particle's strangeness.

Examples: cpc4-mcHRG.cpp.

Definition at line 408 of file ThermalParticle.h.

◆ ThermalMassDistribution() [1/2]

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

M	Mass [GeV]
T	Temperature [GeV]
Mu	Chemical potential [GeV]

Returns: Mass distribution function (not normalized!)

Definition at line 547 of file ThermalParticle.cpp.

◆ ThermalMassDistribution() [2/2]

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

M	Mass [GeV]
T	Temperature [GeV]
Mu	Chemical potential [GeV]
width	Resonance width [GeV]

Returns: Mass distribution function

Definition at line 542 of file ThermalParticle.cpp.

◆ TotalWidtheBW()

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

Total width (eBW scheme) at a given mass.

Definition at line 497 of file ThermalParticle.cpp.

◆ UseStatistics()

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

Use quantum statistics.

Parameters

enable true – use quantum statistics false – use Maxwell-Boltzmann statistics

Definition at line 552 of file ThermalParticle.cpp.

◆ Weight()

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 556 of file ThermalParticle.h.

◆ ZeroWidthEnforced()

bool thermalfist::ThermalParticle::ZeroWidthEnforced ( ) const

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

Definition at line 59 of file ThermalParticle.cpp.

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

include/HRGBase/ThermalParticle.h
src/library/HRGBase/ThermalParticle.cpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ParticleDecaysVector

Member Enumeration Documentation

◆ ResonanceWidthIntegration

◆ ResonanceWidthShape

Constructor & Destructor Documentation

◆ ThermalParticle()

◆ ~ThermalParticle()

Member Function Documentation

◆ AbsoluteCharm()

◆ AbsoluteQuark()

◆ AbsoluteStrangeness()

◆ ArbitraryCharge()

◆ BaryonCharge()

◆ BranchingRatiosM()

◆ BranchingRatioWeights()

◆ CalculateAndSetDynamicalThreshold()

◆ CalculateThermalBranchingRatios()

◆ CalculationType()

◆ Charm()

◆ chi()

◆ chiDimensionfull()

◆ ClearDecays()

◆ ClearGeneralizedDensity()

◆ ClearMagneticField()

◆ ClusterExpansionOrder()

◆ ConservedCharge()

◆ Decays() [1/2]

◆ Decays() [2/2]

◆ DecaysOriginal() [1/2]

◆ DecaysOriginal() [2/2]

◆ DecayThresholdMass()

◆ DecayThresholdMassDynamical()

◆ DecayType()

◆ Degeneracy()

◆ DeltaNch() [1/2]

◆ DeltaNch() [2/2]

◆ Density()

◆ DensityCluster()

◆ ElectricCharge()

◆ FD()

◆ FillCoefficients()

◆ FillCoefficientsDynamical()

◆ GenerateAntiParticle()

◆ GetAbsCharge()

◆ GetAbsQ()

◆ GetCharge()

◆ GetGeneralizedDensity()

◆ GetResonanceWidthIntegrationType()

◆ GetResonanceWidthShape()

◆ IsAntiParticle()

◆ IsNeutral()

◆ IsStable()

◆ Kurtosis()

◆ Mass()

◆ MassDistribution() [1/2]

◆ MassDistribution() [2/2]

◆ Name()

◆ Nch() [1/2]

◆ Nch() [2/2]

◆ NormalizeBranchingRatios()

◆ operator!=()

◆ operator==()

◆ PdgId()

◆ ReadDecays()

◆ ResonanceWidth()

◆ RestoreBranchingRatios()

◆ ScaledVariance()

◆ SetAbsoluteCharm()

◆ SetAbsoluteQuark()

◆ SetAbsoluteStrangeness()

◆ SetAntiParticle()

◆ SetArbitraryCharge()

◆ SetBaryonCharge()

◆ SetCalculationType()

◆ SetCharm()

◆ SetClusterExpansionOrder()