Abstract base class for track generation. More...

#include <Track.hh>

Inheritance diagram for Garfield::Track:

Public Member Functions
	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	PlotNewTrack (const double x0, const double y0, const double z0)

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

Protected Attributes
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

bool	m_usePlotting = false

ViewDrift *	m_viewer = nullptr

bool	m_debug = false

int	m_plotId = -1

Detailed Description

Abstract base class for track generation.

Definition at line 14 of file Track.hh.

Constructor & Destructor Documentation

◆ Track()

Garfield::Track::Track ( )

Constructor.

Definition at line 13 of file Track.cc.

13: m_mass(MuonMass) { SetBetaGamma(3.); }

Garfield::Track::SetBetaGamma

void SetBetaGamma(const double bg)

Set the relative momentum of the particle.

Definition: Track.cc:103

Garfield::Track::m_mass

double m_mass

Definition: Track.hh:106

◆ ~Track()

virtual Garfield::Track::~Track ( )

inlinevirtual

Destructor.

Definition at line 19 of file Track.hh.

19{}

Member Function Documentation

◆ DisableDebugging()

void Garfield::Track::DisableDebugging ( )

inline

Switch off debugging messages.

Definition at line 99 of file Track.hh.

99{ m_debug = false; }

Garfield::Track::m_debug

bool m_debug

Definition: Track.hh:119

◆ DisablePlotting()

void Garfield::Track::DisablePlotting ( )

Switch off plotting.

Definition at line 188 of file Track.cc.

                            {
  m_usePlotting = false;
  m_viewer = NULL;
}

◆ EnableDebugging()

void Garfield::Track::EnableDebugging ( )

inline

Switch on debugging messages.

Definition at line 97 of file Track.hh.

97{ m_debug = true; }

Referenced by GarfieldPhysics::InitializePhysics().

◆ EnablePlotting()

void Garfield::Track::EnablePlotting ( ViewDrift * viewer )

Switch on plotting.

Definition at line 177 of file Track.cc.

                                          {
  if (!view) {
    std::cerr << m_className << "::EnablePlotting:\n";
    std::cerr << "    Pointer is null.\n";
    return;
  }
 
  m_viewer = view;
  m_usePlotting = true;
}

◆ GetBeta()

double Garfield::Track::GetBeta ( ) const

inline

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

Definition at line 54 of file Track.hh.

54{ return sqrt(m_beta2); }

Garfield::Track::m_beta2

double m_beta2

Definition: Track.hh:108

Heed::sqrt

DoubleAc sqrt(const DoubleAc &f)

Definition: DoubleAc.cpp:314

Referenced by Garfield::TrackBichsel::NewTrack(), and Garfield::TrackHeed::NewTrack().

◆ GetBetaGamma()

double Garfield::Track::GetBetaGamma ( ) const

inline

Return the $\beta\gamma$ of the projectile.

Definition at line 52 of file Track.hh.

52{ return sqrt(m_beta2 / (1. - m_beta2)); }

Referenced by Garfield::TrackBichsel::GetClusterDensity(), Garfield::TrackBichsel::GetStoppingPower(), and Garfield::TrackBichsel::NewTrack().

◆ GetCharge()

double Garfield::Track::GetCharge ( ) const

inline

Get the charge of the projectile.

Definition at line 63 of file Track.hh.

63{ return m_q; }

Garfield::Track::m_q

double m_q

Definition: Track.hh:104

◆ GetCluster()

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

pure virtual

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)

Implemented in Garfield::TrackBichsel, Garfield::TrackSimple, Garfield::TrackHeed, Garfield::TrackSrim, Garfield::TrackElectron, and Garfield::TrackPAI.

◆ GetClusterDensity()

virtual double Garfield::Track::GetClusterDensity ( )

inlinevirtual

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

Reimplemented in Garfield::TrackBichsel, Garfield::TrackElectron, Garfield::TrackPAI, Garfield::TrackSimple, and Garfield::TrackHeed.

Definition at line 87 of file Track.hh.

87{ return 0.; }

◆ GetEnergy()

double Garfield::Track::GetEnergy ( ) const

inline

Return the particle energy.

Definition at line 50 of file Track.hh.

50{ return m_energy; }

Garfield::Track::m_energy

double m_energy

Definition: Track.hh:107

◆ GetGamma()

double Garfield::Track::GetGamma ( ) const

inline

Return the Lorentz factor of the projectile.

Definition at line 56 of file Track.hh.

56{ return sqrt(1. / (1. - m_beta2)); }

◆ GetKineticEnergy()

double Garfield::Track::GetKineticEnergy ( ) const

inline

Return the kinetic energy of the projectile.

Definition at line 60 of file Track.hh.

60{ return m_energy - m_mass; }

Referenced by Garfield::TrackSrim::NewTrack().

◆ GetMass()

double Garfield::Track::GetMass ( ) const

inline

Get the mass [eV / c2] of the projectile.

Definition at line 65 of file Track.hh.

65{ return m_mass; }

◆ GetMomentum()

double Garfield::Track::GetMomentum ( ) const

inline

Return the particle momentum.

Definition at line 58 of file Track.hh.

58{ return m_mass * sqrt(m_beta2 / (1. - m_beta2)); }

◆ GetStoppingPower()

virtual double Garfield::Track::GetStoppingPower ( )

inlinevirtual

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

Reimplemented in Garfield::TrackBichsel, Garfield::TrackElectron, Garfield::TrackPAI, Garfield::TrackSimple, and Garfield::TrackHeed.

Definition at line 89 of file Track.hh.

89{ return 0.; }

◆ NewTrack()

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

pure virtual

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

Implemented in Garfield::TrackBichsel, Garfield::TrackElectron, Garfield::TrackPAI, Garfield::TrackSimple, Garfield::TrackHeed, and Garfield::TrackSrim.

◆ PlotCluster()

void Garfield::Track::PlotCluster	(	const double	x0,
		const double	y0,
		const double	z0
	)

protected

Definition at line 199 of file Track.cc.

                                                                         {
  if (m_plotId < 0 || !m_usePlotting || !m_viewer) {
    std::cerr << m_className << "::PlotCluster:\n";
    std::cerr << "    No track set. Program bug!\n";
    return;
  }
  m_viewer->AddTrackPoint(m_plotId, x0, y0, z0);
}

Referenced by Garfield::TrackHeed::GetCluster().

◆ PlotNewTrack()

void Garfield::Track::PlotNewTrack	(	const double	x0,
		const double	y0,
		const double	z0
	)

protected

Definition at line 193 of file Track.cc.

                                                                          {
  if (!m_usePlotting || !m_viewer) return;
 
  m_viewer->NewChargedParticleTrack(1, m_plotId, x0, y0, z0);
}

Referenced by Garfield::TrackHeed::NewTrack().

◆ SetBeta()

void Garfield::Track::SetBeta ( const double beta )

Set the speed ( $\beta = v/c$ ) of the particle.

Definition at line 116 of file Track.cc.

                                     {
  if (beta <= 0. && beta >= 1.) {
    std::cerr << m_className << "::SetBeta:\n";
    std::cerr << "    Particle speed must be between zero"
              << " and speed of light.\n";
    return;
  }
 
  m_beta2 = beta * beta;
  m_energy = m_mass * sqrt(1. / (1. - m_beta2));
  m_isChanged = true;
}

◆ SetBetaGamma()

void Garfield::Track::SetBetaGamma ( const double bg )

Set the relative momentum of the particle.

Definition at line 103 of file Track.cc.

                                        {
  if (bg <= 0.) {
    std::cerr << m_className << "::SetBetaGamma:\n"
              << "    Particle speed must be greater than zero.\n";
    return;
  }
 
  const double bg2 = bg * bg;
  m_energy = m_mass * sqrt(1. + bg2);
  m_beta2 = bg2 / (1. + bg2);
  m_isChanged = true;
}

Referenced by Track(), and Garfield::TrackElectron::TrackElectron().

◆ SetEnergy()

void Garfield::Track::SetEnergy ( const double e )

Set the particle energy.

Definition at line 90 of file Track.cc.

                                    {
  if (e <= m_mass) {
    std::cerr << m_className << "::SetEnergy:\n"
              << "    Particle energy must be greater than the mass.\n";
    return;
  }
 
  m_energy = e;
  const double gamma = m_energy / m_mass;
  m_beta2 = 1. - 1. / (gamma * gamma);
  m_isChanged = true;
}

◆ SetGamma()

void Garfield::Track::SetGamma ( const double gamma )

Set the Lorentz factor of the particle.

Definition at line 129 of file Track.cc.

                                       {
  if (gamma <= 1.) {
    std::cerr << m_className << "::SetGamma:\n";
    std::cerr << "    Particle speed must be greater than zero.\n";
    return;
  }
 
  m_energy = m_mass * gamma;
  m_beta2 = 1. - 1. / (gamma * gamma);
  m_isChanged = true;
}

◆ SetKineticEnergy()

void Garfield::Track::SetKineticEnergy ( const double ekin )

Set the kinetic energy of the particle.

Definition at line 154 of file Track.cc.

                                              {
  if (ekin <= 0.) {
    std::cerr << m_className << "::SetKineticEnergy:\n";
    std::cerr << "    Kinetic energy must be greater than zero.\n";
    return;
  }
 
  m_energy = m_mass + ekin;
  const double gamma = 1. + ekin / m_mass;
  m_beta2 = 1. - 1. / (gamma * gamma);
  m_isChanged = true;
}

Referenced by GarfieldPhysics::DoIt().

◆ SetMomentum()

void Garfield::Track::SetMomentum ( const double p )

Set the particle momentum.

Definition at line 141 of file Track.cc.

                                      {
  if (p <= 0.) {
    std::cerr << m_className << "::SetMomentum:\n";
    std::cerr << "    Particle momentum must be greater than zero.\n";
    return;
  }
 
  m_energy = sqrt(m_mass * m_mass + p * p);
  const double bg = p / m_mass;
  m_beta2 = bg * bg / (1. + bg * bg);
  m_isChanged = true;
}

◆ SetParticle()

void Garfield::Track::SetParticle ( const std::string & part )

virtual

Set the type of charged particle.

electron,e-
positron,e+
muon,mu-
mu+
pion,pi-
pi+
kaon,K-
K+
proton,p
anti-proton,p-bar
deuteron,d
alpha

Reimplemented in Garfield::TrackElectron.

Definition at line 15 of file Track.cc.

                                             {
  std::string id = part;
  std::transform(id.begin(), id.end(), id.begin(), 
                 [](unsigned char c) -> unsigned char { 
                   return std::toupper(c);
                 });
  m_isElectron = false;
  if (id == "ELECTRON" || id == "E-") {
    m_q = -1;
    m_mass = ElectronMass;
    m_spin = 1;
    m_isElectron = true;
    m_particleName = "e-";
  } else if (id == "POSITRON" || id == "E+") {
    m_q = 1;
    m_mass = ElectronMass;
    m_spin = 1;
    m_particleName = "e+";
  } else if (id == "MUON" || id == "MU" || id == "MU-") {
    m_q = -1;
    m_mass = MuonMass;
    m_spin = 1;
    m_particleName = "mu-";
  } else if (id == "MU+") {
    m_q = 1;
    m_mass = MuonMass;
    m_spin = 1;
    m_particleName = "mu+";
  } else if (id == "PION" || id == "PI" || id == "PI-") {
    m_q = -1;
    m_mass = 139.57018e6;
    m_spin = 0;
    m_particleName = "pi-";
  } else if (id == "PI+") {
    m_q = 1;
    m_mass = 139.57018e6;
    m_spin = 0;
    m_particleName = "pi+";
  } else if (id == "KAON" || id == "K" || id == "K-") {
    m_q = -1;
    m_mass = 493.677e6;
    m_spin = 0;
    m_particleName = "K-";
  } else if (id == "K+") {
    m_q = 1;
    m_mass = 493.677e6;
    m_spin = 0;
    m_particleName = "K+";
  } else if (id == "PROTON" || id == "P") {
    m_q = 1;
    m_mass = ProtonMass;
    m_spin = 1;
    m_particleName = "p";
  } else if (id == "ANTI-PROTON" || id == "ANTIPROTON" || 
             id == "P-BAR" || id == "PBAR") {
    m_q = -1;
    m_mass = ProtonMass;
    m_spin = 1;
    m_particleName = "pbar";
  } else if (id == "DEUTERON" || id == "D") {
    m_q = 1;
    m_mass = 1875.612793e6;
    m_spin = 2;
    m_particleName = "d";
  } else if (id == "ALPHA") {
    m_q = 2;
    m_mass = 3.727379240e9;
    m_spin = 0;
    m_particleName = "alpha";
  } else {
    std::cerr << m_className << "::SetParticle:\n"
              << "    Particle " << part << " is not defined.\n";
  }
}

Referenced by GarfieldPhysics::DoIt().

◆ SetSensor()

void Garfield::Track::SetSensor ( Sensor * s )

Set the sensor through which to transport the particle.

Definition at line 167 of file Track.cc.

                               {
  if (!s) {
    std::cerr << m_className << "::SetSensor:\n";
    std::cerr << "    Sensor pointer is null.\n";
    return;
  }
 
  m_sensor = s;
}

Referenced by GarfieldPhysics::InitializePhysics().

Member Data Documentation

◆ m_beta2

double Garfield::Track::m_beta2

protected

Definition at line 108 of file Track.hh.

Referenced by GetBeta(), GetBetaGamma(), Garfield::TrackElectron::GetCluster(), GetGamma(), GetMomentum(), Garfield::TrackElectron::GetStoppingPower(), SetBeta(), SetBetaGamma(), SetEnergy(), SetGamma(), SetKineticEnergy(), and SetMomentum().

◆ m_className

std::string Garfield::Track::m_className = "Track"

protected

Definition at line 102 of file Track.hh.

◆ m_debug

bool Garfield::Track::m_debug = false

protected

Definition at line 119 of file Track.hh.

Referenced by DisableDebugging(), EnableDebugging(), Garfield::TrackSrim::EstimateRange(), Garfield::TrackBichsel::GetCluster(), Garfield::TrackSimple::GetCluster(), Garfield::TrackSrim::GetCluster(), Garfield::TrackPAI::GetCluster(), Garfield::TrackBichsel::GetClusterDensity(), Garfield::TrackBichsel::GetStoppingPower(), Garfield::TrackElectron::NewTrack(), Garfield::TrackPAI::NewTrack(), Garfield::TrackHeed::NewTrack(), Garfield::TrackSrim::NewTrack(), Garfield::TrackSrim::PreciseLoss(), Garfield::TrackSrim::ReadFile(), Garfield::TrackSrim::RndmEnergyLoss(), and Garfield::TrackSrim::SmallestStep().

◆ m_energy

double Garfield::Track::m_energy = 0.

protected

Definition at line 107 of file Track.hh.

Referenced by GetEnergy(), GetKineticEnergy(), Garfield::TrackSrim::NewTrack(), SetBeta(), SetBetaGamma(), SetEnergy(), SetGamma(), SetKineticEnergy(), and SetMomentum().

◆ m_isChanged

bool Garfield::Track::m_isChanged = true

protected

Definition at line 114 of file Track.hh.

Referenced by Garfield::TrackPAI::GetCluster(), Garfield::TrackBichsel::GetClusterDensity(), Garfield::TrackPAI::GetClusterDensity(), Garfield::TrackBichsel::GetStoppingPower(), Garfield::TrackPAI::GetStoppingPower(), Garfield::TrackBichsel::NewTrack(), Garfield::TrackPAI::NewTrack(), Garfield::TrackHeed::NewTrack(), SetBeta(), SetBetaGamma(), SetEnergy(), SetGamma(), SetKineticEnergy(), SetMomentum(), Garfield::TrackHeed::TransportDeltaElectron(), and Garfield::TrackHeed::TransportPhoton().

◆ m_isElectron

bool Garfield::Track::m_isElectron = false

protected

Definition at line 109 of file Track.hh.

Referenced by SetParticle(), Garfield::TrackHeed::SetParticleUser(), and Garfield::TrackElectron::TrackElectron().

◆ m_mass

double Garfield::Track::m_mass

protected

Definition at line 106 of file Track.hh.

Referenced by GetKineticEnergy(), GetMass(), GetMomentum(), Garfield::TrackHeed::NewTrack(), SetBeta(), SetBetaGamma(), SetEnergy(), SetGamma(), SetKineticEnergy(), SetMomentum(), SetParticle(), Garfield::TrackHeed::SetParticleUser(), and Garfield::TrackElectron::TrackElectron().

◆ m_particleName

std::string Garfield::Track::m_particleName = "mu-"

protected

Definition at line 110 of file Track.hh.

Referenced by Garfield::TrackHeed::NewTrack(), SetParticle(), Garfield::TrackHeed::SetParticleUser(), and Garfield::TrackElectron::TrackElectron().

◆ m_plotId

int Garfield::Track::m_plotId = -1

protected

Definition at line 121 of file Track.hh.

Referenced by PlotCluster(), and PlotNewTrack().

◆ m_q

double Garfield::Track::m_q = -1.

protected

Definition at line 104 of file Track.hh.

Referenced by GetCharge(), Garfield::TrackHeed::NewTrack(), SetParticle(), Garfield::TrackHeed::SetParticleUser(), and Garfield::TrackElectron::TrackElectron().

◆ m_sensor

Sensor* Garfield::Track::m_sensor = nullptr

protected

Definition at line 112 of file Track.hh.

Referenced by Garfield::TrackBichsel::GetCluster(), Garfield::TrackSimple::GetCluster(), Garfield::TrackElectron::GetCluster(), Garfield::TrackPAI::GetCluster(), Garfield::TrackBichsel::NewTrack(), Garfield::TrackElectron::NewTrack(), Garfield::TrackPAI::NewTrack(), Garfield::TrackSimple::NewTrack(), Garfield::TrackHeed::NewTrack(), Garfield::TrackSrim::NewTrack(), SetSensor(), Garfield::TrackHeed::TransportDeltaElectron(), and Garfield::TrackHeed::TransportPhoton().

◆ m_spin

int Garfield::Track::m_spin = 1

protected

Definition at line 105 of file Track.hh.

Referenced by SetParticle(), Garfield::TrackHeed::SetParticleUser(), and Garfield::TrackElectron::TrackElectron().

◆ m_usePlotting

bool Garfield::Track::m_usePlotting = false

protected

Definition at line 116 of file Track.hh.

Referenced by DisablePlotting(), EnablePlotting(), Garfield::TrackHeed::GetCluster(), Garfield::TrackHeed::NewTrack(), PlotCluster(), and PlotNewTrack().

◆ m_viewer

ViewDrift* Garfield::Track::m_viewer = nullptr

protected

Definition at line 117 of file Track.hh.

Referenced by DisablePlotting(), EnablePlotting(), PlotCluster(), and PlotNewTrack().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Track()

◆ ~Track()

Member Function Documentation

◆ DisableDebugging()

◆ DisablePlotting()

◆ EnableDebugging()

◆ EnablePlotting()

◆ GetBeta()

◆ GetBetaGamma()

◆ GetCharge()

◆ GetCluster()

◆ GetClusterDensity()

◆ GetEnergy()

◆ GetGamma()

◆ GetKineticEnergy()

◆ GetMass()

◆ GetMomentum()

◆ GetStoppingPower()

◆ NewTrack()

◆ PlotCluster()

◆ PlotNewTrack()

◆ SetBeta()

◆ SetBetaGamma()

◆ SetEnergy()

◆ SetGamma()

◆ SetKineticEnergy()

◆ SetMomentum()

◆ SetParticle()

◆ SetSensor()

Member Data Documentation

◆ m_beta2

◆ m_className

◆ m_debug

◆ m_energy

◆ m_isChanged

◆ m_isElectron

◆ m_mass

◆ m_particleName

◆ m_plotId

◆ m_q

◆ m_sensor

◆ m_spin

◆ m_usePlotting

◆ m_viewer