#include <TrackTrim.hh>

Inheritance diagram for Garfield::TrackTrim:

Classes
struct	Cluster

Public Member Functions
	TrackTrim ()
	Constructor.

virtual	~TrackTrim ()
	Destructor.

bool	ReadFile (const std::string &file, const unsigned int nIons=0, const unsigned int nSkip=0)
	Load data from an EXYZ.txt file.

void	Print ()
	Print a summary of the available TRIM data.

void	SetWorkFunction (const double w)
	Set the W value [eV].

double	GetWorkFunction () const
	Get the W value [eV].

void	SetFanoFactor (const double f)
	Set the Fano factor.

double	GetFanoFactor () const
	Get the Fano factor.

bool	NewTrack (const double x0, const double y0, const double z0, const double t0, const double dx0, const double dy0, const double dz0) override

bool	GetCluster (double &xcls, double &ycls, double &zcls, double &tcls, int &n, double &e, double &extra) override

Public Member Functions inherited from Garfield::Track
	Track ()
	Constructor.

virtual	~Track ()
	Destructor.

virtual void	SetParticle (const std::string &part)

void	SetEnergy (const double e)
	Set the particle energy.

void	SetBetaGamma (const double bg)
	Set the relative momentum of the particle.

void	SetBeta (const double beta)
	Set the speed ( $\beta = v/c$ ) of the particle.

void	SetGamma (const double gamma)
	Set the Lorentz factor of the particle.

void	SetMomentum (const double p)
	Set the particle momentum.

void	SetKineticEnergy (const double ekin)
	Set the kinetic energy of the particle.

double	GetEnergy () const
	Return the particle energy.

double	GetBetaGamma () const
	Return the $\beta\gamma$ of the projectile.

double	GetBeta () const
	Return the speed ( $\beta = v/c$ ) of the projectile.

double	GetGamma () const
	Return the Lorentz factor of the projectile.

double	GetMomentum () const
	Return the particle momentum.

double	GetKineticEnergy () const
	Return the kinetic energy of the projectile.

double	GetCharge () const
	Get the charge of the projectile.

double	GetMass () const
	Get the mass [eV / c2] of the projectile.

void	SetSensor (Sensor *s)
	Set the sensor through which to transport the particle.

virtual bool	NewTrack (const double x0, const double y0, const double z0, const double t0, const double dx0, const double dy0, const double dz0)=0

virtual bool	GetCluster (double &xcls, double &ycls, double &zcls, double &tcls, int &n, double &e, double &extra)=0

virtual double	GetClusterDensity ()

virtual double	GetStoppingPower ()
	Get the stopping power (mean energy loss [eV] per cm).

void	EnablePlotting (ViewDrift *viewer)
	Switch on plotting.

void	DisablePlotting ()
	Switch off plotting.

void	EnableDebugging ()
	Switch on debugging messages.

void	DisableDebugging ()
	Switch off debugging messages.

Protected Member Functions
void	AddIon (const std::vector< float > &x, const std::vector< float > &y, const std::vector< float > &z, const std::vector< float > &dedx, const std::vector< float > &ekin)

Protected Member Functions inherited from Garfield::Track
void	PlotNewTrack (const double x0, const double y0, const double z0)

void	PlotCluster (const double x0, const double y0, const double z0)

Protected Attributes
double	m_work = -1.
	Work function [eV].

double	m_fano = -1.
	Fano factor [-].

double	m_ekin = 0.
	Projectile energy [eV].

std::vector< std::vector< std::array< float, 5 > > >	m_ions
	List of tracks.

size_t	m_ion = 0
	Index of the current track.

std::vector< Cluster >	m_clusters
	Clusters on the current track.

size_t	m_cluster = 0
	Index of the next cluster to be returned.

Protected Attributes inherited from Garfield::Track
std::string	m_className = "Track"

double	m_q = -1.

int	m_spin = 1

double	m_mass

double	m_energy = 0.

double	m_beta2

bool	m_isElectron = false

std::string	m_particleName = "mu-"

Sensor *	m_sensor = nullptr

bool	m_isChanged = true

ViewDrift *	m_viewer = nullptr

bool	m_debug = false

size_t	m_plotId = 0

Detailed Description

Generate tracks based on TRIM output files.

http://www.srim.org

Definition at line 14 of file TrackTrim.hh.

Constructor & Destructor Documentation

◆ TrackTrim()

Garfield::TrackTrim::TrackTrim ( )

Constructor.

Definition at line 28 of file TrackTrim.cc.

28: Track() { m_className = "TrackTrim"; }

Garfield::Track::m_className

std::string m_className

Definition: Track.hh:102

Garfield::Track::Track

Track()

Constructor.

Definition: Track.cc:13

◆ ~TrackTrim()

virtual Garfield::TrackTrim::~TrackTrim ( )

inlinevirtual

Destructor.

Definition at line 19 of file TrackTrim.hh.

19{}

Member Function Documentation

◆ AddIon()

void Garfield::TrackTrim::AddIon	(	const std::vector< float > &	x,
		const std::vector< float > &	y,
		const std::vector< float > &	z,
		const std::vector< float > &	dedx,
		const std::vector< float > &	ekin
	)

protected

Definition at line 117 of file TrackTrim.cc.

                                                     {
 
  const size_t nPoints = x.size();
  if (nPoints < 2) return;
  std::vector<std::array<float, 5> > path;
  for (size_t i = 0; i < nPoints; ++i) {
    float eloss = 0.;
    if (i < nPoints - 1) {
      const float dx = x[i + 1] - x[i];
      const float dy = y[i + 1] - y[i];
      const float dz = z[i + 1] - z[i];
      const float step = sqrt(dx * dx + dy * dy + dz * dz);
      if (i == 0 && dedx[i] > 10. * dedx[i + 1]) {
        eloss = step * dedx[i + 1];
      } else { 
        eloss = step * dedx[i];
      }
      const float dekin = ekin[i] - ekin[i + 1];
      if (dekin > 0.) eloss = std::min(eloss, dekin); 
    }
    path.push_back({x[i], y[i], z[i], eloss, ekin[i]});
  }
  m_ions.push_back(path);
}

Referenced by ReadFile().

◆ GetCluster()

bool Garfield::TrackTrim::GetCluster	(	double &	xcls,
		double &	ycls,
		double &	zcls,
		double &	tcls,
		int &	n,
		double &	e,
		double &	extra
	)

overridevirtual

Get the next "cluster" (ionising collision of the charged particle).

Parameters

xcls,ycls,zcls	coordinates of the collision
tcls	time of the collision
n	number of electrons produced
e	deposited energy
extra	additional information (not always implemented)

Implements Garfield::Track.

Definition at line 272 of file TrackTrim.cc.

                                                                           {
  if (m_debug) {
    std::cout << m_className << "::GetCluster: Cluster " << m_cluster
              << " of " << m_clusters.size() << "\n";
  }
  // Stop if we have exhausted the list of clusters.
  if (m_cluster >= m_clusters.size()) return false;
 
  const auto& cluster = m_clusters[m_cluster];
  xcls = cluster.x;
  ycls = cluster.y;
  zcls = cluster.z;
  tcls = cluster.t;
 
  n = cluster.electrons;
  e = cluster.ec;
  extra = cluster.ekin;
  // Move to the next cluster.
  ++m_cluster;
  return true;
}

◆ GetFanoFactor()

double Garfield::TrackTrim::GetFanoFactor ( ) const

inline

Get the Fano factor.

Definition at line 34 of file TrackTrim.hh.

34{ return m_fano; }

Garfield::TrackTrim::m_fano

double m_fano

Fano factor [-].

Definition: TrackTrim.hh:46

◆ GetWorkFunction()

double Garfield::TrackTrim::GetWorkFunction ( ) const

inline

Get the W value [eV].

Definition at line 30 of file TrackTrim.hh.

30{ return m_work; }

Garfield::TrackTrim::m_work

double m_work

Work function [eV].

Definition: TrackTrim.hh:44

◆ NewTrack()

bool Garfield::TrackTrim::NewTrack	(	const double	x0,
		const double	y0,
		const double	z0,
		const double	t0,
		const double	dx0,
		const double	dy0,
		const double	dz0
	)

overridevirtual

Calculate a new track starting from (x0, y0, z0) at time t0 in direction (dx0, dy0, dz0).

Implements Garfield::Track.

Definition at line 159 of file TrackTrim.cc.

                                                                           {
 
  // TRMGEN - Generates TRIM clusters
 
  if (m_ions.empty()) {
    std::cerr << m_className << "::NewTrack: No TRIM data present.\n";
    return false;
  }
 
  if (m_ion >= m_ions.size()) {
    // Rewind.
    std::cout << m_className << "::NewTrack: Rewinding.\n";
    m_ion = 0;
  }
 
  // Verify that a sensor has been set.
  if (!m_sensor) {
    std::cerr << m_className << "::NewTrack: Sensor is not defined.\n";
    return false;
  }
 
  // Normalise and store the direction.
  const double d0 = sqrt(dx0 * dx0 + dy0 * dy0 + dz0 * dz0);
  double dx = dx0;
  double dy = dy0;
  double dz = dz0;
  if (d0 < Small) {
    if (m_debug) {
      std::cout << m_className << "::NewTrack: Randomizing initial direction.\n";
    }
    // Null vector. Sample the direction isotropically.
    RndmDirection(dx, dy, dz);
  } else {
    // Normalise the direction vector.
    dx /= d0;
    dy /= d0;
    dz /= d0;
  }
  const double dt = sqrt(dx * dx + dy * dy);
  double phi = 0.;
  double theta = 0.; 
  if (dt > 0.) {
    phi = atan2(dy, dx);
    theta = atan2(dz, dt);
  } else {
    theta = dz < 0. ? -HalfPi : HalfPi;
  }
  const double ctheta = cos(theta);
  const double stheta = sin(theta);
  const double cphi = cos(phi);
  const double sphi = sin(phi);
 
  // Make sure all necessary parameters have been set.
  if (m_work < Small) {
    std::cerr << m_className << "::NewTrack: Work function not set.\n";
    return false;
  }
 
  // Plot.
  if (m_viewer) PlotNewTrack(x0, y0, z0);
 
  // Reset the cluster count.
  m_cluster = 0;
  m_clusters.clear();
 
  // Pool of unused energy
  double epool = 0.0;
 
  const auto& path = m_ions[m_ion];
  const size_t nPoints = path.size();
  for (size_t i = 1; i < nPoints; ++i) {
    const double x = path[i][0];
    const double y = path[i][1];
    const double z = path[i][2];
    Cluster cluster;
    cluster.x = x0 + cphi * ctheta * x - sphi * y - cphi * stheta * z;
    cluster.y = y0 + sphi * ctheta * x + cphi * y - sphi * stheta * z;
    cluster.z = z0 + stheta * x + ctheta * z;
    // Is this point inside an ionisable medium?
    Medium* medium = nullptr;
    if (!m_sensor->GetMedium(cluster.x, cluster.y, cluster.z, medium)) {
      continue;
    } 
    if (!medium || !medium->IsIonisable()) continue;
    cluster.t = t0;
    double eloss = path[i - 1][3];
    if (m_fano < Small) {
      // No fluctuations.
      cluster.electrons = int((eloss + epool) / m_work);
      cluster.ec = m_work * cluster.electrons;
    } else {
      double ec = eloss + epool;
      cluster.electrons = 0;
      cluster.ec = 0.0;
      while (true) {
        const double er = RndmHeedWF(m_work, m_fano);
        if (er > ec) break;
        cluster.electrons++;
        cluster.ec += er;
        ec -= er;
      }
    }
    cluster.ekin = path[i][4];
    epool += eloss - cluster.ec;
    m_clusters.push_back(std::move(cluster));
    if (m_viewer) PlotCluster(cluster.x, cluster.y, cluster.z);
  }
  // Move to the next ion in the list.
  ++m_ion;
  return true;
}

◆ Print()

void Garfield::TrackTrim::Print ( )

Print a summary of the available TRIM data.

Definition at line 146 of file TrackTrim.cc.

                      {
  std::cout << m_className << "::Print:\n";
  if (m_ions.empty()) {
    std::cerr << "    No TRIM data present.\n";
    return;
  }
  std::cout << "    Projectile: " << m_particleName << ", "
            << m_ekin * 1.e-3 << " keV\n"
            << "    Number of tracks: " << m_ions.size() << "\n"
            << "    Work function: " << m_work << " eV\n"
            << "    Fano factor: " << m_fano << "\n";
}

◆ ReadFile()

bool Garfield::TrackTrim::ReadFile	(	const std::string &	file,
		const unsigned int	nIons = `0`,
		const unsigned int	nSkip = `0`
	)

Load data from an EXYZ.txt file.

Definition at line 30 of file TrackTrim.cc.

                                                                             {
 
  // TRMREE - Reads the TRIM EXYZ file.
 
  // Reset.
  m_ions.clear();
  m_ion = 0;
  m_clusters.clear();
  m_cluster = 0;
 
  std::ifstream infile;
  infile.open(filename.c_str(), std::ios::in);
  if (infile.fail()) {
    std::cerr << m_className << "::ReadFile:\n"
              << "    Unable to open the EXYZ file (" << filename << ").\n";
    return false;
  }
 
  constexpr double Angstrom = 1.e-8;
  unsigned int nRead = 0;
  unsigned int ionNumber = 0;
  bool header = true;
  std::vector<float> x;
  std::vector<float> y;
  std::vector<float> z;
  std::vector<float> dedx;
  std::vector<float> ekin;
  for (std::string line; std::getline(infile, line);) {
    if (line.find("------- ") != std::string::npos) {
      // Reached the end of the header.
      header = false;
      continue;
    } else if (header) {
      if (line.find("Ion Data: ") != std::string::npos) {
        // Read the next line.
        std::getline(infile, line);
        auto words = tokenize(line);
        if (words.size() >= 3) {
          m_particleName = words[0];
          auto pos = words[2].find("keV");
          if (pos != std::string::npos) {
            m_ekin = 1.e3 * std::stod(words[2].substr(0, pos));
          }
        } 
      } 
      // Otherwise, skip the header.
      continue;
    } 
    auto words = tokenize(line);
    if (words.size() < 6) {
      std::cerr << m_className << "::ReadFile: Unexpected line:\n"
                << line << "\n";
      continue;
    }
    if (ionNumber != std::stoul(words[0])) {
      // New ion.
      if (ionNumber > 0) {
        if (nRead >= nSkip) AddIon(x, y, z, dedx, ekin);
        x.clear();
        y.clear();
        z.clear();
        dedx.clear(); 
        ekin.clear();
        ++nRead;
        // Stop if we are done reading the requested number of ions.
        if (nIons > 0 && m_ions.size() >= nIons) break;
      }
      ionNumber = std::stoi(words[0]);
    }
    if (nRead < nSkip) continue;
    // Convert coordinates to cm.
    x.push_back(std::stof(words[2]) * Angstrom);
    y.push_back(std::stof(words[3]) * Angstrom);
    z.push_back(std::stof(words[4]) * Angstrom);
    // Convert stopping power from eV/A to eV/cm.
    dedx.push_back(std::stof(words[5]) / Angstrom);
    // Convert ion energy from keV to eV.
    ekin.push_back(std::stof(words[1]) * 1.e3);
  }
  infile.close();
  AddIon(x, y, z, dedx, ekin);
  std::cout << m_className << "::ReadFile: Read energy vs position for " 
            << m_ions.size() << " ions.\n";
  return true;
}

◆ SetFanoFactor()

void Garfield::TrackTrim::SetFanoFactor ( const double f )

inline

Set the Fano factor.

Definition at line 32 of file TrackTrim.hh.

32{ m_fano = f; }

◆ SetWorkFunction()

void Garfield::TrackTrim::SetWorkFunction ( const double w )

inline

Set the W value [eV].

Definition at line 28 of file TrackTrim.hh.

28{ m_work = w; }

Member Data Documentation

◆ m_cluster

size_t Garfield::TrackTrim::m_cluster = 0

protected

Index of the next cluster to be returned.

Definition at line 64 of file TrackTrim.hh.

Referenced by GetCluster(), NewTrack(), and ReadFile().

◆ m_clusters

std::vector<Cluster> Garfield::TrackTrim::m_clusters

protected

Clusters on the current track.

Definition at line 62 of file TrackTrim.hh.

Referenced by GetCluster(), NewTrack(), and ReadFile().

◆ m_ekin

double Garfield::TrackTrim::m_ekin = 0.

protected

Projectile energy [eV].

Definition at line 49 of file TrackTrim.hh.

Referenced by Print(), and ReadFile().

◆ m_fano

double Garfield::TrackTrim::m_fano = -1.

protected

Fano factor [-].

Definition at line 46 of file TrackTrim.hh.

Referenced by GetFanoFactor(), NewTrack(), Print(), and SetFanoFactor().

◆ m_ion

size_t Garfield::TrackTrim::m_ion = 0

protected

Index of the current track.

Definition at line 53 of file TrackTrim.hh.

Referenced by NewTrack(), and ReadFile().

◆ m_ions

std::vector<std::vector<std::array<float, 5> > > Garfield::TrackTrim::m_ions

protected

List of tracks.

Definition at line 51 of file TrackTrim.hh.

Referenced by AddIon(), NewTrack(), Print(), and ReadFile().

◆ m_work

double Garfield::TrackTrim::m_work = -1.

protected

Work function [eV].

Definition at line 44 of file TrackTrim.hh.

Referenced by GetWorkFunction(), NewTrack(), Print(), and SetWorkFunction().

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

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TrackTrim()

◆ ~TrackTrim()

Member Function Documentation

◆ AddIon()

◆ GetCluster()

◆ GetFanoFactor()

◆ GetWorkFunction()

◆ NewTrack()

◆ Print()

◆ ReadFile()

◆ SetFanoFactor()

◆ SetWorkFunction()

Member Data Documentation

◆ m_cluster

◆ m_clusters

◆ m_ekin

◆ m_fano

◆ m_ion

◆ m_ions

◆ m_work