Garfield::TrackElectron Class Reference

#include <TrackElectron.hh>

Inheritance diagram for Garfield::TrackElectron:

Public Member Functions
	TrackElectron ()
	~TrackElectron ()
void	SetParticle (std::string particle)
bool	NewTrack (const double x0, const double y0, const double z0, const double t0, const double dx0, const double dy0, const double dz0)
bool	GetCluster (double &xcls, double &ycls, double &zcls, double &tcls, int &ncls, double &ecls, double &extra)
double	GetClusterDensity ()
double	GetStoppingPower ()
Public Member Functions inherited from Garfield::Track
	Track ()
virtual	~Track ()
virtual void	SetParticle (std::string part)
void	SetEnergy (const double e)
void	SetBetaGamma (const double bg)
void	SetBeta (const double beta)
void	SetGamma (const double gamma)
void	SetMomentum (const double p)
void	SetKineticEnergy (const double ekin)
double	GetEnergy () const
double	GetBetaGamma () const
double	GetBeta () const
double	GetGamma () const
double	GetMomentum () const
double	GetKineticEnergy () const
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 ()
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	className
double	q
int	spin
double	mass
double	energy
double	beta2
bool	isElectron
std::string	particleName
Sensor *	sensor
bool	isChanged
bool	usePlotting
ViewDrift *	viewer
bool	debug
int	plotId

Detailed Description

Definition at line 13 of file TrackElectron.hh.

Constructor & Destructor Documentation

TrackElectron()

Garfield::TrackElectron::TrackElectron

(

)

Definition at line 12 of file TrackElectron.cc.

    : ready(false),
      x(0.),
      y(0.),
      z(0.),
      t(0.),
      dx(0.),
      dy(0),
      dz(1.),
      nComponents(0),
      nElectrons(0),
      mediumName(""),
      mediumDensity(0.),
      mfp(0.) {
 
  className = "TrackElectron";
 
  // Setup the particle properties.
  q = -1;
  spin = 1;
  mass = ElectronMass;
  isElectron = true;
  SetBetaGamma(3.);
  particleName = "electron";
 
  components.clear();
  electrons.clear();
}

~TrackElectron()

Garfield::TrackElectron::~TrackElectron ( )

inline

Definition at line 19 of file TrackElectron.hh.

{}

Member Function Documentation

GetCluster()

bool Garfield::TrackElectron::GetCluster ( double &  xcls, double &  ycls, double &  zcls, double &  tcls, int &  ncls, double &  ecls, double &  extra  )

virtual

Implements Garfield::Track.

Definition at line 125 of file TrackElectron.cc.

                                              {
 
  edep = extra = 0.;
  ncls = 0;
 
  nElectrons = 0;
  electrons.clear();
 
  if (!ready) {
    std::cerr << className << "::GetCluster:\n";
    std::cerr << "    Track not initialized.\n";
    std::cerr << "    Call NewTrack first.\n";
    return false;
  }
 
  // Draw a step length and propagate the electron.
  const double d = -mfp * log(RndmUniformPos());
  x += d * dx;
  y += d * dy;
  z += d * dz;
  t += d / (sqrt(beta2) * SpeedOfLight);
 
  if (!sensor->IsInArea(x, y, z)) {
    ready = false;
    return false;
  }
 
  Medium* medium = 0;
  if (!sensor->GetMedium(x, y, z, medium)) {
    ready = false;
    return false;
  }
 
  if (medium->GetName() != mediumName ||
      medium->GetNumberDensity() != mediumDensity || !medium->IsIonisable()) {
    ready = false;
    return false;
  }
 
  xcls = x;
  ycls = y;
  zcls = z;
  tcls = t;
  const double r = RndmUniform();
  int iComponent = 0;
  for (int i = 0; i < nComponents; ++i) {
    if (r <= RndmUniform()) {
      iComponent = i;
      break;
    }
  }
 
  // Sample secondary electron energy according to
  // Opal-Beaty-Peterson splitting function.
  const double e0 = ElectronMass * (sqrt(1. / (1. - beta2)) - 1.);
  double esec = components[iComponent].wSplit *
                tan(RndmUniform() * atan((e0 - components[iComponent].ethr) /
                                         (2. * components[iComponent].wSplit)));
  esec = components[iComponent].wSplit *
         pow(esec / components[iComponent].wSplit, 0.9524);
  nElectrons = 1;
  electrons.resize(nElectrons);
  electrons[0].energy = esec;
  electrons[0].x = xcls;
  electrons[0].y = ycls;
  electrons[0].z = zcls;
 
  ncls = nElectrons;
  edep = esec;
 
  return true;
}

GetClusterDensity()

double Garfield::TrackElectron::GetClusterDensity ( )

virtual

Reimplemented from Garfield::Track.

Definition at line 200 of file TrackElectron.cc.

                                        {
 
  if (!ready) {
    std::cerr << className << "::GetClusterDensity:\n";
    std::cerr << "    Track has not been initialized.\n";
    return 0.;
  }
 
  if (mfp <= 0.) {
    std::cerr << className << "::GetClusterDensity:\n";
    std::cerr << "    Mean free path is not available.\n";
    return 0.;
  }
 
  return 1. / mfp;
}

GetStoppingPower()

double Garfield::TrackElectron::GetStoppingPower ( )

virtual

Reimplemented from Garfield::Track.

Definition at line 217 of file TrackElectron.cc.

                                       {
 
  if (!ready) {
    std::cerr << className << "::GetStoppingPower:\n";
    std::cerr << "    Track has not been initialised.\n";
    return 0.;
  }
 
  const double prefactor = 4 * Pi * pow(HbarC / ElectronMass, 2);
  const double lnBg2 = log(beta2 / (1. - beta2));
 
  double dedx = 0.;
  // Primary energy
  const double e0 = ElectronMass * (sqrt(1. / (1. - beta2)) - 1.);
  for (int i = nComponents; i--;) {
    // Calculate the mean number of clusters per cm.
    const double cmean =
        mediumDensity * components[i].fraction * (prefactor / beta2) *
        (components[i].m2Ion * (lnBg2 - beta2) + components[i].cIon);
    const double ew = (e0 - components[i].ethr) / (2 * components[i].wSplit);
    // Calculate the mean secondary electron energy.
    const double emean =
        (components[i].wSplit / (2 * atan(ew))) * log(1. + ew * ew);
    dedx += cmean * emean;
  }
 
  return dedx;
}

NewTrack()

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

virtual

Implements Garfield::Track.

Definition at line 49 of file TrackElectron.cc.

                                                                 {
 
  ready = false;
 
  // Make sure the sensor has been set.
  if (sensor == 0) {
    std::cerr << className << "::NewTrack:\n";
    std::cerr << "    Sensor is not defined.\n";
    return false;
  }
 
  // Get the medium at this location and check if it is "ionisable".
  Medium* medium = 0;
  if (!sensor->GetMedium(x0, y0, z0, medium)) {
    std::cerr << className << "::NewTrack:\n";
    std::cerr << "    No medium at initial position.\n";
    return false;
  }
  if (!medium->IsIonisable()) {
    std::cerr << className << "::NewTrack:\n";
    std::cerr << "    Medium at initial position is not ionisable.\n";
    return false;
  }
 
  // Check if the medium is a gas.
  if (!medium->IsGas()) {
    std::cerr << className << "::NewTrack:\n";
    std::cerr << "    Medium at initial position is not a gas.\n";
    return false;
  }
 
  if (!SetupGas(medium)) {
    std::cerr << className << "::NewTrack:\n";
    std::cerr << "    Properties of medium " << medium->GetName()
              << " are not available.\n";
    return false;
  }
 
  if (!UpdateCrossSection()) {
    std::cerr << className << "::NewTrack:\n";
    std::cerr << "    Cross-sections could not be calculated.\n";
    return false;
  }
 
  mediumName = medium->GetName();
 
  x = x0;
  y = y0;
  z = z0;
  t = t0;
  const double dd = sqrt(dx0 * dx0 + dy0 * dy0 + dz0 * dz0);
  if (dd < Small) {
    if (debug) {
      std::cout << className << "::NewTrack:\n";
      std::cout << "    Direction vector has zero norm.\n";
      std::cout << "    Initial direction is randomized.\n";
    }
    const double ctheta = 1. - 2. * RndmUniform();
    const double stheta = sqrt(1. - ctheta * ctheta);
    const double phi = TwoPi * RndmUniform();
    dx = cos(phi) * stheta;
    dy = sin(phi) * stheta;
    dz = ctheta;
  } else {
    // Normalize the direction vector.
    dx = dx0 / dd;
    dy = dy0 / dd;
    dz = dz0 / dd;
  }
 
  ready = true;
  return true;
}

SetParticle()

void Garfield::TrackElectron::SetParticle ( std::string  particle )

virtual

Reimplemented from Garfield::Track.

Definition at line 41 of file TrackElectron.cc.

                                                  {
 
  if (particle != "electron" && particle != "e" && particle != "e-") {
    std::cerr << className << "::SetParticle:\n";
    std::cerr << "    Only electrons can be transported.\n";
  }
}

---

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

• TrackElectron.hh
• TrackElectron.cc