Version: SMASH-2.0
forwarddeclarations.h File Reference

Go to the source code of this file.

Typedefs

typedef std::bitset< 10 > ReactionsBitSet
 Container for the 2 to 2 reactions in the code. More...
 
typedef std::bitset< 2 > MultiParticleReactionsBitSet
 Container for the 2 to 2 reactions in the code. More...
 

Enumerations

enum  CalculationFrame { CalculationFrame::CenterOfVelocity, CalculationFrame::CenterOfMass, CalculationFrame::FixedTarget }
 The calculation frame. More...
 
enum  FermiMotion { FermiMotion::Off, FermiMotion::On, FermiMotion::Frozen }
 Option to use Fermi Motion. More...
 
enum  Sampling { Sampling::Uniform, Sampling::Quadratic, Sampling::Custom }
 Possible methods of impact parameter sampling. More...
 
enum  TimeStepMode : char { TimeStepMode::None, TimeStepMode::Fixed }
 The time step mode. More...
 
enum  BoxInitialCondition { BoxInitialCondition::ThermalMomentaBoltzmann, BoxInitialCondition::ThermalMomentaQuantum, BoxInitialCondition::PeakedMomenta }
 Initial condition for a particle in a box. More...
 
enum  SphereInitialCondition {
  SphereInitialCondition::ThermalMomentaBoltzmann, SphereInitialCondition::ThermalMomentaQuantum, SphereInitialCondition::IC_ES, SphereInitialCondition::IC_1M,
  SphereInitialCondition::IC_2M, SphereInitialCondition::IC_Massive
}
 Initial condition for a particle in a sphere. More...
 
enum  ExpansionMode { ExpansionMode::NoExpansion, ExpansionMode::MasslessFRW, ExpansionMode::MassiveFRW, ExpansionMode::Exponential }
 Defines properties of expansion for the metric (e.g. More...
 
enum  NNbarTreatment { NNbarTreatment::NoAnnihilation, NNbarTreatment::Resonances, NNbarTreatment::Strings }
 Treatment of N Nbar Annihilation. More...
 
enum  ThermodynamicQuantity : char {
  ThermodynamicQuantity::EckartDensity, ThermodynamicQuantity::Tmn, ThermodynamicQuantity::TmnLandau, ThermodynamicQuantity::LandauVelocity,
  ThermodynamicQuantity::j_QBS
}
 Represents thermodynamic quantities that can be printed out. More...
 
enum  CollisionCriterion { CollisionCriterion::Geometric, CollisionCriterion::Stochastic, CollisionCriterion::Covariant }
 Criteria used to check collisions. More...
 
enum  OutputOnlyFinal { OutputOnlyFinal::Yes, OutputOnlyFinal::No, OutputOnlyFinal::IfNotEmpty }
 Whether and when only final state particles should be printed. More...
 
enum  IncludedReactions {
  All = 50, Elastic = 0, NN_to_NR = 1, NN_to_DR = 2,
  KN_to_KN = 3, KN_to_KDelta = 4, Strangeness_exchange = 5, NNbar = 6,
  PiDeuteron_to_NN = 7, PiDeuteron_to_pidprime = 8, NDeuteron_to_Ndprime = 9
}
 The different groups of 2 to 2 reactions that one can include. More...
 
enum  IncludedMultiParticleReactions { Meson_3to1 = 0, Deuteron_3to2 = 1 }
 The different groups of multi-particle reactions that one can include. More...
 
enum  ThermalizationAlgorithm { ThermalizationAlgorithm::ModeSampling, ThermalizationAlgorithm::BiasedBF, ThermalizationAlgorithm::UnbiasedBF }
 Defines the algorithm used for the forced thermalization. More...
 

Typedef Documentation

◆ ReactionsBitSet

typedef std::bitset<10> ReactionsBitSet

Container for the 2 to 2 reactions in the code.

Definition at line 231 of file forwarddeclarations.h.

◆ MultiParticleReactionsBitSet

typedef std::bitset<2> MultiParticleReactionsBitSet

Container for the 2 to 2 reactions in the code.

Definition at line 240 of file forwarddeclarations.h.

Enumeration Type Documentation

◆ CalculationFrame

enum CalculationFrame
strong

The calculation frame.

Enumerator
CenterOfVelocity 
CenterOfMass 
FixedTarget 

Definition at line 87 of file forwarddeclarations.h.

87  {
91 };

◆ FermiMotion

enum FermiMotion
strong

Option to use Fermi Motion.

Enumerator
Off 

Don't use fermi motion.

On 

Use fermi motion in combination with potentials.

Frozen 

Use fermi motion without potentials.

Definition at line 94 of file forwarddeclarations.h.

94  {
96  Off,
98  On,
100  Frozen,
101 };

◆ Sampling

enum Sampling
strong

Possible methods of impact parameter sampling.

Enumerator
Uniform 

Sample from uniform distribution.

Quadratic 

Sample from areal / quadratic distribution.

Custom 

Sample from custom, user-defined distribution.

Definition at line 104 of file forwarddeclarations.h.

104  {
106  Uniform,
108  Quadratic,
110  Custom,
111 };

◆ TimeStepMode

enum TimeStepMode : char
strong

The time step mode.

Enumerator
None 

Don't use time steps; propagate from action to action.

Fixed 

Use fixed time step.

Definition at line 114 of file forwarddeclarations.h.

114  : char {
116  None,
118  Fixed,
119 };

◆ BoxInitialCondition

enum BoxInitialCondition
strong

Initial condition for a particle in a box.

If PeakedMomenta is used, all particles have the same momentum \(p = 3 \cdot T\) with T being the temperature.

Else, a thermalized ensemble is generated (the momenta are sampled from a Maxwell-Boltzmann distribution).

In either case, the positions in space are chosen randomly.

Enumerator
ThermalMomentaBoltzmann 
ThermalMomentaQuantum 
PeakedMomenta 

Definition at line 132 of file forwarddeclarations.h.

132  {
136 };

◆ SphereInitialCondition

Initial condition for a particle in a sphere.

IC_ES, IC_1M and IC_2M are off-equilibrium distributions used in massless comparisons of SMASH to the extended universe metric. They are described in some detail in iref Bazow:2016oky [6]

IC_Massive is a generalization of IC_ES for the non-zero mass case; note that there is currently no analytical comparison possible with this distribution.

The default value, ThermalMomenta, samples momenta from a Maxwell-Boltzmann distribution and thus generates a thermal ensemble.

Enumerator
ThermalMomentaBoltzmann 
ThermalMomentaQuantum 
IC_ES 
IC_1M 
IC_2M 
IC_Massive 

Definition at line 151 of file forwarddeclarations.h.

151  {
154  IC_ES,
155  IC_1M,
156  IC_2M,
157  IC_Massive,
158 };

◆ ExpansionMode

enum ExpansionMode
strong

Defines properties of expansion for the metric (e.g.

FRW)

If anything else than NoExpansion is used, then a non-zero Hubble parameter is computed and corrections are brought to the propagation of all particles according to selected expanding metric.

Enumerator
NoExpansion 
MasslessFRW 
MassiveFRW 
Exponential 

Definition at line 168 of file forwarddeclarations.h.

168  {
169  NoExpansion,
170  MasslessFRW,
171  MassiveFRW,
172  Exponential,
173 };

◆ NNbarTreatment

enum NNbarTreatment
strong

Treatment of N Nbar Annihilation.

Enumerator
NoAnnihilation 

No Annihilation.

Resonances 

Use intermediate Resonances.

Strings 

Use string fragmentation.

Definition at line 176 of file forwarddeclarations.h.

176  {
180  Resonances,
182  Strings,
183 };

◆ ThermodynamicQuantity

enum ThermodynamicQuantity : char
strong

Represents thermodynamic quantities that can be printed out.

Enumerator
EckartDensity 
Tmn 
TmnLandau 
LandauVelocity 
j_QBS 

Definition at line 186 of file forwarddeclarations.h.

186  : char {
188  Tmn,
189  TmnLandau,
191  j_QBS
192 };

◆ CollisionCriterion

enum CollisionCriterion
strong

Criteria used to check collisions.

Enumerator
Geometric 

(Default) geometric criterion.

Stochastic 

Stochastic Criteiron.

Covariant 

Covariant Criterion.

Definition at line 195 of file forwarddeclarations.h.

195  {
197  Geometric,
199  Stochastic,
201  Covariant
202 };

◆ OutputOnlyFinal

enum OutputOnlyFinal
strong

Whether and when only final state particles should be printed.

Enumerator
Yes 

Print only final-state particles.

No 

Print initial, intermediate and final-state particles.

IfNotEmpty 

Print only final-state particles, and those only if the event is not empty.

Definition at line 205 of file forwarddeclarations.h.

205  {
207  Yes,
209  No,
212  IfNotEmpty,
213 };

◆ IncludedReactions

The different groups of 2 to 2 reactions that one can include.

Enumerator
All 
Elastic 
NN_to_NR 
NN_to_DR 
KN_to_KN 
KN_to_KDelta 
Strangeness_exchange 
NNbar 
PiDeuteron_to_NN 
PiDeuteron_to_pidprime 
NDeuteron_to_Ndprime 

Definition at line 216 of file forwarddeclarations.h.

216  {
217  All = 50,
218  Elastic = 0,
219  NN_to_NR = 1,
220  NN_to_DR = 2,
221  KN_to_KN = 3,
222  KN_to_KDelta = 4,
224  NNbar = 6,
225  PiDeuteron_to_NN = 7,
228 };

◆ IncludedMultiParticleReactions

The different groups of multi-particle reactions that one can include.

Enumerator
Meson_3to1 
Deuteron_3to2 

Definition at line 234 of file forwarddeclarations.h.

234  {
235  Meson_3to1 = 0,
236  Deuteron_3to2 = 1,
237 };

◆ ThermalizationAlgorithm

Defines the algorithm used for the forced thermalization.

For the description of algorithms see Oliinychenko:2016vkg [36]. All of them intend to conserve the net baryon number, strangeness and electric charge, as well as energy. Mode sampling is the fastest, but least theoretically robust, unbiased BF is the slowest (even hangs completely from time to time), but it is also the most theoretically robust.

Enumerator
ModeSampling 
BiasedBF 
UnbiasedBF 

Definition at line 251 of file forwarddeclarations.h.

251  {
252  ModeSampling,
253  BiasedBF,
254  UnbiasedBF,
255 };
SphereInitialCondition::IC_Massive
NN_to_DR
Definition: forwarddeclarations.h:220
ThermodynamicQuantity::TmnLandau
Sampling::Quadratic
Sample from areal / quadratic distribution.
CalculationFrame::CenterOfVelocity
ThermodynamicQuantity::LandauVelocity
SphereInitialCondition::IC_2M
NNbar
Definition: forwarddeclarations.h:224
ExpansionMode::NoExpansion
PiDeuteron_to_NN
Definition: forwarddeclarations.h:225
ExpansionMode::Exponential
NNbarTreatment::Strings
Use string fragmentation.
FermiMotion::Off
Don't use fermi motion.
Strangeness_exchange
Definition: forwarddeclarations.h:223
Elastic
Definition: forwarddeclarations.h:218
FermiMotion::Frozen
Use fermi motion without potentials.
Sampling::Custom
Sample from custom, user-defined distribution.
ThermalizationAlgorithm::UnbiasedBF
Deuteron_3to2
Definition: forwarddeclarations.h:236
OutputOnlyFinal::IfNotEmpty
Print only final-state particles, and those only if the event is not empty.
OutputOnlyFinal::No
Print initial, intermediate and final-state particles.
CollisionCriterion::Stochastic
Stochastic Criteiron.
CollisionCriterion::Covariant
Covariant Criterion.
ThermodynamicQuantity::Tmn
SphereInitialCondition::IC_1M
ExpansionMode::MassiveFRW
All
Definition: forwarddeclarations.h:217
BoxInitialCondition::ThermalMomentaQuantum
ExpansionMode::MasslessFRW
NDeuteron_to_Ndprime
Definition: forwarddeclarations.h:227
OutputOnlyFinal::Yes
Print only final-state particles.
CalculationFrame::FixedTarget
ThermodynamicQuantity::EckartDensity
ThermalizationAlgorithm::ModeSampling
SphereInitialCondition::IC_ES
BoxInitialCondition::ThermalMomentaBoltzmann
KN_to_KN
Definition: forwarddeclarations.h:221
KN_to_KDelta
Definition: forwarddeclarations.h:222
ThermalizationAlgorithm::BiasedBF
NNbarTreatment::Resonances
Use intermediate Resonances.
Sampling::Uniform
Sample from uniform distribution.
FermiMotion::On
Use fermi motion in combination with potentials.
BoxInitialCondition::PeakedMomenta
smash::DensityType::None
NN_to_NR
Definition: forwarddeclarations.h:219
ThermodynamicQuantity::j_QBS
NNbarTreatment::NoAnnihilation
No Annihilation.
CalculationFrame::CenterOfMass
PiDeuteron_to_pidprime
Definition: forwarddeclarations.h:226
CollisionCriterion::Geometric
(Default) geometric criterion.
TimeStepMode::Fixed
Use fixed time step.
Meson_3to1
Definition: forwarddeclarations.h:235