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

#include <TrackPAI.hh>

Inheritance diagram for Garfield::TrackPAI:

Public Member Functions
	TrackPAI ()

virtual	~TrackPAI ()

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 &xcls, double &ycls, double &zcls, double &tcls, int &ncls, double &ecls, double &extra)

virtual double	GetClusterDensity ()

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

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

virtual	~Track ()
	Destructor.

virtual void	SetParticle (const std::string &part)
	Set the type of particle.

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

double	GetBetaGamma () const

double	GetBeta () const

double	GetGamma () const

double	GetMomentum () const

double	GetKineticEnergy () const

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

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

void	SetSensor (Sensor *s)

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)

void	DisablePlotting ()

void	EnableDebugging ()

void	DisableDebugging ()

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)

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

double	m_q

int	m_spin

double	m_mass

double	m_energy

double	m_beta2

bool	m_isElectron

std::string	m_particleName

Sensor *	m_sensor

bool	m_isChanged

bool	m_usePlotting

ViewDrift *	m_viewer

bool	m_debug

int	m_plotId

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 13 of file TrackPAI.cc.

    : m_ready(false),
      m_x(0.),
      m_y(0.),
      m_z(0.),
      m_t(0.),
      m_dx(0.),
      m_dy(0),
      m_dz(1.),
      m_e(0.),
      m_speed(0.),
      m_emax(0.),
      m_imfp(0.),
      m_dedx(0.),
      m_nSteps(1000),
      m_mediumName(""),
      m_mediumDensity(0.),
      m_electronDensity(0.) {
 
  m_className = "TrackPAI";
 
}

◆ ~TrackPAI()

virtual Garfield::TrackPAI::~TrackPAI ( )

inlinevirtual

Definition at line 19 of file TrackPAI.hh.

19{}

Member Function Documentation

◆ GetCluster()

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

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)

Implements Garfield::Track.

Definition at line 105 of file TrackPAI.cc.

                                         {
 
  ncls = 0;
  edep = extra = 0.;
 
  // Clear the stack.
  m_electrons.clear();
  m_holes.clear();
 
  if (!m_ready) {
    std::cerr << m_className << "::GetCluster:\n";
    std::cerr << "    Track not initialized. Call NewTrack first.\n";
    return false;
  }
 
  if (m_isChanged) {
    if (SetupCrossSectionTable()) {
      m_isChanged = false;
    } else {
      std::cerr << m_className << "::GetCluster:\n";
      std::cerr << "    Calculation of ionisation cross-section failed.\n";
      return false;
    }
  }
 
  // Draw a step length and propagate the particle.
  const double d = -m_imfp * log(RndmUniformPos());
  m_x += d * m_dx;
  m_y += d * m_dy;
  m_z += d * m_dz;
  m_t += d / m_speed;
 
  // Check the medium at this location.
  Medium* medium = NULL;
  if (!m_sensor->GetMedium(m_x, m_y, m_z, medium)) {
    m_ready = false;
    return false;
  }
  if (medium->GetName() != m_mediumName ||
      medium->GetNumberDensity() != m_mediumDensity || !medium->IsIonisable()) {
    m_ready = false;
    return false;
  }
 
  // Check if the particle is still inside the drift area.
  if (!m_sensor->IsInArea(m_x, m_y, m_z)) {
    m_ready = false;
    return false;
  }
 
  xcls = m_x;
  ycls = m_y;
  zcls = m_z;
  tcls = m_t;
 
  // Sample the energy deposition.
  double f = 0.;
  edep = SampleEnergyDeposit(RndmUniform(), f);
  // Update the particle energy.
  m_e -= edep;
 
  // Number of electron/hole (or electron/ion pairs) produced.
  ncls = 1;
 
  if (m_debug) {
    std::cout << m_className << "::GetCluster:\n";
    std::cout << "   Fraction of Rutherford scattering: " << f << "\n";
  }
  return true;
}

◆ GetClusterDensity()

double Garfield::TrackPAI::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 300 of file TrackPAI.cc.

                                   {
 
  if (!m_ready) {
    std::cerr << m_className << "::GetClusterDensity:\n";
    std::cerr << "    Track has not been initialized.\n";
    return 0.;
  }
 
  if (m_isChanged) {
    if (SetupCrossSectionTable()) {
      m_isChanged = false;
    } else {
      std::cerr << m_className << "::GetClusterDensity:\n";
      std::cerr << "    Ionisation cross-section could not be calculated.\n";
      return 0.;
    }
  }
 
  return 1. / m_imfp;
}

◆ GetStoppingPower()

double Garfield::TrackPAI::GetStoppingPower ( )

virtual

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

Reimplemented from Garfield::Track.

Definition at line 321 of file TrackPAI.cc.

                                  {
 
  if (!m_ready) {
    std::cerr << m_className << "::GetStoppingPower:\n";
    std::cerr << "    Track has not been initialised.\n";
    return 0.;
  }
 
  if (m_isChanged) {
    if (SetupCrossSectionTable()) {
      m_isChanged = false;
    } else {
      std::cerr << m_className << "::GetStoppingPower:\n";
      std::cerr << "    Ionisation cross-section could not be calculated.\n";
      return 0.;
    }
  }
 
  return m_dedx;
}

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

virtual

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

Implements Garfield::Track.

Definition at line 36 of file TrackPAI.cc.

                                          {
 
  m_ready = false;
 
  // Make sure the sensor has been set.
  if (!m_sensor) {
    std::cerr << m_className << "::NewTrack: Sensor is not defined.\n";
    return false;
  }
 
  // Get the medium at this location and check if it is "ionisable".
  Medium* medium = NULL;
  if (!m_sensor->GetMedium(x0, y0, z0, medium)) {
    std::cerr << m_className << "::NewTrack: No medium at initial position.\n";
    return false;
  }
  if (!medium->IsIonisable()) {
    std::cerr << m_className << "::NewTrack:\n"
              << "    Medium at initial position is not ionisable.\n";
    return false;
  }
 
  if (medium->GetName() != m_mediumName ||
      medium->GetNumberDensity() != m_mediumDensity) {
    m_isChanged = true;
    if (!SetupMedium(medium)) {
      std::cerr << m_className << "::NewTrack:\n    Properties of medium "
                << medium->GetName() << " are not available.\n";
      return false;
    }
    m_mediumName = medium->GetName();
    m_mediumDensity = medium->GetNumberDensity();
  }
 
  m_ready = true;
 
  if (m_isChanged) {
    if (!SetupCrossSectionTable()) {
      std::cerr << m_className << "::NewTrack:\n"
                << "    Calculation of ionisation cross-section failed.\n";
      m_ready = false;
      return false;
    }
    m_isChanged = false;
  }
 
  m_x = x0;
  m_y = y0;
  m_z = z0;
  m_t = t0;
  const double d = sqrt(dx0 * dx0 + dy0 * dy0 + dz0 * dz0);
  if (d < Small) {
    if (m_debug) {
      std::cout << m_className << "::NewTrack:\n"
                << "    Direction vector has zero norm.\n"
                << "    Initial direction is randomized.\n";
    }
    RndmDirection(m_dx, m_dy, m_dz);
  } else {
    // Normalize the direction vector.
    m_dx = dx0 / d;
    m_dy = dy0 / d;
    m_dz = dz0 / d;
  }
  return true;
}

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TrackPAI()

◆ ~TrackPAI()

Member Function Documentation

◆ GetCluster()

◆ GetClusterDensity()

◆ GetStoppingPower()

◆ NewTrack()