Calculate electron drift lines and avalanches using microscopic tracking. More...

#include <AvalancheMicroscopic.hh>

Public Member Functions
	AvalancheMicroscopic ()
	Constructor.

	~AvalancheMicroscopic ()
	Destructor.

void	SetSensor (Sensor *sensor)
	Set the sensor.

void	EnablePlotting (ViewDrift *view)
	Switch on drift line plotting.

void	DisablePlotting ()

void	EnableExcitationMarkers ()
	Draw a marker at every excitation.

void	DisableExcitationMarkers ()

void	EnableIonisationMarkers ()
	Draw a marker at every ionising collision.

void	DisableIonisationMarkers ()

void	EnableAttachmentMarkers ()
	Draw a marker at every attachment.

void	DisableAttachmentMarkers ()

void	EnableSignalCalculation ()
	Switch on calculation of induced currents.

void	DisableSignalCalculation ()

void	EnableInducedChargeCalculation ()
	Switch on calculation of the total induced charge.

void	DisableInducedChargeCalculation ()

void	EnableElectronEnergyHistogramming (TH1 *histo)
	Switch on filling histograms for electron energy distribution.

void	DisableElectronEnergyHistogramming ()

void	EnableHoleEnergyHistogramming (TH1 *histo)

void	DisableHoleEnergyHistogramming ()

void	SetDistanceHistogram (TH1 *histo, const char opt='r')

void	EnableDistanceHistogramming (const int type)

void	DisableDistanceHistogramming (const int type)
	Switch on distance distribution histograms for a given collision type.

void	DisableDistanceHistogramming ()

void	EnableSecondaryEnergyHistogramming (TH1 *histo)
	Fill histograms of the energy of electrons emitted in ionising collisions.

void	DisableSecondaryEnergyHistogramming ()

void	EnableDriftLines ()
	Switch on storage of drift lines.

void	DisableDriftLines ()

void	EnablePhotonTransport ()

void	DisablePhotonTransport ()

void	EnableBandStructure ()
	Switch on stepping according to band structure E(k), for semiconductors.

void	DisableBandStructure ()

void	EnableNullCollisionSteps ()
	Switch on update of coordinates for null-collision steps (default: off).

void	DisableNullCollisionSteps ()

void	SetElectronTransportCut (const double cut)

double	GetElectronTransportCut () const

void	SetPhotonTransportCut (const double cut)
	Set an energy threshold for photon transport.

double	GetPhotonTransportCut () const

void	EnableAvalancheSizeLimit (const unsigned int size)

void	DisableAvalancheSizeLimit ()

int	GetAvalancheSizeLimit () const

void	EnableMagneticField ()
	Enable magnetic field in stepping algorithm (default: off).

void	DisableMagneticField ()

void	SetCollisionSteps (const unsigned int n)
	Set number of collisions to be skipped for plotting.

void	SetTimeWindow (const double t0, const double t1)
	Define a time interval (only carriers inside the interval are simulated).

void	UnsetTimeWindow ()

void	GetAvalancheSize (int &ne, int &ni) const
	Return the number of electrons and ions in the avalanche.

void	GetAvalancheSize (int &ne, int &nh, int &ni) const

unsigned int	GetNumberOfElectronEndpoints () const

void	GetElectronEndpoint (const unsigned int i, double &x0, double &y0, double &z0, double &t0, double &e0, double &x1, double &y1, double &z1, double &t1, double &e1, int &status) const

void	GetElectronEndpoint (const unsigned int i, double &x0, double &y0, double &z0, double &t0, double &e0, double &x1, double &y1, double &z1, double &t1, double &e1, double &dx1, double &dy1, double &dz1, int &status) const

unsigned int	GetNumberOfElectronDriftLinePoints (const unsigned int i=0) const

unsigned int	GetNumberOfHoleDriftLinePoints (const unsigned int i=0) const

void	GetElectronDriftLinePoint (double &x, double &y, double &z, double &t, const int ip, const unsigned int iel=0) const

void	GetHoleDriftLinePoint (double &x, double &y, double &z, double &t, const int ip, const unsigned int iel=0) const

unsigned int	GetNumberOfHoleEndpoints () const

void	GetHoleEndpoint (const unsigned int i, double &x0, double &y0, double &z0, double &t0, double &e0, double &x1, double &y1, double &z1, double &t1, double &e1, int &status) const

unsigned int	GetNumberOfPhotons () const

void	GetPhoton (const unsigned int i, double &e, double &x0, double &y0, double &z0, double &t0, double &x1, double &y1, double &z1, double &t1, int &status) const

bool	DriftElectron (const double x0, const double y0, const double z0, const double t0, const double e0, const double dx0=0., const double dy0=0., const double dz0=0.)

bool	AvalancheElectron (const double x0, const double y0, const double z0, const double t0, const double e0, const double dx0=0., const double dy0=0., const double dz0=0.)
	Calculate an avalanche initiated by a given electron.

void	SetUserHandleStep (void(*f)(double x, double y, double z, double t, double e, double dx, double dy, double dz, bool hole))
	Set a user handling procedure. This function is called at every step.

void	UnsetUserHandleStep ()

void	SetUserHandleAttachment (void(f)(double x, double y, double z, double t, int type, int level, Medium m))
	Set a user handling procedure, to be called at every attachment.

void	UnsetUserHandleAttachment ()

void	SetUserHandleInelastic (void(f)(double x, double y, double z, double t, int type, int level, Medium m))
	Set a user handling procedure, to be called at every inelastic collision.

void	UnsetUserHandleInelastic ()

void	SetUserHandleIonisation (void(f)(double x, double y, double z, double t, int type, int level, Medium m))
	Set a user handling procedure, to be called at every ionising collision.

void	UnsetUserHandleIonisation ()

void	EnableDebugging ()
	Switch on debugging messages.

void	DisableDebugging ()

Detailed Description

Calculate electron drift lines and avalanches using microscopic tracking.

Definition at line 17 of file AvalancheMicroscopic.hh.

Constructor & Destructor Documentation

◆ AvalancheMicroscopic()

Garfield::AvalancheMicroscopic::AvalancheMicroscopic ( )

Constructor.

Definition at line 25 of file AvalancheMicroscopic.cc.

    : m_sensor(NULL),
      m_nElectrons(0),
      m_nHoles(0),
      m_nIons(0),
      m_usePlotting(false),
      m_viewer(NULL),
      m_plotExcitations(true),
      m_plotIonisations(true),
      m_plotAttachments(true),
      m_histElectronEnergy(NULL),
      m_histHoleEnergy(NULL),
      m_histDistance(NULL),
      m_distanceOption('r'),
      m_histSecondary(NULL),
      m_useSignal(false),
      m_useInducedCharge(false),
      m_useDriftLines(false),
      m_usePhotons(false),
      m_useBandStructureDefault(true),
      m_useNullCollisionSteps(false),
      m_useBfield(false),
      m_rb11(1.),
      m_rb12(0.),
      m_rb13(0.),
      m_rb21(0.),
      m_rb22(1.),
      m_rb23(0.),
      m_rb31(0.),
      m_rb32(0.),
      m_rb33(1.),
      m_rx22(1.),
      m_rx23(0.),
      m_rx32(0.),
      m_rx33(1.),
      m_deltaCut(0.),
      m_gammaCut(0.),
      m_sizeCut(0),
      m_nCollSkip(100),
      m_hasTimeWindow(false),
      m_tMin(0.),
      m_tMax(0.),
      m_hasUserHandleStep(false),
      m_hasUserHandleAttachment(false),
      m_hasUserHandleInelastic(false),
      m_hasUserHandleIonisation(false),
      m_userHandleStep(0),
      m_userHandleAttachment(0),
      m_userHandleInelastic(0),
      m_userHandleIonisation(0),
      m_debug(false) {
 
  m_className = "AvalancheMicroscopic";
 
  m_endpointsElectrons.reserve(10000);
  m_endpointsHoles.reserve(10000);
  m_photons.reserve(1000);
 
}

◆ ~AvalancheMicroscopic()

Garfield::AvalancheMicroscopic::~AvalancheMicroscopic ( )

inline

Destructor.

Definition at line 23 of file AvalancheMicroscopic.hh.

23{}

Member Function Documentation

◆ AvalancheElectron()

bool Garfield::AvalancheMicroscopic::AvalancheElectron	(	const double	x0,
		const double	y0,
		const double	z0,
		const double	t0,
		const double	e0,
		const double	dx0 = `0.`,
		const double	dy0 = `0.`,
		const double	dz0 = `0.`
	)

Calculate an avalanche initiated by a given electron.

Definition at line 517 of file AvalancheMicroscopic.cc.

                                                               {
 
  // Clear the list of electrons, holes and photons.
  m_endpointsElectrons.clear();
  m_endpointsHoles.clear();
  m_photons.clear();
 
  // Reset the particle counters.
  m_nElectrons = m_nHoles = m_nIons = 0;
 
  return TransportElectron(x0, y0, z0, t0, e0, dx0, dy0, dz0, true, false);
}

Referenced by GarfieldPhysics::DoIt().

◆ DisableAttachmentMarkers()

void Garfield::AvalancheMicroscopic::DisableAttachmentMarkers ( )

inline

Definition at line 39 of file AvalancheMicroscopic.hh.

39{ m_plotAttachments = false; }

◆ DisableAvalancheSizeLimit()

void Garfield::AvalancheMicroscopic::DisableAvalancheSizeLimit ( )

inline

Definition at line 99 of file AvalancheMicroscopic.hh.

99{ m_sizeCut = 0; }

◆ DisableBandStructure()

void Garfield::AvalancheMicroscopic::DisableBandStructure ( )

inline

Definition at line 81 of file AvalancheMicroscopic.hh.

81{ m_useBandStructureDefault = false; }

◆ DisableDebugging()

void Garfield::AvalancheMicroscopic::DisableDebugging ( )

inline

Definition at line 202 of file AvalancheMicroscopic.hh.

202{ m_debug = false; }

◆ DisableDistanceHistogramming() [1/2]

void Garfield::AvalancheMicroscopic::DisableDistanceHistogramming ( )

Definition at line 206 of file AvalancheMicroscopic.cc.

                                                        {
 
  m_histDistance = NULL;
  m_distanceHistogramType.clear();
}

◆ DisableDistanceHistogramming() [2/2]

void Garfield::AvalancheMicroscopic::DisableDistanceHistogramming ( const int type )

Switch on distance distribution histograms for a given collision type.

Definition at line 186 of file AvalancheMicroscopic.cc.

                                                                      {
 
  if (m_distanceHistogramType.empty()) {
    std::cerr << m_className << "::DisableDistanceHistogramming:\n";
    std::cerr << "    Collision type " << type << " is not histogrammed.\n";
    return;
  }
  const unsigned int nDistanceHistogramTypes = m_distanceHistogramType.size();
  for (unsigned int i = 0; i < nDistanceHistogramTypes; ++i) {
    if (m_distanceHistogramType[i] != type) continue;
    m_distanceHistogramType.erase(m_distanceHistogramType.begin() + i);
    std::cout << "    Histogramming of collision type " << type
              << " disabled.\n";
    return;
  }
 
  std::cerr << m_className << "::DisableDistanceHistogramming:\n";
  std::cerr << "    Collision type " << type << " is not histogrammed.\n";
}

◆ DisableDriftLines()

void Garfield::AvalancheMicroscopic::DisableDriftLines ( )

inline

Definition at line 72 of file AvalancheMicroscopic.hh.

72{ m_useDriftLines = false; }

◆ DisableElectronEnergyHistogramming()

void Garfield::AvalancheMicroscopic::DisableElectronEnergyHistogramming ( )

inline

Definition at line 51 of file AvalancheMicroscopic.hh.

51{ m_histElectronEnergy = NULL; }

◆ DisableExcitationMarkers()

void Garfield::AvalancheMicroscopic::DisableExcitationMarkers ( )

inline

Definition at line 33 of file AvalancheMicroscopic.hh.

33{ m_plotExcitations = false; }

◆ DisableHoleEnergyHistogramming()

void Garfield::AvalancheMicroscopic::DisableHoleEnergyHistogramming ( )

inline

Definition at line 53 of file AvalancheMicroscopic.hh.

53{ m_histHoleEnergy = NULL; }

◆ DisableInducedChargeCalculation()

void Garfield::AvalancheMicroscopic::DisableInducedChargeCalculation ( )

inline

Definition at line 47 of file AvalancheMicroscopic.hh.

47{ m_useInducedCharge = false; }

◆ DisableIonisationMarkers()

void Garfield::AvalancheMicroscopic::DisableIonisationMarkers ( )

inline

Definition at line 36 of file AvalancheMicroscopic.hh.

36{ m_plotIonisations = false; }

◆ DisableMagneticField()

void Garfield::AvalancheMicroscopic::DisableMagneticField ( )

inline

Definition at line 104 of file AvalancheMicroscopic.hh.

104{ m_useBfield = false; }

◆ DisableNullCollisionSteps()

void Garfield::AvalancheMicroscopic::DisableNullCollisionSteps ( )

inline

Definition at line 85 of file AvalancheMicroscopic.hh.

85{ m_useNullCollisionSteps = false; }

◆ DisablePhotonTransport()

void Garfield::AvalancheMicroscopic::DisablePhotonTransport ( )

inline

Definition at line 77 of file AvalancheMicroscopic.hh.

77{ m_usePhotons = false; }

◆ DisablePlotting()

void Garfield::AvalancheMicroscopic::DisablePlotting ( )

Definition at line 110 of file AvalancheMicroscopic.cc.

                                           {
 
  m_viewer = NULL;
  m_usePlotting = false;
}

◆ DisableSecondaryEnergyHistogramming()

void Garfield::AvalancheMicroscopic::DisableSecondaryEnergyHistogramming ( )

inline

Definition at line 68 of file AvalancheMicroscopic.hh.

68{ m_histSecondary = NULL; }

◆ DisableSignalCalculation()

void Garfield::AvalancheMicroscopic::DisableSignalCalculation ( )

inline

Definition at line 43 of file AvalancheMicroscopic.hh.

43{ m_useSignal = false; }

◆ DriftElectron()

bool Garfield::AvalancheMicroscopic::DriftElectron	(	const double	x0,
		const double	y0,
		const double	z0,
		const double	t0,
		const double	e0,
		const double	dx0 = `0.`,
		const double	dy0 = `0.`,
		const double	dz0 = `0.`
	)

Calculate an electron drift line.

Parameters

x0,y0,z0,t0	starting point of the electron
e0	initial energy of the electron
dx0,dy0,dz0	initial direction of the electron If the initial direction is not specified, it is sampled randomly. Secondary electrons are not transported.

Definition at line 501 of file AvalancheMicroscopic.cc.

                                                                             {
 
  // Clear the list of electrons and photons.
  m_endpointsElectrons.clear();
  m_endpointsHoles.clear();
  m_photons.clear();
 
  // Reset the particle counters.
  m_nElectrons = m_nHoles = m_nIons = 0;
 
  return TransportElectron(x0, y0, z0, t0, e0, dx0, dy0, dz0, false, false);
}

◆ EnableAttachmentMarkers()

void Garfield::AvalancheMicroscopic::EnableAttachmentMarkers ( )

inline

Draw a marker at every attachment.

Definition at line 38 of file AvalancheMicroscopic.hh.

38{ m_plotAttachments = true; }

◆ EnableAvalancheSizeLimit()

void Garfield::AvalancheMicroscopic::EnableAvalancheSizeLimit ( const unsigned int size )

inline

Set a max. avalanche size (i. e. ignore ionising collisions once this size has been reached).

Definition at line 98 of file AvalancheMicroscopic.hh.

98{ m_sizeCut = size; }

◆ EnableBandStructure()

void Garfield::AvalancheMicroscopic::EnableBandStructure ( )

inline

Switch on stepping according to band structure E(k), for semiconductors.

Definition at line 80 of file AvalancheMicroscopic.hh.

80{ m_useBandStructureDefault = true; }

◆ EnableDebugging()

void Garfield::AvalancheMicroscopic::EnableDebugging ( )

inline

Switch on debugging messages.

Definition at line 201 of file AvalancheMicroscopic.hh.

201{ m_debug = true; }

◆ EnableDistanceHistogramming()

void Garfield::AvalancheMicroscopic::EnableDistanceHistogramming ( const int type )

Definition at line 163 of file AvalancheMicroscopic.cc.

                                                                     {
 
  // Check if this type of collision is already registered
  // for histogramming.
  const unsigned int nDistanceHistogramTypes = m_distanceHistogramType.size();
  if (nDistanceHistogramTypes > 0) {
    for (unsigned int i = 0; i < nDistanceHistogramTypes; ++i) {
      if (m_distanceHistogramType[i] != type) continue;
      std::cout << m_className << "::EnableDistanceHistogramming:\n";
      std::cout << "    Collision type " << type
                << " is already being histogrammed.\n";
      return;
    }
  }
 
  m_distanceHistogramType.push_back(type);
  std::cout << m_className << "::EnableDistanceHistogramming:\n";
  std::cout << "    Histogramming of collision type " << type << " enabled.\n";
  if (!m_histDistance) {
    std::cout << "    Don't forget to set the histogram.\n";
  }
}

◆ EnableDriftLines()

void Garfield::AvalancheMicroscopic::EnableDriftLines ( )

inline

Switch on storage of drift lines.

Definition at line 71 of file AvalancheMicroscopic.hh.

71{ m_useDriftLines = true; }

Referenced by EnablePlotting().

◆ EnableElectronEnergyHistogramming()

void Garfield::AvalancheMicroscopic::EnableElectronEnergyHistogramming ( TH1 * histo )

Switch on filling histograms for electron energy distribution.

Definition at line 116 of file AvalancheMicroscopic.cc.

                                                                       {
 
  if (!histo) {
    std::cerr << m_className << "::EnableElectronEnergyHistogramming:\n"
              << "    Null pointer.\n";
    return;
  }
 
  m_histElectronEnergy = histo;
}

◆ EnableExcitationMarkers()

void Garfield::AvalancheMicroscopic::EnableExcitationMarkers ( )

inline

Draw a marker at every excitation.

Definition at line 32 of file AvalancheMicroscopic.hh.

32{ m_plotExcitations = true; }

◆ EnableHoleEnergyHistogramming()

void Garfield::AvalancheMicroscopic::EnableHoleEnergyHistogramming ( TH1 * histo )

Definition at line 127 of file AvalancheMicroscopic.cc.

                                                                   {
 
  if (!histo) {
    std::cerr << m_className << "::EnableHoleEnergyHistogramming:\n"
              << "    Null pointer.\n";
    return;
  }
 
  m_histHoleEnergy = histo;
}

◆ EnableInducedChargeCalculation()

void Garfield::AvalancheMicroscopic::EnableInducedChargeCalculation ( )

inline

Switch on calculation of the total induced charge.

Definition at line 46 of file AvalancheMicroscopic.hh.

46{ m_useInducedCharge = true; }

◆ EnableIonisationMarkers()

void Garfield::AvalancheMicroscopic::EnableIonisationMarkers ( )

inline

Draw a marker at every ionising collision.

Definition at line 35 of file AvalancheMicroscopic.hh.

35{ m_plotIonisations = true; }

◆ EnableMagneticField()

void Garfield::AvalancheMicroscopic::EnableMagneticField ( )

inline

Enable magnetic field in stepping algorithm (default: off).

Definition at line 103 of file AvalancheMicroscopic.hh.

103{ m_useBfield = true; }

◆ EnableNullCollisionSteps()

void Garfield::AvalancheMicroscopic::EnableNullCollisionSteps ( )

inline

Switch on update of coordinates for null-collision steps (default: off).

Definition at line 84 of file AvalancheMicroscopic.hh.

84{ m_useNullCollisionSteps = true; }

◆ EnablePhotonTransport()

void Garfield::AvalancheMicroscopic::EnablePhotonTransport ( )

inline

Switch on photon transport.

Remarks: This feature has not been tested thoroughly.

Definition at line 76 of file AvalancheMicroscopic.hh.

76{ m_usePhotons = true; }

◆ EnablePlotting()

void Garfield::AvalancheMicroscopic::EnablePlotting ( ViewDrift * view )

Switch on drift line plotting.

Definition at line 94 of file AvalancheMicroscopic.cc.

                                                         {
 
  if (!view) {
    std::cerr << m_className << "::EnablePlotting:\n    Null pointer.\n";
    return;
  }
 
  m_viewer = view;
  m_usePlotting = true;
  if (!m_useDriftLines) {
    std::cout << m_className << "::EnablePlotting:\n"
              << "    Enabling storage of drift line.\n";
    EnableDriftLines();
  }
}

◆ EnableSecondaryEnergyHistogramming()

void Garfield::AvalancheMicroscopic::EnableSecondaryEnergyHistogramming ( TH1 * histo )

Fill histograms of the energy of electrons emitted in ionising collisions.

Definition at line 212 of file AvalancheMicroscopic.cc.

                                                                        {
 
  if (!histo) {
    std::cerr << m_className << "::EnableSecondaryEnergyHistogramming:\n"
              << "    Null pointer.\n";
    return;
  }
 
  m_histSecondary = histo;
}

◆ EnableSignalCalculation()

void Garfield::AvalancheMicroscopic::EnableSignalCalculation ( )

inline

Switch on calculation of induced currents.

Definition at line 42 of file AvalancheMicroscopic.hh.

42{ m_useSignal = true; }

◆ GetAvalancheSize() [1/2]

void Garfield::AvalancheMicroscopic::GetAvalancheSize	(	int &	ne,
		int &	nh,
		int &	ni
	)		const

inline

Definition at line 118 of file AvalancheMicroscopic.hh.

                                                         {
    ne = m_nElectrons;
    nh = m_nHoles;
    ni = m_nIons;
  }

◆ GetAvalancheSize() [2/2]

void Garfield::AvalancheMicroscopic::GetAvalancheSize	(	int &	ne,
		int &	ni
	)		const

inline

Return the number of electrons and ions in the avalanche.

Definition at line 114 of file AvalancheMicroscopic.hh.

                                                {
    ne = m_nElectrons;
    ni = m_nIons;
  }

Referenced by GarfieldPhysics::DoIt().

◆ GetAvalancheSizeLimit()

int Garfield::AvalancheMicroscopic::GetAvalancheSizeLimit ( ) const

inline

Definition at line 100 of file AvalancheMicroscopic.hh.

100{ return m_sizeCut; }

◆ GetElectronDriftLinePoint()

void Garfield::AvalancheMicroscopic::GetElectronDriftLinePoint	(	double &	x,
		double &	y,
		double &	z,
		double &	t,
		const int	ip,
		const unsigned int	iel = `0`
	)		const

Definition at line 353 of file AvalancheMicroscopic.cc.

                                                                                   {
 
  if (iel >= m_endpointsElectrons.size()) {
    std::cerr << m_className << "::GetElectronDriftLinePoint:\n";
    std::cerr << "    Endpoint index (" << iel << ") out of range.\n";
    return;
  }
 
  if (ip <= 0) {
    x = m_endpointsElectrons[iel].x0;
    y = m_endpointsElectrons[iel].y0;
    z = m_endpointsElectrons[iel].z0;
    t = m_endpointsElectrons[iel].t0;
    return;
  }
 
  const int np = m_endpointsElectrons[iel].driftLine.size();
  if (ip > np) {
    x = m_endpointsElectrons[iel].x;
    y = m_endpointsElectrons[iel].y;
    z = m_endpointsElectrons[iel].z;
    t = m_endpointsElectrons[iel].t;
    return;
  }
 
  x = m_endpointsElectrons[iel].driftLine[ip - 1].x;
  y = m_endpointsElectrons[iel].driftLine[ip - 1].y;
  z = m_endpointsElectrons[iel].driftLine[ip - 1].z;
  t = m_endpointsElectrons[iel].driftLine[ip - 1].t;
}

◆ GetElectronEndpoint() [1/2]

void Garfield::AvalancheMicroscopic::GetElectronEndpoint	(	const unsigned int	i,
		double &	x0,
		double &	y0,
		double &	z0,
		double &	t0,
		double &	e0,
		double &	x1,
		double &	y1,
		double &	z1,
		double &	t1,
		double &	e1,
		double &	dx1,
		double &	dy1,
		double &	dz1,
		int &	status
	)		const

Definition at line 267 of file AvalancheMicroscopic.cc.

                                                 {
 
  if (i >= m_endpointsElectrons.size()) {
    std::cerr << m_className << "::GetElectronEndpoint:\n";
    std::cerr << "    Endpoint index " << i << " out of range.\n";
    x0 = y0 = z0 = t0 = e0 = 0.;
    x1 = y1 = z1 = t1 = e1 = 0.;
    dx1 = dy1 = dz1 = 0.;
    status = 0;
    return;
  }
 
  x0 = m_endpointsElectrons[i].x0;
  y0 = m_endpointsElectrons[i].y0;
  z0 = m_endpointsElectrons[i].z0;
  t0 = m_endpointsElectrons[i].t0;
  e0 = m_endpointsElectrons[i].e0;
  x1 = m_endpointsElectrons[i].x;
  y1 = m_endpointsElectrons[i].y;
  z1 = m_endpointsElectrons[i].z;
  t1 = m_endpointsElectrons[i].t;
  e1 = m_endpointsElectrons[i].energy;
  dx1 = m_endpointsElectrons[i].kx;
  dy1 = m_endpointsElectrons[i].ky;
  dz1 = m_endpointsElectrons[i].kz;
  status = m_endpointsElectrons[i].status;
}

◆ GetElectronEndpoint() [2/2]

void Garfield::AvalancheMicroscopic::GetElectronEndpoint	(	const unsigned int	i,
		double &	x0,
		double &	y0,
		double &	z0,
		double &	t0,
		double &	e0,
		double &	x1,
		double &	y1,
		double &	z1,
		double &	t1,
		double &	e1,
		int &	status
	)		const

Return the coordinates and time of start and end point of a given electron drift line.

Parameters

i	index of the drift line
x0,y0,z0,t0	coordinates and time of the starting point
x1,y1,z1,t1	coordinates and time of the end point
e0,e1	initial and final energy
status	status code (see GarfieldConstants.hh)

Definition at line 238 of file AvalancheMicroscopic.cc.

                                                                              {
 
  if (i >= m_endpointsElectrons.size()) {
    std::cerr << m_className << "::GetElectronEndpoint:\n";
    std::cerr << "    Endpoint index " << i << " out of range.\n";
    x0 = y0 = z0 = t0 = e0 = 0.;
    x1 = y1 = z1 = t1 = e1 = 0.;
    status = 0;
    return;
  }
 
  x0 = m_endpointsElectrons[i].x0;
  y0 = m_endpointsElectrons[i].y0;
  z0 = m_endpointsElectrons[i].z0;
  t0 = m_endpointsElectrons[i].t0;
  e0 = m_endpointsElectrons[i].e0;
  x1 = m_endpointsElectrons[i].x;
  y1 = m_endpointsElectrons[i].y;
  z1 = m_endpointsElectrons[i].z;
  t1 = m_endpointsElectrons[i].t;
  e1 = m_endpointsElectrons[i].energy;
  status = m_endpointsElectrons[i].status;
}

◆ GetElectronTransportCut()

double Garfield::AvalancheMicroscopic::GetElectronTransportCut ( ) const

inline

Definition at line 90 of file AvalancheMicroscopic.hh.

90{ return m_deltaCut; }

◆ GetHoleDriftLinePoint()

void Garfield::AvalancheMicroscopic::GetHoleDriftLinePoint	(	double &	x,
		double &	y,
		double &	z,
		double &	t,
		const int	ip,
		const unsigned int	iel = `0`
	)		const

Definition at line 387 of file AvalancheMicroscopic.cc.

                                                                              {
 
  if (ih >= m_endpointsHoles.size()) {
    std::cerr << m_className << "::GetHoleDriftLinePoint:\n";
    std::cerr << "    Endpoint index (" << ih << ") out of range.\n";
    return;
  }
 
  if (ip <= 0) {
    x = m_endpointsHoles[ih].x0;
    y = m_endpointsHoles[ih].y0;
    z = m_endpointsHoles[ih].z0;
    t = m_endpointsHoles[ih].t0;
    return;
  }
 
  const int np = m_endpointsHoles[ih].driftLine.size();
  if (ip > np) {
    x = m_endpointsHoles[ih].x;
    y = m_endpointsHoles[ih].y;
    z = m_endpointsHoles[ih].z;
    t = m_endpointsHoles[ih].t;
    return;
  }
 
  x = m_endpointsHoles[ih].driftLine[ip - 1].x;
  y = m_endpointsHoles[ih].driftLine[ip - 1].y;
  z = m_endpointsHoles[ih].driftLine[ip - 1].z;
  t = m_endpointsHoles[ih].driftLine[ip - 1].t;
}

◆ GetHoleEndpoint()

void Garfield::AvalancheMicroscopic::GetHoleEndpoint	(	const unsigned int	i,
		double &	x0,
		double &	y0,
		double &	z0,
		double &	t0,
		double &	e0,
		double &	x1,
		double &	y1,
		double &	z1,
		double &	t1,
		double &	e1,
		int &	status
	)		const

Definition at line 298 of file AvalancheMicroscopic.cc.

                                                              {
 
  if (i >= m_endpointsHoles.size()) {
    std::cerr << m_className << "::GetHoleEndpoint:\n";
    std::cerr << "    Endpoint index " << i << " out of range.\n";
    x0 = y0 = z0 = t0 = e0 = 0.;
    x1 = y1 = z1 = t1 = e1 = 0.;
    status = 0;
    return;
  }
 
  x0 = m_endpointsHoles[i].x0;
  y0 = m_endpointsHoles[i].y0;
  z0 = m_endpointsHoles[i].z0;
  t0 = m_endpointsHoles[i].t0;
  e0 = m_endpointsHoles[i].e0;
  x1 = m_endpointsHoles[i].x;
  y1 = m_endpointsHoles[i].y;
  z1 = m_endpointsHoles[i].z;
  t1 = m_endpointsHoles[i].t;
  e1 = m_endpointsHoles[i].energy;
  status = m_endpointsHoles[i].status;
}

◆ GetNumberOfElectronDriftLinePoints()

unsigned int Garfield::AvalancheMicroscopic::GetNumberOfElectronDriftLinePoints ( const unsigned int i = 0 ) const

Definition at line 326 of file AvalancheMicroscopic.cc.

          {
 
  if (i >= m_endpointsElectrons.size()) {
    std::cerr << m_className << "::GetNumberOfElectronDriftLinePoints:\n";
    std::cerr << "    Endpoint index (" << i << ") out of range.\n";
    return 0;
  }
 
  if (!m_useDriftLines) return 2;
 
  return m_endpointsElectrons[i].driftLine.size() + 2;
}

◆ GetNumberOfElectronEndpoints()

unsigned int Garfield::AvalancheMicroscopic::GetNumberOfElectronEndpoints ( ) const

inline

Return the number of electron trajectories in the last simulated avalanche (including captured electrons).

Definition at line 126 of file AvalancheMicroscopic.hh.

                                                    { 
    return m_endpointsElectrons.size(); 
  }

◆ GetNumberOfHoleDriftLinePoints()

unsigned int Garfield::AvalancheMicroscopic::GetNumberOfHoleDriftLinePoints ( const unsigned int i = 0 ) const

Definition at line 340 of file AvalancheMicroscopic.cc.

                                                                                            {
 
  if (i >= m_endpointsHoles.size()) {
    std::cerr << m_className << "::GetNumberOfHoleDriftLinePoints:\n";
    std::cerr << "    Endpoint index (" << i << ") out of range.\n";
    return 0;
  }
 
  if (!m_useDriftLines) return 2;
 
  return m_endpointsHoles[i].driftLine.size() + 2;
}

◆ GetNumberOfHoleEndpoints()

unsigned int Garfield::AvalancheMicroscopic::GetNumberOfHoleEndpoints ( ) const

inline

Definition at line 152 of file AvalancheMicroscopic.hh.

                                                { 
    return m_endpointsHoles.size(); 
  }

◆ GetNumberOfPhotons()

unsigned int Garfield::AvalancheMicroscopic::GetNumberOfPhotons ( ) const

inline

Definition at line 159 of file AvalancheMicroscopic.hh.

159{ return m_photons.size(); }

◆ GetPhoton()

void Garfield::AvalancheMicroscopic::GetPhoton	(	const unsigned int	i,
		double &	e,
		double &	x0,
		double &	y0,
		double &	z0,
		double &	t0,
		double &	x1,
		double &	y1,
		double &	z1,
		double &	t1,
		int &	status
	)		const

Definition at line 421 of file AvalancheMicroscopic.cc.

                                                                    {
 
  if (i >= m_photons.size()) {
    std::cerr << m_className << "::GetPhoton:\n    Index out of range.\n";
    return;
  }
 
  x0 = m_photons[i].x0;
  x1 = m_photons[i].x1;
  y0 = m_photons[i].y0;
  y1 = m_photons[i].y1;
  z0 = m_photons[i].z0;
  z1 = m_photons[i].z1;
  t0 = m_photons[i].t0;
  t1 = m_photons[i].t1;
  status = m_photons[i].status;
  e = m_photons[i].energy;
}

◆ GetPhotonTransportCut()

double Garfield::AvalancheMicroscopic::GetPhotonTransportCut ( ) const

inline

Definition at line 94 of file AvalancheMicroscopic.hh.

94{ return m_gammaCut; }

◆ SetCollisionSteps()

void Garfield::AvalancheMicroscopic::SetCollisionSteps ( const unsigned int n )

inline

Set number of collisions to be skipped for plotting.

Definition at line 107 of file AvalancheMicroscopic.hh.

107{ m_nCollSkip = n; }

◆ SetDistanceHistogram()

void Garfield::AvalancheMicroscopic::SetDistanceHistogram	(	TH1 *	histo,
		const char	opt = `'r'`
	)

Fill histograms of the distance between successive collisions.

Parameters

histo	pointer to the histogram to be filled
opt	direction ('x', 'y', 'z', 'r')

Definition at line 138 of file AvalancheMicroscopic.cc.

                                                                          {
 
  if (!histo) {
    std::cerr << m_className << "::SetDistanceHistogram:\n    Null pointer.\n";
    return;
  }
 
  m_histDistance = histo;
 
  if (opt == 'x' || opt == 'y' || opt == 'z' || opt == 'r') {
    m_distanceOption = opt;
  } else {
    std::cerr << m_className << "::SetDistanceHistogram:";
    std::cerr << "    Unknown option " << opt << ".\n";
    std::cerr << "    Valid options are x, y, z, r.\n";
    std::cerr << "    Using default value (r).\n";
    m_distanceOption = 'r';
  }
 
  if (m_distanceHistogramType.empty()) {
    std::cout << m_className << "::SetDistanceHistogram:\n";
    std::cout << "    Don't forget to call EnableDistanceHistogramming.\n";
  }
}

◆ SetElectronTransportCut()

void Garfield::AvalancheMicroscopic::SetElectronTransportCut ( const double cut )

inline

Set a (lower) energy threshold for electron transport. This can be useful for simulating delta electrons.

Definition at line 89 of file AvalancheMicroscopic.hh.

89{ m_deltaCut = cut; }

◆ SetPhotonTransportCut()

void Garfield::AvalancheMicroscopic::SetPhotonTransportCut ( const double cut )

inline

Set an energy threshold for photon transport.

Definition at line 93 of file AvalancheMicroscopic.hh.

93{ m_gammaCut = cut; }

◆ SetSensor()

void Garfield::AvalancheMicroscopic::SetSensor ( Sensor * sensor )

Set the sensor.

Definition at line 85 of file AvalancheMicroscopic.cc.

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

Referenced by GarfieldPhysics::InitializePhysics().

◆ SetTimeWindow()

void Garfield::AvalancheMicroscopic::SetTimeWindow	(	const double	t0,
		const double	t1
	)

Define a time interval (only carriers inside the interval are simulated).

Definition at line 223 of file AvalancheMicroscopic.cc.

                                                                         {
 
  if (fabs(t1 - t0) < Small) {
    std::cerr << m_className << "::SetTimeWindow:\n";
    std::cerr << "    Time interval must be greater than zero.\n";
    return;
  }
 
  m_tMin = std::min(t0, t1);
  m_tMax = std::max(t0, t1);
  m_hasTimeWindow = true;
}

◆ SetUserHandleAttachment()

void Garfield::AvalancheMicroscopic::SetUserHandleAttachment ( void(*)(double x, double y, double z, double t, int type, int level, Medium *m) f )

Set a user handling procedure, to be called at every attachment.

Definition at line 462 of file AvalancheMicroscopic.cc.

                                                                             {
 
  m_userHandleAttachment = f;
  m_hasUserHandleAttachment = true;
}

◆ SetUserHandleInelastic()

void Garfield::AvalancheMicroscopic::SetUserHandleInelastic ( void(*)(double x, double y, double z, double t, int type, int level, Medium *m) f )

Set a user handling procedure, to be called at every inelastic collision.

Definition at line 475 of file AvalancheMicroscopic.cc.

                                                                             {
 
  m_userHandleInelastic = f;
  m_hasUserHandleInelastic = true;
}

◆ SetUserHandleIonisation()

void Garfield::AvalancheMicroscopic::SetUserHandleIonisation ( void(*)(double x, double y, double z, double t, int type, int level, Medium *m) f )

Set a user handling procedure, to be called at every ionising collision.

Definition at line 488 of file AvalancheMicroscopic.cc.

                                                                             {
 
  m_userHandleIonisation = f;
  m_hasUserHandleIonisation = true;
}

◆ SetUserHandleStep()

void Garfield::AvalancheMicroscopic::SetUserHandleStep ( void(*)(double x, double y, double z, double t, double e, double dx, double dy, double dz, bool hole) f )

Set a user handling procedure. This function is called at every step.

Definition at line 443 of file AvalancheMicroscopic.cc.

                                                {
 
  if (!f) {
    std::cerr << m_className << "::SetUserHandleStep:\n";
    std::cerr << "    Function pointer is a null pointer.\n";
    return;
  }
  m_userHandleStep = f;
  m_hasUserHandleStep = true;
}

◆ UnsetTimeWindow()

void Garfield::AvalancheMicroscopic::UnsetTimeWindow ( )

Definition at line 236 of file AvalancheMicroscopic.cc.

236{ m_hasTimeWindow = false; }

◆ UnsetUserHandleAttachment()

void Garfield::AvalancheMicroscopic::UnsetUserHandleAttachment ( )

Definition at line 469 of file AvalancheMicroscopic.cc.

                                                     {
 
  m_userHandleAttachment = 0;
  m_hasUserHandleAttachment = false;
}

◆ UnsetUserHandleInelastic()

void Garfield::AvalancheMicroscopic::UnsetUserHandleInelastic ( )

Definition at line 482 of file AvalancheMicroscopic.cc.

                                                    {
 
  m_userHandleInelastic = 0;
  m_hasUserHandleInelastic = false;
}

◆ UnsetUserHandleIonisation()

void Garfield::AvalancheMicroscopic::UnsetUserHandleIonisation ( )

Definition at line 495 of file AvalancheMicroscopic.cc.

                                                     {
 
  m_userHandleIonisation = 0;
  m_hasUserHandleIonisation = false;
}

◆ UnsetUserHandleStep()

void Garfield::AvalancheMicroscopic::UnsetUserHandleStep ( )

Definition at line 456 of file AvalancheMicroscopic.cc.

                                               {
 
  m_userHandleStep = 0;
  m_hasUserHandleStep = false;
}

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AvalancheMicroscopic()

◆ ~AvalancheMicroscopic()

Member Function Documentation

◆ AvalancheElectron()

◆ DisableAttachmentMarkers()

◆ DisableAvalancheSizeLimit()

◆ DisableBandStructure()

◆ DisableDebugging()

◆ DisableDistanceHistogramming() [1/2]

◆ DisableDistanceHistogramming() [2/2]

◆ DisableDriftLines()

◆ DisableElectronEnergyHistogramming()

◆ DisableExcitationMarkers()

◆ DisableHoleEnergyHistogramming()

◆ DisableInducedChargeCalculation()

◆ DisableIonisationMarkers()

◆ DisableMagneticField()

◆ DisableNullCollisionSteps()

◆ DisablePhotonTransport()

◆ DisablePlotting()

◆ DisableSecondaryEnergyHistogramming()

◆ DisableSignalCalculation()

◆ DriftElectron()

◆ EnableAttachmentMarkers()

◆ EnableAvalancheSizeLimit()

◆ EnableBandStructure()

◆ EnableDebugging()

◆ EnableDistanceHistogramming()

◆ EnableDriftLines()

◆ EnableElectronEnergyHistogramming()

◆ EnableExcitationMarkers()

◆ EnableHoleEnergyHistogramming()

◆ EnableInducedChargeCalculation()

◆ EnableIonisationMarkers()

◆ EnableMagneticField()

◆ EnableNullCollisionSteps()

◆ EnablePhotonTransport()

◆ EnablePlotting()

◆ EnableSecondaryEnergyHistogramming()

◆ EnableSignalCalculation()

◆ GetAvalancheSize() [1/2]

◆ GetAvalancheSize() [2/2]

◆ GetAvalancheSizeLimit()

◆ GetElectronDriftLinePoint()

◆ GetElectronEndpoint() [1/2]

◆ GetElectronEndpoint() [2/2]

◆ GetElectronTransportCut()

◆ GetHoleDriftLinePoint()

◆ GetHoleEndpoint()

◆ GetNumberOfElectronDriftLinePoints()

◆ GetNumberOfElectronEndpoints()

◆ GetNumberOfHoleDriftLinePoints()

◆ GetNumberOfHoleEndpoints()

◆ GetNumberOfPhotons()

◆ GetPhoton()

◆ GetPhotonTransportCut()

◆ SetCollisionSteps()

◆ SetDistanceHistogram()

◆ SetElectronTransportCut()

◆ SetPhotonTransportCut()

◆ SetSensor()

◆ SetTimeWindow()

◆ SetUserHandleAttachment()

◆ SetUserHandleInelastic()

◆ SetUserHandleIonisation()

◆ SetUserHandleStep()

◆ UnsetTimeWindow()

◆ UnsetUserHandleAttachment()

◆ UnsetUserHandleInelastic()

◆ UnsetUserHandleIonisation()

◆ UnsetUserHandleStep()