forwarddeclarations.h File Reference

Go to the source code of this file.

Typedefs
typedef std::bitset< 11 >	ReactionsBitSet
	Container for the 2 to 2 reactions in the code. More...
typedef std::bitset< 4 >	MultiParticleReactionsBitSet
	Container for the n to m reactions in the code. More...
typedef std::bitset< 5 >	FluidizableProcessesBitSet

Enumerations
enum class	CalculationFrame { CenterOfVelocity , CenterOfMass , FixedTarget }
	The calculation frame. More...
enum class	DileptonBremsPionFormFactor { Off , FF1 , FF2 }
	Option to use form factors in dilepton bremsstrahlung as described in Shyam:2010vr [58]. More...
enum class	FermiMotion { Off , On , Frozen }
	Option to use Fermi Motion. More...
enum class	Sampling { Uniform , Quadratic , Custom }
	Possible methods of impact parameter sampling. More...
enum class	DerivativesMode { CovariantGaussian , FiniteDifference , Off }
	Modes of calculating the gradients. More...
enum class	RestFrameDensityDerivativesMode { On , Off }
	This enum is here only to serve InputKeys class, but it is unused and referring to a removed SMASH input key. More...
enum class	FieldDerivativesMode { ChainRule , Direct }
	Modes of calculating the field gradients: chain rule or direct. More...
enum class	SmearingMode { CovariantGaussian , Discrete , Triangular }
	Modes of smearing. More...
enum class	TimeStepMode : char { None , Fixed }
	The time step mode. More...
enum class	BoxInitialCondition { ThermalMomentaBoltzmann , ThermalMomentaQuantum , PeakedMomenta }
	Initial condition for a particle in a box. More...
enum class	SphereInitialCondition {   ThermalMomentaBoltzmann , ThermalMomentaQuantum , IC_ES , IC_1M ,   IC_2M , IC_Massive }
	Initial condition for a particle in a sphere. More...
enum class	ExpansionMode { NoExpansion , MasslessFRW , MassiveFRW , Exponential }
	Defines properties of expansion for the metric (e.g. More...
enum class	NNbarTreatment { NoAnnihilation , Resonances , TwoToFive , Strings }
	Treatment of N Nbar Annihilation. More...
enum class	ThermodynamicQuantity : char {   EckartDensity , Tmn , TmnLandau , LandauVelocity ,   j_QBS }
	Represents thermodynamic quantities that can be printed out See user guide description for more information. More...
enum class	CollisionCriterion { Geometric , Stochastic , Covariant }
	Criteria used to check collisions. More...
enum class	OutputOnlyFinal { Yes , No , 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 , Charm_T_matrix = 10 }
	The different groups of 2 to 2 reactions that one can include. More...
enum	IncludedMultiParticleReactions { Meson_3to1 = 0 , Deuteron_3to2 = 1 , NNbar_5to2 = 2 , A3_Nuclei_4to2 = 3 }
	The different groups of multi-particle reactions that one can include. More...
enum class	CharmRescattering { None , Resonances , T_Matrix }
	Possible charm scattering options. More...
enum class	SpinInteractionType { On , Off }
	Possible spin interaction types. More...
enum class	ThermalizationAlgorithm { ModeSampling , BiasedBF , UnbiasedBF }
	Defines the algorithm used for the forced thermalization. More...
enum class	EventCounting { FixedNumber , MinimumNonEmpty , Invalid }
	Defines how the number of events is determined. More...
enum class	TotalCrossSectionStrategy { BottomUp , TopDown , TopDownMeasured }
	Determine how total cross sections for collision finding should be computed. More...
enum class	HardStringTransitionMode { Exponential , Custom_Range }
	Select the model used for the transition from soft to hard string excitation. More...
enum class	PseudoResonance {   None , Largest , Closest , LargestFromUnstable ,   ClosestFromUnstable }
	Which pseudo-resonance fills the inelastic gap in the transition to string region of cross sections. More...
enum class	FluidizationType { ConstantTau , Dynamic }
	Possible methods to convert SMASH particle into fluid cells. More...
enum	IncludedFluidizableProcesses {   From_Elastic = 0 , From_Decay = 1 , From_Inelastic = 2 , From_SoftString = 3 ,   From_HardString = 4 }
	The different processes from where fluidizable particles are produced. More...
enum class	DensityType {   None = 0 , Hadron = 1 , Baryon = 2 , BaryonicIsospin = 3 ,   Pion = 4 , Isospin3_tot = 5 , Charge = 6 , Strangeness = 7 }
	Allows to choose which kind of density to calculate. More...
enum class	ExtrapolationType { None = -1 , Zero = 0 , Constant = 1 , Linear = 2 }
	Allows to specify the desired extrapolation type. More...

Typedef Documentation

ReactionsBitSet

typedef std::bitset<11> ReactionsBitSet

Container for the 2 to 2 reactions in the code.

Attention

Two typedefs naming the same type are not distinct types. Hence, if two bitsets have an identical length N of bits (std::bitset<N>), the types are exactly the same. The compiler will e.g. reject ambiguous overloads; therefore, developers should ensure that multiple bitsets are not set to the same length.

Definition at line 270 of file forwarddeclarations.h.

MultiParticleReactionsBitSet

typedef std::bitset<4> MultiParticleReactionsBitSet

Container for the n to m reactions in the code.

Attention

See remark in ReactionsBitSet

Definition at line 286 of file forwarddeclarations.h.

FluidizableProcessesBitSet

typedef std::bitset<5> FluidizableProcessesBitSet

Attention

See remark in ReactionsBitSet

Definition at line 402 of file forwarddeclarations.h.

Enumeration Type Documentation

CalculationFrame

enum CalculationFrame

strong

The calculation frame.

Enumerator
CenterOfVelocity
CenterOfMass
FixedTarget

Definition at line 58 of file forwarddeclarations.h.

                            {
  CenterOfVelocity,
  CenterOfMass,
  FixedTarget,
};

DileptonBremsPionFormFactor

enum DileptonBremsPionFormFactor

strong

Option to use form factors in dilepton bremsstrahlung as described in Shyam:2010vr [58].

Enumerator
Off	Don't use form factors, i.e. multiply by 1.
FF1	Photon couples to pion only via \(\rho_0\) meson.
FF2	Photon couples 40% directly to intrinsice quark structure of pion and 60% indirectly via \(\rho_0\) meson.

Definition at line 68 of file forwarddeclarations.h.

                                       {
  /// Don't use form factors, i.e. multiply by 1.
  Off,
  /// Photon couples to pion only via \f$\rho_0\f$ meson.
  FF1,
  /**
   * Photon couples 40% directly to intrinsice quark structure of pion and
   * 60% indirectly via \f$\rho_0\f$ meson.
   */
  FF2,
};

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 81 of file forwarddeclarations.h.

                       {
  /// Don't use fermi motion.
  Off,
  /// Use fermi motion in combination with potentials.
  On,
  /// Use fermi motion without potentials.
  Frozen,
};

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 91 of file forwarddeclarations.h.

                    {
  /// Sample from uniform distribution.
  Uniform,
  /// Sample from areal / quadratic distribution.
  Quadratic,
  /// Sample from custom, user-defined distribution.
  Custom,
};

DerivativesMode

enum DerivativesMode

strong

Modes of calculating the gradients.

Enumerator
CovariantGaussian
FiniteDifference
Off

Definition at line 101 of file forwarddeclarations.h.

                           {
  CovariantGaussian,
  FiniteDifference,
  Off,
};

RestFrameDensityDerivativesMode

enum RestFrameDensityDerivativesMode

strong

This enum is here only to serve InputKeys class, but it is unused and referring to a removed SMASH input key.

Enumerator
On
Off

Definition at line 111 of file forwarddeclarations.h.

                                           {
  On,
  Off,
};

FieldDerivativesMode

enum FieldDerivativesMode

strong

Modes of calculating the field gradients: chain rule or direct.

The modes only make sense for the VDF potentials.

Enumerator
ChainRule
Direct

Definition at line 120 of file forwarddeclarations.h.

                                {
  ChainRule,
  Direct,
};

SmearingMode

enum SmearingMode

strong

Modes of smearing.

Enumerator
CovariantGaussian
Discrete
Triangular

Definition at line 126 of file forwarddeclarations.h.

                        {
  CovariantGaussian,
  Discrete,
  Triangular,
};

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 133 of file forwarddeclarations.h.

                        : char {
  /// Don't use time steps; propagate from action to action.
  None,
  /// Use fixed time step.
  Fixed,
};

BoxInitialCondition

enum BoxInitialCondition

strong

Initial condition for a particle in a box.

In all cases, the positions in space are chosen randomly.

Enumerator
ThermalMomentaBoltzmann	A thermalized ensemble is generated, with momenta sampled from a Maxwell-Boltzmann distribution.
ThermalMomentaQuantum	A thermalized ensemble is generated, with momenta of baryons(mesons) sampled from a Fermi(Bose) distribution.
PeakedMomenta	All particles have the same momentum \(p = 3 \cdot T\) with T being the temperature.

Definition at line 145 of file forwarddeclarations.h.

                               {
  /// A thermalized ensemble is generated, with momenta sampled from a
  /// Maxwell-Boltzmann distribution
  ThermalMomentaBoltzmann,
  /// A thermalized ensemble is generated, with momenta of baryons(mesons)
  /// sampled from a Fermi(Bose) distribution
  ThermalMomentaQuantum,
  /// All particles have the same momentum \f$p = 3 \cdot T\f$ with T being the
  /// temperature.
  PeakedMomenta,
};

SphereInitialCondition

enum SphereInitialCondition

strong

Initial condition for a particle in a sphere.

Enumerator
ThermalMomentaBoltzmann	A thermalized ensemble is generated, with momenta sampled from a Maxwell-Boltzmann distribution.
ThermalMomentaQuantum	A thermalized ensemble is generated, with momenta of baryons(mesons) sampled from a Fermi(Bose) distribution.
IC_ES	Off-equilibrium distribution used in massless comparisons of SMASH to the extended universe metric. See eq. (76) in Bazow:2016oky [10]
IC_1M	Off-equilibrium distribution used in massless comparisons of SMASH to the extended universe metric. See eq. (77) in Bazow:2016oky [10]
IC_2M	Off-equilibrium distribution used in massless comparisons of SMASH to the extended universe metric. See eq. (78) in Bazow:2016oky [10]
IC_Massive	A generalization of IC_ES for the non-zero mass case; note that there is currently no analytical comparison possible with this distribution.

Definition at line 158 of file forwarddeclarations.h.

                                  {
  /// A thermalized ensemble is generated, with momenta sampled from a
  /// Maxwell-Boltzmann distribution
  ThermalMomentaBoltzmann,
  /// A thermalized ensemble is generated, with momenta of baryons(mesons)
  /// sampled from a Fermi(Bose) distribution
  ThermalMomentaQuantum,
  /// Off-equilibrium distribution used in massless comparisons of SMASH to the
  /// extended universe metric. See eq. (76) in \iref{Bazow:2016oky}
  IC_ES,
  /// Off-equilibrium distribution used in massless comparisons of SMASH to the
  /// extended universe metric. See eq. (77) in \iref{Bazow:2016oky}
  IC_1M,
  /// Off-equilibrium distribution used in massless comparisons of SMASH to the
  /// extended universe metric. See eq. (78) in \iref{Bazow:2016oky}
  IC_2M,
  /// A generalization of IC_ES for the non-zero mass case; note that there is
  /// currently no analytical comparison possible with this distribution.
  IC_Massive,
};

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 187 of file forwarddeclarations.h.

                         {
  NoExpansion,
  MasslessFRW,
  MassiveFRW,
  Exponential,
};

NNbarTreatment

enum NNbarTreatment

strong

Treatment of N Nbar Annihilation.

Enumerator
NoAnnihilation	No Annihilation.
Resonances	Use intermediate Resonances.
TwoToFive	Directly create 5 pions, use with multi-particle reactions.
Strings	Use string fragmentation.

Definition at line 195 of file forwarddeclarations.h.

                          {
  /// No Annihilation
  NoAnnihilation,
  /// Use intermediate Resonances
  Resonances,
  /// Directly create 5 pions, use with multi-particle reactions
  TwoToFive,
  /// Use string fragmentation
  Strings,
};

ThermodynamicQuantity

enum ThermodynamicQuantity : char

strong

Represents thermodynamic quantities that can be printed out See user guide description for more information.

Enumerator
EckartDensity	Density in the Eckart frame.
Tmn	Energy-momentum tensor in lab frame.
TmnLandau	Energy-momentum tensor in Landau rest frame.
LandauVelocity	Velocity of the Landau rest frame.
j_QBS	Electric (Q), baryonic (B) and strange (S) currents.

Definition at line 210 of file forwarddeclarations.h.

                                 : char {
  /// Density in the Eckart frame
  EckartDensity,
  /// Energy-momentum tensor in lab frame
  Tmn,
  /// Energy-momentum tensor in Landau rest frame
  TmnLandau,
  /// Velocity of the Landau rest frame
  LandauVelocity,
  /// Electric (Q), baryonic (B) and strange (S) currents
  j_QBS
};

CollisionCriterion

enum CollisionCriterion

strong

Criteria used to check collisions.

Enumerator
Geometric	Geometric criterion.
Stochastic	Stochastic Criteiron.
Covariant	Covariant Criterion.

Definition at line 224 of file forwarddeclarations.h.

                              {
  /// Geometric criterion.
  Geometric,
  /// Stochastic Criteiron.
  Stochastic,
  /// Covariant Criterion
  Covariant
};

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 234 of file forwarddeclarations.h.

                           {
  /// Print only final-state particles.
  Yes,
  /// Print initial, intermediate and final-state particles.
  No,
  /// Print only final-state particles, and those only if the event is not
  /// empty.
  IfNotEmpty,
};

IncludedReactions

enum 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
Charm_T_matrix

Definition at line 246 of file forwarddeclarations.h.

                       {
  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,
  Charm_T_matrix = 10,
};

IncludedMultiParticleReactions

enum IncludedMultiParticleReactions

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

Enumerator
Meson_3to1
Deuteron_3to2
NNbar_5to2
A3_Nuclei_4to2

Definition at line 274 of file forwarddeclarations.h.

                                    {
  Meson_3to1 = 0,
  Deuteron_3to2 = 1,
  NNbar_5to2 = 2,
  A3_Nuclei_4to2 = 3,
};

CharmRescattering

enum CharmRescattering

strong

Possible charm scattering options.

Enumerator
None	Disable charm interactions.
Resonances	Charm interactions via resonances.
T_Matrix	Charm interactions via T-matrix approach.

Definition at line 289 of file forwarddeclarations.h.

                             {
  /// Disable charm interactions
  None,
  /// Charm interactions via resonances
  Resonances,
  /// Charm interactions via T-matrix approach
  T_Matrix,
};

SpinInteractionType

enum SpinInteractionType

strong

Possible spin interaction types.

Enumerator
On	All spin interactions.
Off	No spin interactions.

Definition at line 299 of file forwarddeclarations.h.

                               {
  /// All spin interactions
  On,
  /// No spin interactions
  Off
};

ThermalizationAlgorithm

enum ThermalizationAlgorithm

strong

Defines the algorithm used for the forced thermalization.

For the description of algorithms see Oliinychenko:2016vkg [48]. 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 315 of file forwarddeclarations.h.

                                   {
  ModeSampling,
  BiasedBF,
  UnbiasedBF,
};

EventCounting

enum EventCounting

strong

Defines how the number of events is determined.

Enumerator
FixedNumber	The desired number of events is simulated disregarding of whether an interaction took place.
MinimumNonEmpty	Events are simulated until there are at least a given number of ensembles in which an interaction took place.
Invalid	Unused, only in the code for internal logic.

Definition at line 322 of file forwarddeclarations.h.

                         {
  /// The desired number of events is simulated disregarding of whether an
  /// interaction took place.
  FixedNumber,
  /// Events are simulated until there are at least a given number of ensembles
  /// in which an interaction took place
  MinimumNonEmpty,
  /// Unused, only in the code for internal logic
  Invalid,
};

TotalCrossSectionStrategy

enum TotalCrossSectionStrategy

strong

Determine how total cross sections for collision finding should be computed.

Enumerator
BottomUp	Sum the existing partial contributions.
TopDown	Use parametrizations based on existing data, rescaling with AQM for unmeasured processes.
TopDownMeasured	Mix the two above, using the parametrizations only for measured processes, and summing up partials for unmeasured interactions.

Definition at line 334 of file forwarddeclarations.h.

                                     {
  /// Sum the existing partial contributions
  BottomUp,
  /// Use parametrizations based on existing data, rescaling with AQM for
  /// unmeasured processes
  TopDown,
  /// Mix the two above, using the parametrizations only for measured processes,
  /// and summing up partials for unmeasured interactions
  TopDownMeasured,
};

HardStringTransitionMode

enum HardStringTransitionMode

strong

Select the model used for the transition from soft to hard string excitation.

Enumerator
Exponential	Legacy exponential splitting based on the hard string cross section.
Custom_Range	Smooth transition within a user-defined invariant energy range.

Definition at line 349 of file forwarddeclarations.h.

                                    {
  /// Legacy exponential splitting based on the hard string cross section
  Exponential,
 
  /// Smooth transition within a user-defined invariant energy range.
  Custom_Range,
};

PseudoResonance

enum PseudoResonance

strong

Which pseudo-resonance fills the inelastic gap in the transition to string region of cross sections.

See user guide description for more information.

Enumerator
None	No pseudo-resonance is created.
Largest	Resonance of largest mass for all processes.
Closest	Resonance with the pole mass closest from the invariant mass of incoming particles for all processes.
LargestFromUnstable	Heaviest possible resonance from processes with at least one resonance in the incoming particles.
ClosestFromUnstable	Closest resonance for a given mass from processes with at least one resonance in the incoming particles.

Definition at line 361 of file forwarddeclarations.h.

                           {
  /// No pseudo-resonance is created
  None,
  /// Resonance of largest mass for all processes
  Largest,
  /// Resonance with the pole mass closest from the invariant mass of incoming
  /// particles for all processes
  Closest,
  /// Heaviest possible resonance from processes with at least one resonance in
  /// the incoming particles
  LargestFromUnstable,
  /// Closest resonance for a given mass from processes with at least one
  /// resonance in the incoming particles
  ClosestFromUnstable,
};

FluidizationType

enum FluidizationType

strong

Possible methods to convert SMASH particle into fluid cells.

See user guide description for more information.

Enumerator
ConstantTau	Hypersurface crossed at a fixed proper time.
Dynamic	Dynamic fluidization based on local densities.

Definition at line 381 of file forwarddeclarations.h.

                            {
  /// Hypersurface crossed at a fixed proper time
  ConstantTau,
  /// Dynamic fluidization based on local densities
  Dynamic,
};

IncludedFluidizableProcesses

enum IncludedFluidizableProcesses

The different processes from where fluidizable particles are produced.

See user guide description for more information.

Enumerator
From_Elastic
From_Decay
From_Inelastic
From_SoftString
From_HardString

Definition at line 393 of file forwarddeclarations.h.

                                  {
  From_Elastic = 0,
  From_Decay = 1,
  From_Inelastic = 2,
  From_SoftString = 3,
  From_HardString = 4,
};

DensityType

enum DensityType

strong

Allows to choose which kind of density to calculate.

The baryon density is necessary for the Skyrme potential. For the symmetry potential one needs to know the isospin density.

Enumerator
None
Hadron
Baryon
BaryonicIsospin
Pion
Isospin3_tot
Charge
Strangeness

Definition at line 409 of file forwarddeclarations.h.

                       {
  None = 0,
  Hadron = 1,
  Baryon = 2,
  BaryonicIsospin = 3,
  Pion = 4,
  Isospin3_tot = 5,
  Charge = 6,
  Strangeness = 7,
};

ExtrapolationType

enum ExtrapolationType

strong

Allows to specify the desired extrapolation type.

Enumerator
None	No extrapolation is done.
Zero	Extrapolate with zero.
Constant	Extrapolate using a constant value.
Linear	Extrapolate using a linear approach.

Definition at line 421 of file forwarddeclarations.h.

                             {
  /// No extrapolation is done.
  None = -1,
  /// Extrapolate with zero.
  Zero = 0,
  /// Extrapolate using a constant value.
  Constant = 1,
  /// Extrapolate using a linear approach.
  Linear = 2,
};