#include <customnucleus.h>

Inheriting from Nucleus-Class using modified Nucleon configurations.

Configurations are read in from external lists.

Definition at line 41 of file customnucleus.h.

Inheritance diagram for smash::CustomNucleus:

Public Member Functions
	CustomNucleus (Configuration &config, int testparticles, bool same_file)
	Constructor that needs configuration parameters from input file and the number of testparticles. More...

void	fill_from_list (const std::vector< Nucleoncustom > &vec)
	Fills Particlelist from vector containing data for one nucleus. More...

ThreeVector	distribute_nucleon () override
	Returns position of a nucleon as given in the external file. More...

void	arrange_nucleons () override
	Sets the positions of the nucleons inside a nucleus. More...

std::vector< Nucleoncustom >	readfile (std::ifstream &infile) const
	The returned vector contains Data for one nucleus given in the particlelist. More...

std::string	file_path (const std::string &file_directory, const std::string &file_name)
	Generates the name of the stream file. More...

void	generate_fermi_momenta () override
	Generates Fermi momenta as it is done in the mother class but in addition prints a warning that the Fermi momenta are generated accoriding to Woods-Saxon distributed nucleons. More...

Public Member Functions inherited from smash::Nucleus
	Nucleus ()=default
	default constructor More...

	Nucleus (Configuration &config, int nTest)
	Constructor for Nucleus, that needs the configuration parameters from the inputfile and the number of testparticles. More...

	Nucleus (const std::map< PdgCode, int > &particle_list, int nTest)
	Constructor which directly initializes the Nucleus with particles and respective counts. More...

virtual	~Nucleus ()=default

double	mass () const

double	woods_saxon (double x)
	Woods-Saxon distribution. More...

virtual void	set_parameters_automatic ()
	Sets the deformation parameters of the Woods-Saxon distribution according to the current mass number. More...

void	boost (double beta_scalar)
	Boosts the nuclei into the computational frame, such that the nucleons have the appropriate momentum and the nuclei are lorentz-contracted. More...

void	fill_from_list (const std::map< PdgCode, int > &particle_list, int testparticles)
	Adds particles from a map PDG code => Number_of_particles_with_that_PDG_code to the nucleus. More...

void	shift (double z_offset, double x_offset, double simulation_time)
	Shifts the nucleus to correct impact parameter and z displacement. More...

virtual void	rotate ()
	Rotates the nucleus using the three euler angles phi, theta and psi. More...

void	copy_particles (Particles *particles)
	Copies the particles from this nucleus into the particle list. More...

size_t	size () const
	Number of numerical (=test-)particles in the nucleus: More...

size_t	number_of_particles () const
	Number of physical particles in the nucleus: More...

size_t	number_of_protons () const
	Number of physical protons in the nucleus: More...

FourVector	center () const
	Calculate geometrical center of the nucleus. More...

void	set_label (BelongsTo label)
	Sets target / projectile labels on nucleons. More...

void	align_center ()
	Shifts the nucleus so that its center is at (0,0,0) More...

virtual double	nucleon_density (double r, double, double) const
	Return the Woods-Saxon probability density for the given position. More...

virtual double	nucleon_density_unnormalized (double r, double, double) const
	Return the unnormalized Woods-Saxon distribution for the given position without deformation. More...

virtual double	calculate_saturation_density () const

virtual void	set_saturation_density (double density)
	Sets the saturation density of the nucleus. More...

std::vector< ParticleData >::iterator	begin ()
	For iterators over the particle list: More...

std::vector< ParticleData >::iterator	end ()
	For iterators over the particle list: More...

std::vector< ParticleData >::const_iterator	cbegin () const
	For const iterators over the particle list: More...

std::vector< ParticleData >::const_iterator	cend () const
	For const iterators over the particle list: More...

void	set_diffusiveness (double diffuse)
	Sets the diffusiveness of the nucleus. More...

double	get_diffusiveness () const

double	get_saturation_density () const

double	default_nuclear_radius ()
	Default nuclear radius calculated as: More...

void	set_nuclear_radius (double rad)
	Sets the nuclear radius. More...

double	get_nuclear_radius () const

void	set_orientation_from_config (Configuration &orientation_config)
	Set angles for rotation of the nucleus from config file. More...

Private Attributes
std::unique_ptr< std::ifstream >	filestream_
	Filestream variable used if projectile and target are read in from different files and they therefore use different streams. More...

std::unique_ptr< std::ifstream > *	used_filestream_
	Pointer to the used filestream pointer. More...

int	number_of_nucleons_ = 0
	Number of nucleons per nucleus Set initally to zero to be modified in the constructor. More...

int	number_of_protons_ = 0
	Number of protons per nucleus. More...

int	number_of_neutrons_ = 0
	Number of neutrons per nucleus. More...

std::vector< Nucleoncustom >	custom_nucleus_
	Vector contianing Data for one nucleus given in the particlelist. More...

size_t	index_ = 0
	Index needed to read out vector in distribute nucleon. More...

Static Private Attributes
static std::unique_ptr< std::ifstream >	filestream_shared_ = nullptr
	Filestream variable used if projectile and target are read in from the same file and they use the same static stream. More...

Additional Inherited Members
Protected Member Functions inherited from smash::Nucleus
void	random_euler_angles ()
	Randomly generate Euler angles. More...

Protected Attributes inherited from smash::Nucleus
std::vector< ParticleData >	particles_
	Particles associated with this nucleus. More...

double	saturation_density_ = nuclear_density
	Saturation density of this nucleus. More...

double	euler_phi_ = 0.0
	The Euler angle phi of the three Euler angles used to apply rotations to the nucleus. More...

double	euler_theta_ = 0.0
	Euler angle theta. More...

double	euler_psi_ = 0.0
	Euler angle psi. More...

bool	random_rotation_ = false
	Whether the nucleus should be rotated randomly. More...

Constructor & Destructor Documentation

◆ CustomNucleus()

smash::CustomNucleus::CustomNucleus	(	Configuration &	config,
		int	testparticles,
		bool	same_file
	)

Constructor that needs configuration parameters from input file and the number of testparticles.

Parameters

[in]	config	contains the parameters from the inputfile on the numbers of particles with a certain PDG code and also the path where the external particle list is located
[in]	testparticles	represents the number of testparticles
[in]	same_file	specifies if target and projectile nucleus are read in from the same file, which is important for the ifstream

Definition at line 26 of file customnucleus.cc.

                                              {
   assert(has_projectile_or_target(config));
   const bool is_projectile = is_about_projectile(config);
   const auto& [file_dir_key, filename_key, particles_key] = [&is_projectile]() {
     return is_projectile
                ? std::make_tuple(
                      InputKeys::modi_collider_projectile_custom_fileDirectory,
                      InputKeys::modi_collider_projectile_custom_fileName,
                      InputKeys::modi_collider_projectile_particles)
                : std::make_tuple(
                      InputKeys::modi_collider_target_custom_fileDirectory,
                      InputKeys::modi_collider_target_custom_fileName,
                      InputKeys::modi_collider_target_particles);
   }();
   // Read in file directory from config
   const std::string particle_list_file_directory = config.take(file_dir_key);
   // Read in file name from config
   const std::string particle_list_file_name = config.take(filename_key);
  
   if (particles_.size() != 0) {
     throw std::runtime_error(
         "Your Particle List is already filled before reading in from the "
         "external file."
         "Something went wrong. Please check your config.");
   }
   /*
    * Counts number of nucleons in one nucleus as it is specialized
    * by the user in the config file.
    * It is needed to read in the proper number of nucleons for one
    * nucleus and to restart at the listreading for the following
    * nucleus as one does not want to read configurations twice.
    */
   std::map<PdgCode, int> particle_list = config.take(particles_key);
   for (const auto& particle : particle_list) {
     if (particle.first == pdg::p) {
       number_of_protons_ = particle.second * testparticles;
     } else if (particle.first == pdg::n) {
       number_of_neutrons_ = particle.second * testparticles;
     } else {
       throw std::runtime_error(
           "Your nucleus can only contain protons and/or neutrons."
           "Please check what particles you have specified in the config");
     }
     number_of_nucleons_ = number_of_protons_ + number_of_neutrons_;
   }
   /*
    * "if" statement makes sure the streams to the file are initialized
    * properly.
    */
   const std::string path =
       file_path(particle_list_file_directory, particle_list_file_name);
   if (same_file && !filestream_shared_) {
     filestream_shared_ = std::make_unique<std::ifstream>(path);
     used_filestream_ = &filestream_shared_;
   } else if (!same_file) {
     filestream_ = std::make_unique<std::ifstream>(path);
     used_filestream_ = &filestream_;
   } else {
     used_filestream_ = &filestream_shared_;
   }
  
   custom_nucleus_ = readfile(**used_filestream_);
   fill_from_list(custom_nucleus_);
   // Inherited from nucleus class (see nucleus.h)
   set_parameters_automatic();
 }

Member Function Documentation

◆ fill_from_list()

void smash::CustomNucleus::fill_from_list ( const std::vector< Nucleoncustom > & vec )

Fills Particlelist from vector containing data for one nucleus.

The data contains everything that is written in struct Nucleoncustom.

Parameters

[in] vec vector containing data from external list for one nucleus

Definition at line 94 of file customnucleus.cc.

                                                                       {
   particles_.clear();
   index_ = 0;
   // checking if particle is proton or neutron
   for (const auto& it : vec) {
     PdgCode pdgcode;
     if (it.isospin == 1) {
       pdgcode = pdg::p;
     } else if (it.isospin == 0) {
       pdgcode = pdg::n;
     } else {
       throw std::runtime_error(
           "Your particles charges are not 1 = proton or 0 = neutron.\n"
           "Check whether your list is correct or there is an error.");
     }
     // setting parameters for the particles in the particlelist in smash
     const ParticleType& current_type = ParticleType::find(pdgcode);
     double current_mass = current_type.mass();
     particles_.emplace_back(current_type);
     particles_.back().set_4momentum(current_mass, 0.0, 0.0, 0.0);
   }
 }

◆ distribute_nucleon()

ThreeVector smash::CustomNucleus::distribute_nucleon ( )

overridevirtual

Returns position of a nucleon as given in the external file.

Reimplemented from smash::Nucleus.

Definition at line 117 of file customnucleus.cc.

                                               {
   /*
    * As only arrange_nucleons is called at the beginning of every
    * event it is important to have readfile and fill from list
    * called again when a new event starts. The constructor is only
    * called twice to initialize the first target and projectile.
    * Therefore this if statement is implemented.
    */
   if (index_ >= custom_nucleus_.size()) {
     custom_nucleus_ = readfile(**used_filestream_);
     fill_from_list(custom_nucleus_);
   }
   const auto& pos = custom_nucleus_.at(index_);
   index_++;
   ThreeVector nucleon_position(pos.x, pos.y, pos.z);
   // rotate nucleon about euler angle
   nucleon_position.rotate(euler_phi_, euler_theta_, euler_psi_);
  
   return nucleon_position;
 }

◆ arrange_nucleons()

void smash::CustomNucleus::arrange_nucleons ( )

overridevirtual

Sets the positions of the nucleons inside a nucleus.

Reimplemented from smash::Nucleus.

Definition at line 138 of file customnucleus.cc.

                                      {
   /* Randomly generate Euler angles for rotation everytime a new
    * custom nucleus is initialized. Therefore this is done 2 times per
    * event.
    */
   Nucleus::random_euler_angles();
  
   for (auto i = begin(); i != end(); i++) {
     // Initialize momentum
     i->set_4momentum(i->pole_mass(), 0.0, 0.0, 0.0);
     /* Sampling the Woods-Saxon, get the radial
      * position and solid angle for the nucleon. */
     ThreeVector pos = distribute_nucleon();
     // Set the position of the nucleon.
     i->set_4position(FourVector(0.0, pos));
   }
   // Recenter
   align_center();
 }

◆ readfile()

std::vector< Nucleoncustom > smash::CustomNucleus::readfile ( std::ifstream & infile ) const

The returned vector contains Data for one nucleus given in the particlelist.

Parameters

[in] infile is needed to read in from the external file

Definition at line 175 of file customnucleus.cc.

                                {
   int proton_counter = 0;
   int neutron_counter = 0;
   std::string line;
   std::vector<Nucleoncustom> custom_nucleus;
   // read in only A particles for one nucleus
   for (int i = 0; i < number_of_nucleons_; ++i) {
     std::getline(infile, line);
     // make sure the stream goes back to the beginning when it hits end of file
     if (infile.eof()) {
       infile.clear();
       infile.seekg(0, infile.beg);
       std::getline(infile, line);
     }
     Nucleoncustom nucleon;
     std::istringstream iss(line);
     if (!(iss >> nucleon.x >> nucleon.y >> nucleon.z >>
           nucleon.spinprojection >> nucleon.isospin)) {
       throw std::runtime_error(
           "SMASH could not read in a line from your initial nuclei input file."
           "\nCheck if your file has the following format: x y z "
           "spinprojection isospin");
     }
     if (nucleon.isospin == 1) {
       proton_counter++;
     } else if (nucleon.isospin == 0) {
       neutron_counter++;
     }
     custom_nucleus.push_back(nucleon);
   }
   if (proton_counter != number_of_protons_ ||
       neutron_counter != number_of_neutrons_) {
     throw std::runtime_error(
         "Number of protons and/or neutrons in the nuclei input file does not "
         "correspond to the number specified in the config.\nCheck the config "
         "and your input file.");
   } else {
     return custom_nucleus;
   }
 }

◆ file_path()

std::string smash::CustomNucleus::file_path	(	const std::string &	file_directory,
		const std::string &	file_name
	)

Generates the name of the stream file.

Parameters

[in]	file_directory	is the path to the external file
[in]	file_name	is the name of the external file

Definition at line 166 of file customnucleus.cc.

                                                                  {
   if (file_directory.back() == '/') {
     return file_directory + file_name;
   } else {
     return file_directory + '/' + file_name;
   }
 }

◆ generate_fermi_momenta()

void smash::CustomNucleus::generate_fermi_momenta ( )

overridevirtual

Generates Fermi momenta as it is done in the mother class but in addition prints a warning that the Fermi momenta are generated accoriding to Woods-Saxon distributed nucleons.

Reimplemented from smash::Nucleus.

Definition at line 158 of file customnucleus.cc.

                                            {
   Nucleus::generate_fermi_momenta();
   logg[LCollider].warn() << "Fermi motion activated with a custom nucleus.\n";
   logg[LCollider].warn() << "Be aware that generating the Fermi momenta\n"
                          << "assumes nucleons distributed according to a\n"
                          << "Woods-Saxon distribution.";
 }

Member Data Documentation

◆ filestream_shared_

std::unique_ptr< std::ifstream > smash::CustomNucleus::filestream_shared_ = nullptr

staticprivate

Filestream variable used if projectile and target are read in from the same file and they use the same static stream.

Definition at line 98 of file customnucleus.h.

◆ filestream_

std::unique_ptr<std::ifstream> smash::CustomNucleus::filestream_

private

Filestream variable used if projectile and target are read in from different files and they therefore use different streams.

Definition at line 103 of file customnucleus.h.

◆ used_filestream_

std::unique_ptr<std::ifstream>* smash::CustomNucleus::used_filestream_

private

Pointer to the used filestream pointer.

Definition at line 105 of file customnucleus.h.

◆ number_of_nucleons_

int smash::CustomNucleus::number_of_nucleons_ = 0

private

Number of nucleons per nucleus Set initally to zero to be modified in the constructor.

Is obtained by adding the proton and neutron numbers specified in the config.yaml

Definition at line 112 of file customnucleus.h.

◆ number_of_protons_

int smash::CustomNucleus::number_of_protons_ = 0

private

Number of protons per nucleus.

Definition at line 114 of file customnucleus.h.

◆ number_of_neutrons_

int smash::CustomNucleus::number_of_neutrons_ = 0

private

Number of neutrons per nucleus.

Definition at line 116 of file customnucleus.h.

◆ custom_nucleus_

std::vector<Nucleoncustom> smash::CustomNucleus::custom_nucleus_

private

Vector contianing Data for one nucleus given in the particlelist.

Definition at line 118 of file customnucleus.h.

◆ index_

size_t smash::CustomNucleus::index_ = 0

private

Index needed to read out vector in distribute nucleon.

Definition at line 120 of file customnucleus.h.

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

src/include/smash/customnucleus.h
src/customnucleus.cc

Public Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ CustomNucleus()

Member Function Documentation

◆ fill_from_list()

◆ distribute_nucleon()

◆ arrange_nucleons()

◆ readfile()

◆ file_path()

◆ generate_fermi_momenta()

Member Data Documentation

◆ filestream_shared_

◆ filestream_

◆ used_filestream_

◆ number_of_nucleons_

◆ number_of_protons_

◆ number_of_neutrons_

◆ custom_nucleus_

◆ index_