Class implementing HRG in partial chemical equilibrium. More...

#include <ThermalModelPCE.h>

Inheritance diagram for thermalfist::ThermalModelPCE:

Classes
class	BroydenEquationsPCE
	Class for calculation of the right-hand side of the PCE equations. More...

Public Types
enum	PCEMode { AtFixedTemperature = 0 , AtFixedVolume = 1 }
	Whether partial chemical equilibrium should be calculated at a fixed value of the temperature or a fixed value of the volume. More...

Public Member Functions
	ThermalModelPCE (ThermalModelBase *THMbase, bool FreezeLonglived=false, double LonglivedResoWidthCut=0.015)
	Construct a new ThermalModelPCE object.

virtual	~ThermalModelPCE (void)
	Destroy the ThermalModelPCE object.

void	UseSahaForNuclei (bool flag)
	Whether the nuclear abundances are evaluated through the Saha equation.

bool	UseSahaForNuclei () const

void	FreezeLonglivedResonances (bool flag)
	Whether long-lived resonances yields should be frozen.

bool	FreezeLonglivedResonances () const

void	SetLonglivedResonanceWidthCut (double width_cut)
	The threshold resonance width value to consider the resonance long-lived and its abundance frozen in the hadronic phase.

double	LonglivedResonanceWidthCut () const

virtual void	SetStabilityFlags (const std::vector< int > &StabilityFlags)
	Manually set the PCE stability flags for all species.

const std::vector< int > &	StabilityFlags () const

void	SetChemicalFreezeout (const ThermalModelParameters &params, const std::vector< double > &ChemInit=std::vector< double >(0))
	Sets the chemical freeze-out conditions to be used as an initial condition for PCE calculations.

void	SetEntropyDensityChem (double sinit)
	Sets the entropy density at the chemical freeze-out.

double	EntropyDensityChem () const

ThermalModelBase *	ThermalModel () const
	Pointer to the HRG model used in calculations.

virtual void	CalculatePCE (double param, PCEMode mode=AtFixedTemperature)
	Solves the equations of partial chemical equilibrium at a fixed temperature or a fixed volume.

const std::vector< double > &	ChemicalPotentials () const

std::vector< double > &	ChemicalPotentials ()

double	Volume () const

void	ApplyFixForBoseCondensation ()
	Modifies the decay threshold masses of bosonic resonances such that the Bose-Condesation does not occur due to large fugacities.

const std::vector< std::vector< double > > &	EffectiveCharges () const

const std::vector< int > &	StableMapTo () const

Static Public Member Functions
static void	PrepareNucleiForPCE (ThermalParticleSystem *TPS)
	Fills the "decay" products of light nuclei in accordance with their baryon content.

static std::vector< int >	ComputePCEStabilityFlags (const ThermalParticleSystem *TPS, bool SahaEquationForNuclei=true, bool FreezeLongLived=false, double WidthCut=0.015)
	Computes the PCE stability flags based on the provided particle list and a number of parameters.

Protected Attributes
ThermalModelBase *	m_model

bool	m_UseSahaForNuclei
	Whether nuclear abundances are calculated via the Saha equation.

bool	m_FreezeLonglivedResonances
	Whether long-lived resonances are frozen at Tch.

double	m_ResoWidthCut
	Resonance width cut for freezeing the resonance abundances.

bool	m_ChemicalFreezeoutSet
	Whether the chemical freeze-out "initial" condition has been set.

bool	m_IsCalculated
	Whether PCE has been calculated.

bool	m_StabilityFlagsSet
	PCE configuration, list of stable species etc.

std::vector< int >	m_StabilityFlags

int	m_StableComponentsNumber

std::vector< std::vector< double > >	m_EffectiveCharges

std::vector< int >	m_StableMapTo

ThermalModelParameters	m_ParametersInit
	Parameters at the chemical freeze-out.

std::vector< double >	m_ChemInit

std::vector< double >	m_DensitiesInit

std::vector< double >	m_StableDensitiesInit

double	m_EntropyDensityInit

double	m_ParticleDensityInit

ThermalModelParameters	m_ParametersCurrent
	The current PCE thermal paratmeres and chemical potentials.

std::vector< double >	m_ChemCurrent

Detailed Description

Class implementing HRG in partial chemical equilibrium.

Partial chemical equilibrium (PCE) describes the hadronic phase dynamics.

The basic ideas about PCE can be found in H. Bebie, P. Gerber, J.L. Goity, H. Leutwyler, Nucl. Phys. B 378, 95 (1992)

The present implementation was used (and described) in a paper V. Vovchenko, K. Gallmeister, J. Schaffner-Bielich, C. Greiner, Phys. Lett. B 800, 135131 (2020), arXiv:1903.10024

A typical usage pattern is the following:

Create a ThermalModelBase() instance implementing a particular grand-canonical HRG model.
Create a ThermalModelPCE() instance using the ThermalModelBase() instance from the first step. Configure PCE options like which hadrons should be considered stable and whether the Saha equation should be used for light nuclei.
Set the chemical freeze-out conditions via SetChemicalFreezeout()
Evaluate the PCE conditions at a given temperature or volume in the hadronic phase via CalculatePCE()
Use the pointer ThermalModel() to the HRG model to access the various physical properties at the given PCE point, like various hadron yields, chemical potentials, or the equation of state.

Examples: PCE-Saha-LHC.cpp.

Definition at line 36 of file ThermalModelPCE.h.

Member Enumeration Documentation

◆ PCEMode

enum thermalfist::ThermalModelPCE::PCEMode

Whether partial chemical equilibrium should be calculated at a fixed value of the temperature or a fixed value of the volume.

Used in CalculatePCE()

Enumerator
AtFixedTemperature	Partial chemical equilibrium at fixed value of the temperature.
AtFixedVolume	Partial chemical equilibrium at fixed value of the volume.

Definition at line 46 of file ThermalModelPCE.h.

Constructor & Destructor Documentation

◆ ThermalModelPCE()

thermalfist::ThermalModelPCE::ThermalModelPCE	(	ThermalModelBase *	THMbase,
		bool	FreezeLonglived = false,
		double	LonglivedResoWidthCut = 0.015 )

Construct a new ThermalModelPCE object.

Parameters

THMbase	A pointer to the ThermalModelBase object containing the HRG model implementation
FreezeLonglived	Whether long-lived resonance abundances should be frozen at Tch along with the stable hadrons
LonglivedResoWidthCut	Threshold width for the long-lived resonances to be considered stable in the PCE

Definition at line 17 of file ThermalModelPCE.cpp.

◆ ~ThermalModelPCE()

virtual thermalfist::ThermalModelPCE::~ThermalModelPCE ( void )

inlinevirtual

Destroy the ThermalModelPCE object.

Definition at line 67 of file ThermalModelPCE.h.

Member Function Documentation

◆ ApplyFixForBoseCondensation()

void thermalfist::ThermalModelPCE::ApplyFixForBoseCondensation ( )

Modifies the decay threshold masses of bosonic resonances such that the Bose-Condesation does not occur due to large fugacities.

  This is only necessary if energy-dependent Breit-Wigner widths are used.

Definition at line 332 of file ThermalModelPCE.cpp.

◆ CalculatePCE()

void thermalfist::ThermalModelPCE::CalculatePCE	(	double	param,
		PCEMode	mode = AtFixedTemperature )

virtual

Solves the equations of partial chemical equilibrium at a fixed temperature or a fixed volume.

Parameters

param	Temperature (in GeV) if `mode` correspond to PCE at fixed temperature, Volume (in fm^3) if `mode` correspond to PCE at fixed volume.
mode	Determines whether the PCE calculation is perfored at a fixed temperature (default) or at a fixed volume.

Reimplemented in thermalfist::ThermalModelPCEAnnihilation.

Examples: PCE-Saha-LHC.cpp.

Definition at line 118 of file ThermalModelPCE.cpp.

◆ ChemicalPotentials() [1/2]

std::vector< double > & thermalfist::ThermalModelPCE::ChemicalPotentials ( )

inline

Definition at line 158 of file ThermalModelPCE.h.

◆ ChemicalPotentials() [2/2]

const std::vector< double > & thermalfist::ThermalModelPCE::ChemicalPotentials ( ) const

inline

Returns: Vector of chemical potentials of all particles species, as resulted from the last CalculatePCE() call

Examples: PCE-Saha-LHC.cpp.

Definition at line 157 of file ThermalModelPCE.h.

◆ ComputePCEStabilityFlags()

vector< int > thermalfist::ThermalModelPCE::ComputePCEStabilityFlags	(	const ThermalParticleSystem *	TPS,
		bool	SahaEquationForNuclei = true,
		bool	FreezeLongLived = false,
		double	WidthCut = 0.015 )

static

Computes the PCE stability flags based on the provided particle list and a number of parameters.

Parameters

TPS	Pointer to the particle list
SahaEquationForNuclei	Whether the Saha equation is applied to light nuclei
FreezeLongLived	Whether long-lived resonance yields are frozen at the chemical freeze-out
WidthCut	The threshold resonance width value to consider the resonance long-lived and its abundance frozen [GeV]

Definition at line 302 of file ThermalModelPCE.cpp.

◆ EffectiveCharges()

const std::vector< std::vector< double > > & thermalfist::ThermalModelPCE::EffectiveCharges ( ) const

inline

Definition at line 193 of file ThermalModelPCE.h.

◆ EntropyDensityChem()

double thermalfist::ThermalModelPCE::EntropyDensityChem ( ) const

inline

Definition at line 136 of file ThermalModelPCE.h.

◆ FreezeLonglivedResonances() [1/2]

bool thermalfist::ThermalModelPCE::FreezeLonglivedResonances ( ) const

inline

Definition at line 91 of file ThermalModelPCE.h.

◆ FreezeLonglivedResonances() [2/2]

void thermalfist::ThermalModelPCE::FreezeLonglivedResonances ( bool flag )

inline

Whether long-lived resonances yields should be frozen.

If set, the long-lived resonance with width smaller than LonglivedResonanceWidthCut() are frozen at the chemical freeze-out of stable hadrons. Otherwise, their abundances are evaluated through the chemical potentials of their decay products.

Parameters

flag	Whether long-lived resonances yields should be frozen.

Examples: PCE-Saha-LHC.cpp.

Definition at line 90 of file ThermalModelPCE.h.

◆ LonglivedResonanceWidthCut()

double thermalfist::ThermalModelPCE::LonglivedResonanceWidthCut ( ) const

inline

Definition at line 103 of file ThermalModelPCE.h.

◆ PrepareNucleiForPCE()

void thermalfist::ThermalModelPCE::PrepareNucleiForPCE ( ThermalParticleSystem * TPS )

static

Fills the "decay" products of light nuclei in accordance with their baryon content.

Parameters

TPS	Pointer to the particle list

Definition at line 179 of file ThermalModelPCE.cpp.

◆ SetChemicalFreezeout()

void thermalfist::ThermalModelPCE::SetChemicalFreezeout	(	const ThermalModelParameters &	params,
		const std::vector< double > &	ChemInit = std::vector<double>(0) )

Sets the chemical freeze-out conditions to be used as an initial condition for PCE calculations.

Parameters

params	Thermal parameters at the chemical freeze-out.
ChemInit	Chemical potentials of all species at the chemical freeze-out. If this vector is empty (default value), the chemical potentials are populated using `params`

Examples: PCE-Saha-LHC.cpp.

Definition at line 74 of file ThermalModelPCE.cpp.

◆ SetEntropyDensityChem()

void thermalfist::ThermalModelPCE::SetEntropyDensityChem ( double sinit )

inline

Sets the entropy density at the chemical freeze-out.

Parameters

sinit Entropy density at the chemical freeze-out.

Definition at line 135 of file ThermalModelPCE.h.

◆ SetLonglivedResonanceWidthCut()

void thermalfist::ThermalModelPCE::SetLonglivedResonanceWidthCut ( double width_cut )

inline

The threshold resonance width value to consider the resonance long-lived and its abundance frozen in the hadronic phase.

Note: This function sets FreezeLonglivedResonances() to true.

Parameters

width_cut The threshold resonance width [GeV].

Definition at line 102 of file ThermalModelPCE.h.

◆ SetStabilityFlags()

void thermalfist::ThermalModelPCE::SetStabilityFlags ( const std::vector< int > & StabilityFlags )

virtual

Manually set the PCE stability flags for all species.

Parameters

StabilityFlags Vector of stability flags. Each element corresponds to a particle specie with the same 0-based index in the particle list. Element i equal to zero means particle yield is not frozen in the hadronic phase, otherwise it is frozen.

Reimplemented in thermalfist::ThermalModelPCEAnnihilation.

Definition at line 29 of file ThermalModelPCE.cpp.

◆ StabilityFlags()

const std::vector< int > & thermalfist::ThermalModelPCE::StabilityFlags ( ) const

inline

Definition at line 115 of file ThermalModelPCE.h.

◆ StableMapTo()

const std::vector< int > & thermalfist::ThermalModelPCE::StableMapTo ( ) const

inline

Definition at line 194 of file ThermalModelPCE.h.

◆ ThermalModel()

ThermalModelBase * thermalfist::ThermalModelPCE::ThermalModel ( ) const

inline

Pointer to the HRG model used in calculations.

Examples: PCE-Saha-LHC.cpp.

Definition at line 142 of file ThermalModelPCE.h.

◆ UseSahaForNuclei() [1/2]

bool thermalfist::ThermalModelPCE::UseSahaForNuclei ( ) const

inline

Definition at line 78 of file ThermalModelPCE.h.

◆ UseSahaForNuclei() [2/2]

void thermalfist::ThermalModelPCE::UseSahaForNuclei ( bool flag )

inline

Whether the nuclear abundances are evaluated through the Saha equation.

If not set, the nuclear abundances are frozed at the chemical freeze-out of stable hadrons.

Parameters

flag	Flag whether the Saha equation is used.

Examples: PCE-Saha-LHC.cpp.

Definition at line 77 of file ThermalModelPCE.h.

◆ Volume()

double thermalfist::ThermalModelPCE::Volume ( ) const

inline

Returns: The system volume, as resulted from the last CalculatePCE() call

Definition at line 163 of file ThermalModelPCE.h.

Member Data Documentation

◆ m_ChemCurrent

std::vector<double> thermalfist::ThermalModelPCE::m_ChemCurrent

protected

Definition at line 231 of file ThermalModelPCE.h.

◆ m_ChemicalFreezeoutSet

bool thermalfist::ThermalModelPCE::m_ChemicalFreezeoutSet

protected

Whether the chemical freeze-out "initial" condition has been set.

Definition at line 209 of file ThermalModelPCE.h.

◆ m_ChemInit

std::vector<double> thermalfist::ThermalModelPCE::m_ChemInit

protected

Definition at line 223 of file ThermalModelPCE.h.

◆ m_DensitiesInit

std::vector<double> thermalfist::ThermalModelPCE::m_DensitiesInit

protected

Definition at line 224 of file ThermalModelPCE.h.

◆ m_EffectiveCharges

std::vector< std::vector<double> > thermalfist::ThermalModelPCE::m_EffectiveCharges

protected

Definition at line 218 of file ThermalModelPCE.h.

◆ m_EntropyDensityInit

double thermalfist::ThermalModelPCE::m_EntropyDensityInit

protected

Definition at line 226 of file ThermalModelPCE.h.

◆ m_FreezeLonglivedResonances

bool thermalfist::ThermalModelPCE::m_FreezeLonglivedResonances

protected

Whether long-lived resonances are frozen at Tch.

Definition at line 204 of file ThermalModelPCE.h.

◆ m_IsCalculated

bool thermalfist::ThermalModelPCE::m_IsCalculated

protected

Whether PCE has been calculated.

Definition at line 212 of file ThermalModelPCE.h.

◆ m_model

ThermalModelBase* thermalfist::ThermalModelPCE::m_model

protected

Definition at line 198 of file ThermalModelPCE.h.

◆ m_ParametersCurrent

ThermalModelParameters thermalfist::ThermalModelPCE::m_ParametersCurrent

protected

The current PCE thermal paratmeres and chemical potentials.

Definition at line 230 of file ThermalModelPCE.h.

◆ m_ParametersInit

ThermalModelParameters thermalfist::ThermalModelPCE::m_ParametersInit

protected

Parameters at the chemical freeze-out.

Definition at line 222 of file ThermalModelPCE.h.

◆ m_ParticleDensityInit

double thermalfist::ThermalModelPCE::m_ParticleDensityInit

protected

Definition at line 227 of file ThermalModelPCE.h.

◆ m_ResoWidthCut

double thermalfist::ThermalModelPCE::m_ResoWidthCut

protected

Resonance width cut for freezeing the resonance abundances.

Definition at line 206 of file ThermalModelPCE.h.

◆ m_StabilityFlags

std::vector<int> thermalfist::ThermalModelPCE::m_StabilityFlags

protected

Definition at line 216 of file ThermalModelPCE.h.

◆ m_StabilityFlagsSet

bool thermalfist::ThermalModelPCE::m_StabilityFlagsSet

protected

PCE configuration, list of stable species etc.

Definition at line 215 of file ThermalModelPCE.h.

◆ m_StableComponentsNumber

int thermalfist::ThermalModelPCE::m_StableComponentsNumber

protected

Definition at line 217 of file ThermalModelPCE.h.

◆ m_StableDensitiesInit

std::vector<double> thermalfist::ThermalModelPCE::m_StableDensitiesInit

protected

Definition at line 225 of file ThermalModelPCE.h.

◆ m_StableMapTo

std::vector<int> thermalfist::ThermalModelPCE::m_StableMapTo

protected

Definition at line 219 of file ThermalModelPCE.h.

◆ m_UseSahaForNuclei

bool thermalfist::ThermalModelPCE::m_UseSahaForNuclei

protected

Whether nuclear abundances are calculated via the Saha equation.

Definition at line 201 of file ThermalModelPCE.h.

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

include/HRGPCE/ThermalModelPCE.h
src/library/HRGPCE/ThermalModelPCE.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ PCEMode

Constructor & Destructor Documentation

◆ ThermalModelPCE()

◆ ~ThermalModelPCE()

Member Function Documentation

◆ ApplyFixForBoseCondensation()

◆ CalculatePCE()

◆ ChemicalPotentials() [1/2]

◆ ChemicalPotentials() [2/2]

◆ ComputePCEStabilityFlags()

◆ EffectiveCharges()

◆ EntropyDensityChem()

◆ FreezeLonglivedResonances() [1/2]

◆ FreezeLonglivedResonances() [2/2]

◆ LonglivedResonanceWidthCut()

◆ PrepareNucleiForPCE()

◆ SetChemicalFreezeout()

◆ SetEntropyDensityChem()

◆ SetLonglivedResonanceWidthCut()

◆ SetStabilityFlags()

◆ StabilityFlags()

◆ StableMapTo()

◆ ThermalModel()

◆ UseSahaForNuclei() [1/2]

◆ UseSahaForNuclei() [2/2]

◆ Volume()

Member Data Documentation

◆ m_ChemCurrent

◆ m_ChemicalFreezeoutSet

◆ m_ChemInit

◆ m_DensitiesInit

◆ m_EffectiveCharges

◆ m_EntropyDensityInit

◆ m_FreezeLonglivedResonances

◆ m_IsCalculated

◆ m_model

◆ m_ParametersCurrent

◆ m_ParametersInit

◆ m_ParticleDensityInit

◆ m_ResoWidthCut

◆ m_StabilityFlags

◆ m_StabilityFlagsSet

◆ m_StableComponentsNumber

◆ m_StableDensitiesInit

◆ m_StableMapTo

◆ m_UseSahaForNuclei