Version: SMASH-2.0
smash::SphereModus Class Reference

#include <spheremodus.h>

SphereModus: Provides a modus for expanding matter calculations

Matter is put in a sphere of radius R with uniform density; isotropic thermal momenta are typically used for initialization, although other initial momentum states are also included, see Bazow:2016oky [6] and Tindall:2016try [49]

To use this modus, choose

General:
Modus: Sphere

in the configuration file.

Options for SphereModus go in the "Modi"→"Sphere" section of the configuration:

Modi:
Sphere:
# definitions here

The following configuration options are understood: Sphere

Definition at line 47 of file spheremodus.h.

Inheritance diagram for smash::SphereModus:
[legend]
Collaboration diagram for smash::SphereModus:
[legend]

Public Member Functions

 SphereModus (Configuration modus_config, const ExperimentParameters &parameters)
 Constructor. More...
 
double initial_conditions (Particles *particles, const ExperimentParameters &parameters)
 Generates initial state of the particles in the system according to specified parameters: number of particles of each species, momentum and coordinate space distributions. More...
 
- Public Member Functions inherited from smash::ModusDefault
int impose_boundary_conditions (Particles *, const OutputsList &={})
 Enforces sensible positions for the particles. More...
 
int total_N_number () const
 
int proj_N_number () const
 
bool cll_in_nucleus () const
 
bool is_collider () const
 
bool is_box () const
 
bool is_list () const
 
double sqrt_s_NN () const
 
double impact_parameter () const
 
double velocity_projectile () const
 
double velocity_target () const
 
FermiMotion fermi_motion () const
 
double max_timestep (double) const
 
double equilibration_time () const
 
double nuclei_passing_time () const
 Get the passing time of the two nuclei in a collision. More...
 
Grid< GridOptions::Normalcreate_grid (const Particles &particles, double min_cell_length, double timestep_duration, CellSizeStrategy strategy=CellSizeStrategy::Optimal) const
 Creates the Grid with normal boundary conditions. More...
 

Private Attributes

double radius_
 Sphere radius (in fm/c) More...
 
double sphere_temperature_
 Temperature for momentum distribution (in GeV) More...
 
const double start_time_ = 0.
 Starting time for the Sphere. More...
 
const bool use_thermal_ = false
 Whether to use a thermal initialization for all particles instead of specific numbers. More...
 
const double mub_
 Baryon chemical potential for thermal initialization; only used if use_thermal_ is true. More...
 
const double mus_
 Strange chemical potential for thermal initialization; only used if use_thermal_ is true. More...
 
const bool account_for_resonance_widths_
 In case of thermal initialization: true – account for resonance spectral functions, while computing multiplicities and sampling masses, false – simply use pole masses. More...
 
const std::map< PdgCode, int > init_multipl_
 Particle multiplicities at initialization; required if use_thermal_ is false. More...
 
std::map< PdgCode, double > average_multipl_
 Average multiplicities in case of thermal initialization. More...
 
const SphereInitialCondition init_distr_
 Initialization scheme for momenta in the sphere; used for expanding metric setup. More...
 
const bool insert_jet_ = false
 Whether to insert a single high energy particle at the center of the expanding sphere (0,0,0). More...
 
const PdgCode jet_pdg_
 Pdg of the particle to use as a jet; necessary if insert_jet_ is true, unused otherwise. More...
 
const double jet_mom_
 Initial momentum of the jet particle; only used if insert_jet_ is true. More...
 

Friends

std::ostream & operator<< (std::ostream &, const SphereModus &)
 

Constructor & Destructor Documentation

◆ SphereModus()

smash::SphereModus::SphereModus ( Configuration  modus_config,
const ExperimentParameters parameters 
)
explicit

Constructor.

Takes all there is to take from the (truncated!) configuration object (only contains configuration for this modus).

Parameters
[in]modus_configThe configuration object that sets all initial conditions of the experiment.
[in]parametersUnused, but necessary because of templated initialization

Definition at line 164 of file spheremodus.cc.

166  : radius_(modus_config.take({"Sphere", "Radius"})),
167  sphere_temperature_(modus_config.take({"Sphere", "Temperature"})),
168  start_time_(modus_config.take({"Sphere", "Start_Time"}, 0.)),
169  use_thermal_(
170  modus_config.take({"Sphere", "Use_Thermal_Multiplicities"}, false)),
171  mub_(modus_config.take({"Sphere", "Baryon_Chemical_Potential"}, 0.)),
172  mus_(modus_config.take({"Sphere", "Strange_Chemical_Potential"}, 0.)),
174  modus_config.take({"Sphere", "Account_Resonance_Widths"}, true)),
176  ? std::map<PdgCode, int>()
177  : modus_config.take({"Sphere", "Init_Multiplicities"})
178  .convert_for(init_multipl_)),
179  init_distr_(
180  modus_config.take({"Sphere", "Initial_Condition"},
182  insert_jet_(modus_config.has_value({"Sphere", "Jet", "Jet_PDG"})),
183  jet_pdg_(insert_jet_ ? modus_config.take({"Sphere", "Jet", "Jet_PDG"})
184  .convert_for(jet_pdg_)
185  : pdg::p), // dummy default; never used
186  jet_mom_(modus_config.take({"Sphere", "Jet", "Jet_Momentum"}, 20.)) {}

Member Function Documentation

◆ initial_conditions()

double smash::SphereModus::initial_conditions ( Particles particles,
const ExperimentParameters parameters 
)

Generates initial state of the particles in the system according to specified parameters: number of particles of each species, momentum and coordinate space distributions.

Susbsequently makes the total 3-momentum 0.

Parameters
[out]particlesAn empty list that gets filled up by this function
[in]parametersThe initialization parameters of the box
Returns
The starting time of the simulation

Definition at line 231 of file spheremodus.cc.

232  {
233  FourVector momentum_total(0, 0, 0, 0);
234  const double T = this->sphere_temperature_;
235  const double V = 4.0 / 3.0 * M_PI * radius_ * radius_ * radius_;
236  /* Create NUMBER OF PARTICLES according to configuration */
237  if (use_thermal_) {
238  if (average_multipl_.empty()) {
239  for (const ParticleType &ptype : ParticleType::list_all()) {
240  if (HadronGasEos::is_eos_particle(ptype)) {
241  const double n = HadronGasEos::partial_density(
243  average_multipl_[ptype.pdgcode()] = n * V * parameters.testparticles;
244  }
245  }
246  }
247  double nb_init = 0.0, ns_init = 0.0;
248  for (const auto &mult : average_multipl_) {
249  const int thermal_mult_int = random::poisson(mult.second);
250  particles->create(thermal_mult_int, mult.first);
251  nb_init += mult.second * mult.first.baryon_number();
252  ns_init += mult.second * mult.first.strangeness();
253  logg[LSphere].debug(mult.first, " initial multiplicity ",
254  thermal_mult_int);
255  }
256  logg[LSphere].info("Initial hadron gas baryon density ", nb_init);
257  logg[LSphere].info("Initial hadron gas strange density ", ns_init);
258  } else {
259  for (const auto &p : init_multipl_) {
260  particles->create(p.second * parameters.testparticles, p.first);
261  logg[LSphere].debug("Particle ", p.first, " initial multiplicity ",
262  p.second);
263  }
264  }
265  std::unique_ptr<QuantumSampling> quantum_sampling;
267  quantum_sampling = make_unique<QuantumSampling>(init_multipl_, V, T);
268  }
269  /* loop over particle data to fill in momentum and position information */
270  for (ParticleData &data : *particles) {
271  Angles phitheta;
272  /* thermal momentum according Maxwell-Boltzmann distribution */
273  double momentum_radial = 0.0, mass = data.pole_mass();
274  /* assign momentum_radial according to requested distribution */
275  switch (init_distr_) {
277  momentum_radial = sample_momenta_IC_ES(T);
278  break;
280  momentum_radial = sample_momenta_1M_IC(T, mass);
281  break;
283  momentum_radial = sample_momenta_2M_IC(T, mass);
284  break;
286  momentum_radial = sample_momenta_non_eq_mass(T, mass);
287  break;
289  default:
291  ? data.type().mass()
292  : HadronGasEos::sample_mass_thermal(data.type(), 1.0 / T);
293  momentum_radial = sample_momenta_from_thermal(T, mass);
294  break;
296  /*
297  * **********************************************************************
298  * Sampling the thermal momentum according Bose/Fermi/Boltzmann
299  * distribution.
300  * We take the pole mass as the mass.
301  * **********************************************************************
302  */
303  mass = data.type().mass();
304  momentum_radial = quantum_sampling->sample(data.pdgcode());
305  break;
306  }
307  phitheta.distribute_isotropically();
308  logg[LSphere].debug(data.type().name(), "(id ", data.id(),
309  ") radial momentum ", momentum_radial, ", direction",
310  phitheta);
311  data.set_4momentum(mass, phitheta.threevec() * momentum_radial);
312  momentum_total += data.momentum();
313  /* uniform sampling in a sphere with radius r */
314  double position_radial;
315  position_radial = std::cbrt(random::canonical()) * radius_;
316  Angles pos_phitheta;
317  pos_phitheta.distribute_isotropically();
318  data.set_4position(
319  FourVector(start_time_, pos_phitheta.threevec() * position_radial));
320  data.set_formation_time(start_time_);
321  }
322  /* Make total 3-momentum 0 */
323  for (ParticleData &data : *particles) {
324  data.set_4momentum(data.momentum().abs(),
325  data.momentum().threevec() -
326  momentum_total.threevec() / particles->size());
327  }
328 
329  /* Add a single highly energetic particle in the center of the sphere (jet) */
330  if (insert_jet_) {
331  auto &jet_particle = particles->create(jet_pdg_);
332  jet_particle.set_formation_time(start_time_);
333  jet_particle.set_4position(FourVector(start_time_, 0., 0., 0.));
334  jet_particle.set_4momentum(ParticleType::find(jet_pdg_).mass(),
335  ThreeVector(jet_mom_, 0., 0.));
336  }
337 
338  /* Recalculate total momentum */
339  momentum_total = FourVector(0, 0, 0, 0);
340  for (ParticleData &data : *particles) {
341  momentum_total += data.momentum();
342  /* IC: debug checks */
343  logg[LSphere].debug() << data;
344  }
345  /* allows to check energy conservation */
346  logg[LSphere].debug() << "Sphere initial total 4-momentum [GeV]: "
347  << momentum_total;
348  return start_time_;
349 }
Here is the call graph for this function:

Member Data Documentation

◆ radius_

double smash::SphereModus::radius_
private

Sphere radius (in fm/c)

Definition at line 78 of file spheremodus.h.

◆ sphere_temperature_

double smash::SphereModus::sphere_temperature_
private

Temperature for momentum distribution (in GeV)

Definition at line 80 of file spheremodus.h.

◆ start_time_

const double smash::SphereModus::start_time_ = 0.
private

Starting time for the Sphere.

Definition at line 82 of file spheremodus.h.

◆ use_thermal_

const bool smash::SphereModus::use_thermal_ = false
private

Whether to use a thermal initialization for all particles instead of specific numbers.

Definition at line 87 of file spheremodus.h.

◆ mub_

const double smash::SphereModus::mub_
private

Baryon chemical potential for thermal initialization; only used if use_thermal_ is true.

Definition at line 92 of file spheremodus.h.

◆ mus_

const double smash::SphereModus::mus_
private

Strange chemical potential for thermal initialization; only used if use_thermal_ is true.

Definition at line 97 of file spheremodus.h.

◆ account_for_resonance_widths_

const bool smash::SphereModus::account_for_resonance_widths_
private

In case of thermal initialization: true – account for resonance spectral functions, while computing multiplicities and sampling masses, false – simply use pole masses.

Definition at line 103 of file spheremodus.h.

◆ init_multipl_

const std::map<PdgCode, int> smash::SphereModus::init_multipl_
private

Particle multiplicities at initialization; required if use_thermal_ is false.

Definition at line 108 of file spheremodus.h.

◆ average_multipl_

std::map<PdgCode, double> smash::SphereModus::average_multipl_
private

Average multiplicities in case of thermal initialization.

Saved to avoid recalculating at every event

Definition at line 113 of file spheremodus.h.

◆ init_distr_

const SphereInitialCondition smash::SphereModus::init_distr_
private

Initialization scheme for momenta in the sphere; used for expanding metric setup.

Definition at line 118 of file spheremodus.h.

◆ insert_jet_

const bool smash::SphereModus::insert_jet_ = false
private

Whether to insert a single high energy particle at the center of the expanding sphere (0,0,0).

This particle will initially be moving along the x axis, outwards from the sphere.

Definition at line 124 of file spheremodus.h.

◆ jet_pdg_

const PdgCode smash::SphereModus::jet_pdg_
private

Pdg of the particle to use as a jet; necessary if insert_jet_ is true, unused otherwise.

Definition at line 129 of file spheremodus.h.

◆ jet_mom_

const double smash::SphereModus::jet_mom_
private

Initial momentum of the jet particle; only used if insert_jet_ is true.

Definition at line 133 of file spheremodus.h.


The documentation for this class was generated from the following files:
SphereInitialCondition::IC_Massive
smash::SphereModus::mus_
const double mus_
Strange chemical potential for thermal initialization; only used if use_thermal_ is true.
Definition: spheremodus.h:97
smash::sample_momenta_1M_IC
double sample_momenta_1M_IC(const double temperature, const double mass)
Samples a momentum from the non-equilibrium distribution 1M_IC from Bazow:2016oky .
Definition: distributions.cc:125
smash::SphereModus::init_multipl_
const std::map< PdgCode, int > init_multipl_
Particle multiplicities at initialization; required if use_thermal_ is false.
Definition: spheremodus.h:108
smash::SphereModus::insert_jet_
const bool insert_jet_
Whether to insert a single high energy particle at the center of the expanding sphere (0,...
Definition: spheremodus.h:124
SphereInitialCondition::IC_2M
smash::SphereModus::account_for_resonance_widths_
const bool account_for_resonance_widths_
In case of thermal initialization: true – account for resonance spectral functions,...
Definition: spheremodus.h:103
smash::SphereModus::radius_
double radius_
Sphere radius (in fm/c)
Definition: spheremodus.h:78
SphereInitialCondition::ThermalMomentaBoltzmann
smash::sample_momenta_non_eq_mass
double sample_momenta_non_eq_mass(const double temperature, const double mass)
Samples a momentum via rejection method from the non-equilibrium distribution.
Definition: distributions.cc:91
smash::SphereModus::start_time_
const double start_time_
Starting time for the Sphere.
Definition: spheremodus.h:82
smash::HadronGasEos::partial_density
static double partial_density(const ParticleType &ptype, double T, double mub, double mus, double muq, bool account_for_resonance_widths=false)
Compute partial density of one hadron sort.
Definition: hadgas_eos.cc:270
smash::SphereModus::init_distr_
const SphereInitialCondition init_distr_
Initialization scheme for momenta in the sphere; used for expanding metric setup.
Definition: spheremodus.h:118
smash::logg
std::array< einhard::Logger<>, std::tuple_size< LogArea::AreaTuple >::value > logg
An array that stores all pre-configured Logger objects.
Definition: logging.cc:39
smash::ParticleType::find
static const ParticleType & find(PdgCode pdgcode)
Returns the ParticleType object for the given pdgcode.
Definition: particletype.cc:99
smash::HadronGasEos::sample_mass_thermal
static double sample_mass_thermal(const ParticleType &ptype, double beta)
Sample resonance mass in a thermal medium.
Definition: hadgas_eos.cc:385
SphereInitialCondition::ThermalMomentaQuantum
smash::SphereModus::mub_
const double mub_
Baryon chemical potential for thermal initialization; only used if use_thermal_ is true.
Definition: spheremodus.h:92
SphereInitialCondition::IC_1M
smash::SphereModus::sphere_temperature_
double sphere_temperature_
Temperature for momentum distribution (in GeV)
Definition: spheremodus.h:80
smash::sample_momenta_2M_IC
double sample_momenta_2M_IC(const double temperature, const double mass)
Samples a momentum from the non-equilibrium distribution 2M_IC from Bazow:2016oky .
Definition: distributions.cc:162
smash::LSphere
static constexpr int LSphere
Definition: spheremodus.cc:33
smash::SphereModus::jet_pdg_
const PdgCode jet_pdg_
Pdg of the particle to use as a jet; necessary if insert_jet_ is true, unused otherwise.
Definition: spheremodus.h:129
smash::random::poisson
int poisson(const T &lam)
Returns a Poisson distributed random number.
Definition: random.h:226
SphereInitialCondition::IC_ES
smash::sample_momenta_IC_ES
double sample_momenta_IC_ES(const double temperature)
Sample momenta according to the momentum distribution in Bazow:2016oky .
Definition: distributions.cc:248
smash::HadronGasEos::is_eos_particle
static bool is_eos_particle(const ParticleType &ptype)
Check if a particle belongs to the EoS.
Definition: hadgas_eos.h:355
smash::SphereModus::average_multipl_
std::map< PdgCode, double > average_multipl_
Average multiplicities in case of thermal initialization.
Definition: spheremodus.h:113
smash::SphereModus::jet_mom_
const double jet_mom_
Initial momentum of the jet particle; only used if insert_jet_ is true.
Definition: spheremodus.h:133
smash::pdg::p
constexpr int p
Proton.
Definition: pdgcode_constants.h:28
smash::pdg::n
constexpr int n
Neutron.
Definition: pdgcode_constants.h:30
smash::sample_momenta_from_thermal
double sample_momenta_from_thermal(const double temperature, const double mass)
Samples a momentum from the Maxwell-Boltzmann (thermal) distribution in a faster way,...
Definition: distributions.cc:199
smash::SphereModus::use_thermal_
const bool use_thermal_
Whether to use a thermal initialization for all particles instead of specific numbers.
Definition: spheremodus.h:87
smash::random::canonical
T canonical()
Definition: random.h:113
smash::ParticleType::list_all
static const ParticleTypeList & list_all()
Definition: particletype.cc:51