Garfield::TrackSimple Class Reference

Generate tracks based on a cluster density given by the user. More...

#include <TrackSimple.hh>

Inheritance diagram for Garfield::TrackSimple:

Classes
struct	Cluster

Public Member Functions
	TrackSimple ()
	Default constructor.
	TrackSimple (Sensor *sensor)
	Constructor.
virtual	~TrackSimple ()
	Destructor.
void	SetEqualSpacing ()
	Constant distance between clusters.
void	SetExponentialSpacing ()
	Exponentially distributed distance between clusters.
void	SetClusterDensity (const double d)
	Set the cluster density (inverse mean free path).
virtual double	GetClusterDensity ()
void	SetStoppingPower (const double dedx)
	Set the stopping power (dE/dx).
virtual double	GetStoppingPower ()
	Get the stopping power (mean energy loss [eV] per cm).
virtual bool	NewTrack (const double x0, const double y0, const double z0, const double t0, const double dx0, const double dy0, const double dz0)
virtual bool	GetCluster (double &xc, double &yc, double &zc, double &tc, int &ne, double &ec, double &extra)
const std::vector< Cluster > &	GetClusters () const
Public Member Functions inherited from Garfield::Track
	Track ()=delete
	Default constructor.
	Track (const std::string &name)
	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 ( ) 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 of the projectile.
double	GetBeta () const
	Return the speed ( ) 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.
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 Attributes
double	m_mfp = 0.04
double	m_eloss = 2530.
bool	m_useEqualSpacing = false
std::vector< Cluster >	m_clusters
size_t	m_cluster = 0
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 = 1.
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

Additional Inherited Members
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)
Static Protected Member Functions inherited from Garfield::Track
static std::array< double, 3 >	StepBfield (const double dt, const double qoverm, const double vmag, double bx, double by, double bz, std::array< double, 3 > &dir)

Detailed Description

Generate tracks based on a cluster density given by the user.

Definition at line 10 of file TrackSimple.hh.

Constructor & Destructor Documentation

TrackSimple() [1/2]

Garfield::TrackSimple::TrackSimple ( )

inline

Default constructor.

Definition at line 18 of file TrackSimple.hh.

: TrackSimple(nullptr) {}

Referenced by TrackSimple().

TrackSimple() [2/2]

Garfield::TrackSimple::TrackSimple

(

Sensor *

sensor

)

Constructor.

Definition at line 11 of file TrackSimple.cc.

                                       : Track("Simple") {
  m_sensor = sensor;
}

~TrackSimple()

virtual Garfield::TrackSimple::~TrackSimple ( )

inlinevirtual

Destructor.

Definition at line 22 of file TrackSimple.hh.

{}

Member Function Documentation

GetCluster()

bool Garfield::TrackSimple::GetCluster ( double & xc, double & yc, double & zc, double & tc, int & nc, double & ec, double & extra )

virtual

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

Parameters

xc,yc,zc	coordinates of the collision
tc	time of the collision
nc	number of electrons produced
ec	deposited energy
extra	additional information (not always implemented)

Implements Garfield::Track.

Definition at line 109 of file TrackSimple.cc.

                                                                 {
  xc = yc = zc = tc = ec = extra = 0.;
  ne = 0;
  if (m_clusters.empty() || m_cluster >= m_clusters.size()) return false;
  const auto& cluster = m_clusters[m_cluster];
  xc = cluster.x;
  yc = cluster.y;
  zc = cluster.z;
  tc = cluster.t;
  ec = cluster.energy;
  ne = 1; 
  ++m_cluster;
  return true;
}

GetClusterDensity()

double Garfield::TrackSimple::GetClusterDensity ( )

virtual

Get the cluster density (number of ionizing collisions per cm or inverse mean free path for ionization).

Reimplemented from Garfield::Track.

Definition at line 25 of file TrackSimple.cc.

{ return 1. / m_mfp; }

GetClusters()

const std::vector< Cluster > & Garfield::TrackSimple::GetClusters ( ) const

inline

Definition at line 41 of file TrackSimple.hh.

{ return m_clusters; }

GetStoppingPower()

double Garfield::TrackSimple::GetStoppingPower ( )

virtual

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

Reimplemented from Garfield::Track.

Definition at line 37 of file TrackSimple.cc.

{ return m_eloss; }

NewTrack()

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

virtual

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

Implements Garfield::Track.

Definition at line 39 of file TrackSimple.cc.

                                             {
 
  m_clusters.clear();
  m_cluster = 0;
  // Make sure the sensor is defined.
  if (!m_sensor) {
    std::cerr << m_className << "::NewTrack: Sensor is not defined.\n";
    return false;
  }
 
  // Make sure we are inside a medium.
  Medium* medium = m_sensor->GetMedium(x0, y0, z0);
  if (!medium) {
    std::cerr << m_className << "::NewTrack: No medium at initial position.\n";
    return false;
  }
 
  double x = x0;
  double y = y0;
  double z = z0;
  double t = t0;
 
  // Normalise the direction.
  double dx = dx0;
  double dy = dy0;
  double dz = dz0;
  const double d = sqrt(dx * dx + dy * dy + dz * dz);
  if (d < Small) {
    // Choose a random direction.
    RndmDirection(dx, dy, dz);
  } else {
    const double scale = 1. / d;
    dx *= scale;
    dy *= scale;
    dz *= scale;
  }
  bool ok = true;
  while (ok) {
    if (m_useEqualSpacing) {
      x += dx * m_mfp;
      y += dy * m_mfp;
      z += dz * m_mfp;
    } else {
      const double step = -m_mfp * log(RndmUniformPos());
      x += dx * step;
      y += dy * step;
      z += dz * step;
    }
 
    medium = m_sensor->GetMedium(x, y, z);
    if (!medium) {
      if (m_debug) {
        std::cout << m_className << "::NewTrack: Particle left the medium.\n";
      }
      break;
    }
    Cluster cluster;
    cluster.x = x;
    cluster.y = y;
    cluster.z = z;
    cluster.t = t;
    cluster.energy = m_eloss * m_mfp;
    m_clusters.push_back(std::move(cluster));
  }
  m_cluster = 0;
  return true;
}

SetClusterDensity()

void Garfield::TrackSimple::SetClusterDensity

(

const double

d

)

Set the cluster density (inverse mean free path).

Definition at line 15 of file TrackSimple.cc.

                                                  {
  if (d < Small) {
    std::cerr << m_className << "::SetClusterDensity:\n"
              << "    Cluster density (number of clusters per cm)"
              << " must be positive.\n";
    return;
  }
  m_mfp = 1. / d;
}

SetEqualSpacing()

void Garfield::TrackSimple::SetEqualSpacing ( )

inline

Constant distance between clusters.

Definition at line 25 of file TrackSimple.hh.

{ m_useEqualSpacing = true; }

SetExponentialSpacing()

void Garfield::TrackSimple::SetExponentialSpacing ( )

inline

Exponentially distributed distance between clusters.

Definition at line 27 of file TrackSimple.hh.

{ m_useEqualSpacing = false; }

SetStoppingPower()

void Garfield::TrackSimple::SetStoppingPower

(

const double

dedx

)

Set the stopping power (dE/dx).

Definition at line 27 of file TrackSimple.cc.

                                                    {
  if (dedx < Small) {
    std::cerr << m_className << "::SetStoppingPower:\n"
              << "    Stopping power (average energy loss [eV] per cm)"
              << " must be positive.\n";
    return;
  }
  m_eloss = dedx;
}

Member Data Documentation

m_cluster

size_t Garfield::TrackSimple::m_cluster = 0

protected

Definition at line 52 of file TrackSimple.hh.

Referenced by GetCluster(), and NewTrack().

m_clusters

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

protected

Definition at line 51 of file TrackSimple.hh.

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

m_eloss

double Garfield::TrackSimple::m_eloss = 2530.

protected

Definition at line 47 of file TrackSimple.hh.

Referenced by GetStoppingPower(), NewTrack(), and SetStoppingPower().

m_mfp

double Garfield::TrackSimple::m_mfp = 0.04

protected

Definition at line 45 of file TrackSimple.hh.

Referenced by GetClusterDensity(), NewTrack(), and SetClusterDensity().

m_useEqualSpacing

bool Garfield::TrackSimple::m_useEqualSpacing = false

protected

Definition at line 49 of file TrackSimple.hh.

Referenced by NewTrack(), SetEqualSpacing(), and SetExponentialSpacing().

---

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

• TrackSimple.hh
• TrackSimple.cc