Garfield++ 5.0
A toolkit for the detailed simulation of particle detectors based on ionisation measurement in gases and semiconductors
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
Garfield::TrackPAI Class Reference

Energy loss calculation using the Photoabsorption-Ionisation Model. More...

#include <TrackPAI.hh>

+ Inheritance diagram for Garfield::TrackPAI:

Classes

struct  Cluster
 

Public Member Functions

 TrackPAI ()
 
virtual ~TrackPAI ()
 
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 &xc, double &yc, double &zc, double &tc, int &nc, double &ec, double &extra) override
 
const std::vector< Cluster > & GetClusters () const
 
double GetClusterDensity () override
 
double GetStoppingPower () override
 Get the stopping power (mean energy loss [eV] per cm).
 
- 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 ( $\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.
 
void EnablePlotting (ViewDrift *viewer)
 Switch on plotting.
 
void DisablePlotting ()
 Switch off plotting.
 
void EnableDebugging ()
 Switch on debugging messages.
 
void DisableDebugging ()
 Switch off debugging messages.
 

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)
 
- 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
 

Detailed Description

Energy loss calculation using the Photoabsorption-Ionisation Model.

Definition at line 13 of file TrackPAI.hh.

Constructor & Destructor Documentation

◆ TrackPAI()

Garfield::TrackPAI::TrackPAI ( )

Definition at line 14 of file TrackPAI.cc.

14: Track("PAI") {}
Garfield::Track::Track
Track()=delete
Default constructor.

◆ ~TrackPAI()

virtual Garfield::TrackPAI::~TrackPAI ( )
inlinevirtual

Definition at line 23 of file TrackPAI.hh.

23{}

Member Function Documentation

◆ GetCluster()

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

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

Parameters
xc,yc,zccoordinates of the collision
tctime of the collision
ncnumber of electrons produced
ecdeposited energy
extraadditional information (not always implemented)

Implements Garfield::Track.

Definition at line 106 of file TrackPAI.cc.

107 {
108 nc = 0;
109 xc = yc = zc = tc = ec = extra = 0.;
110 if (m_clusters.empty() || m_cluster >= m_clusters.size()) return false;
111 const auto& cluster = m_clusters[m_cluster];
112 xc = cluster.x;
113 yc = cluster.y;
114 zc = cluster.z;
115 tc = cluster.t;
116 ec = cluster.energy;
117 nc = 1;
118
119 ++m_cluster;
120 return true;
121}

◆ GetClusterDensity()

double Garfield::TrackPAI::GetClusterDensity ( )
overridevirtual

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

Reimplemented from Garfield::Track.

Definition at line 233 of file TrackPAI.cc.

233 {
234 if (m_isChanged) {
235 if (SetupCrossSectionTable()) {
236 m_isChanged = false;
237 } else {
238 std::cerr << m_className << "::GetClusterDensity:\n";
239 std::cerr << " Ionisation cross-section could not be calculated.\n";
240 return 0.;
241 }
242 }
243 return 1. / m_imfp;
244}
Garfield::Track::m_isChanged
bool m_isChanged
Definition Track.hh:116
Garfield::Track::m_className
std::string m_className
Definition Track.hh:104

◆ GetClusters()

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

Definition at line 31 of file TrackPAI.hh.

31{ return m_clusters; }

◆ GetStoppingPower()

double Garfield::TrackPAI::GetStoppingPower ( )
overridevirtual

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

Reimplemented from Garfield::Track.

Definition at line 246 of file TrackPAI.cc.

246 {
247
248 if (m_isChanged) {
249 if (SetupCrossSectionTable()) {
250 m_isChanged = false;
251 } else {
252 std::cerr << m_className << "::GetStoppingPower:\n";
253 std::cerr << " Ionisation cross-section could not be calculated.\n";
254 return 0.;
255 }
256 }
257 return m_dedx;
258}

◆ NewTrack()

bool Garfield::TrackPAI::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 16 of file TrackPAI.cc.

18 {
19 m_clusters.clear();
20 m_cluster = 0;
21 // Make sure the sensor has been set.
22 if (!m_sensor) {
23 std::cerr << m_className << "::NewTrack: Sensor is not defined.\n";
24 return false;
25 }
26
27 // Make sure there is an "ionisable" medium at this location.
28 Medium* medium = m_sensor->GetMedium(x0, y0, z0);
29 if (!medium || !medium->IsIonisable()) {
30 std::cerr << m_className << "::NewTrack:\n"
31 << " No ionisable medium at initial position.\n";
32 return false;
33 }
34
35 if (medium->GetName() != m_mediumName ||
36 medium->GetNumberDensity() != m_mediumDensity) {
37 m_isChanged = true;
38 if (!SetupMedium(medium)) {
39 std::cerr << m_className << "::NewTrack:\n Properties of medium "
40 << medium->GetName() << " are not available.\n";
41 return false;
42 }
43 m_mediumName = medium->GetName();
44 m_mediumDensity = medium->GetNumberDensity();
45 }
46
47 if (m_isChanged) {
48 if (!SetupCrossSectionTable()) {
49 std::cerr << m_className << "::NewTrack:\n"
50 << " Calculation of ionisation cross-section failed.\n";
51 return false;
52 }
53 m_isChanged = false;
54 }
55
56 double x = x0;
57 double y = y0;
58 double z = z0;
59 double t = t0;
60 double dx = dx0;
61 double dy = dy0;
62 double dz = dz0;
63 const double d = sqrt(dx * dx + dy * dy + dz * dz);
64 if (d < Small) {
65 // Null vector. Choose a random direction.
66 RndmDirection(dx, dy, dz);
67 } else {
68 // Normalize the direction vector.
69 const double scale = 1. / d;
70 dx *= scale;
71 dy *= scale;
72 dz *= scale;
73 }
74 double ekin = GetKineticEnergy();
75 while (ekin > 0.) {
76 // Draw a step length and propagate the particle.
77 const double step = -m_imfp * log(RndmUniformPos());
78 x += step * dx;
79 y += step * dy;
80 z += step * dz;
81 t += step / m_speed;
82
83 medium = m_sensor->GetMedium(x, y, z);
84 if (!medium || !medium->IsIonisable() ||
85 medium->GetName() != m_mediumName ||
86 medium->GetNumberDensity() != m_mediumDensity) {
87 break;
88 }
89
90 // Sample the energy deposit.
91 std::pair<double, double> edep = SampleEnergyDeposit(RndmUniform());
92 // Update the particle energy.
93 ekin -= edep.first;
94
95 Cluster cluster;
96 cluster.x = x;
97 cluster.y = y;
98 cluster.z = z;
99 cluster.t = t;
100 cluster.energy = edep.first;
101 m_clusters.push_back(std::move(cluster));
102 }
103 return true;
104}
Garfield::Track::GetKineticEnergy
double GetKineticEnergy() const
Return the kinetic energy of the projectile.
Definition Track.hh:62
Garfield::Track::m_sensor
Sensor * m_sensor
Definition Track.hh:114
Garfield::RndmUniform
double RndmUniform()
Draw a random number uniformly distributed in the range [0, 1).
Definition Random.hh:14
Garfield::RndmDirection
void RndmDirection(double &dx, double &dy, double &dz, const double length=1.)
Draw a random (isotropic) direction vector.
Definition Random.hh:128
Garfield::RndmUniformPos
double RndmUniformPos()
Draw a random number uniformly distributed in the range (0, 1).
Definition Random.hh:17
Heed::sqrt
DoubleAc sqrt(const DoubleAc &f)
Definition DoubleAc.cpp:314
The documentation for this class was generated from the following files: