#include <AvalancheGrid.hh>

Public Member Functions
	AvalancheGrid ()
	Constructor.

	~AvalancheGrid ()
	Destructor.

void	SetSensor (Sensor *sensor)
	Set the sensor.

void	StartGridAvalanche ()

void	SetElectronVelocity (const double vx, const double vy, const double vz)
	Set the electron drift velocity (in cm / ns).

void	SetElectronTownsend (const double town)
	Set the electron Townsend coefficient (in 1 / cm).

void	SetElectronAttachment (const double att)
	Set the electron attachment coefficient (in 1 / cm).

void	SetMaxAvalancheSize (const double size)
	Set the maximum avalanche size (1e7 by default).

void	EnableDiffusion (const double diffSigma)

void	AvalancheElectron (const double x, const double y, const double z, const double t=0, const int n=1)

void	ImportElectronsFromAvalancheMicroscopic (AvalancheMicroscopic *avmc)
	Import electron data from AvalancheMicroscopic class.

void	SetGrid (const double xmin, const double xmax, const int xsteps, const double ymin, const double ymax, const int ysteps, const double zmin, const double zmax, const int zsteps)
	Import electron data from AvalancheMicroscopic class.

int	GetAmountOfStartingElectrons ()
	Returns the initial number of electrons in the avalanche.

int	GetAvalancheSize ()
	Returns the final number of electrons in the avalanche.

void	AsignLayerIndex (ComponentParallelPlate *RPC)
	Asigning layer index to all Avalanche nodes.

void	EnableDebugging ()

void	Reset ()

Detailed Description

Calculate avalanches in a uniform electric field using avalanche statistics.

Definition at line 18 of file AvalancheGrid.hh.

Constructor & Destructor Documentation

◆ AvalancheGrid()

Garfield::AvalancheGrid::AvalancheGrid ( )

inline

Constructor.

Definition at line 21 of file AvalancheGrid.hh.

21{}

◆ ~AvalancheGrid()

Garfield::AvalancheGrid::~AvalancheGrid ( )

inline

Destructor.

Definition at line 23 of file AvalancheGrid.hh.

23{}

Member Function Documentation

◆ AsignLayerIndex()

void Garfield::AvalancheGrid::AsignLayerIndex ( ComponentParallelPlate * RPC )

Asigning layer index to all Avalanche nodes.

Definition at line 509 of file AvalancheGrid.cc.

                                                               {
  int im = 0;
  double epsM = 0;
  std::vector<double> nLayer(RPC->NumberOfLayers(), 0);
  for (AvalancheNode &node : m_activeNodes) {
    double y = m_avgrid.ygrid[node.iy];
    RPC->getLayer(y, im, epsM);
    node.layer = im;
    nLayer[im - 1] += node.n;
    // std::cerr << m_className << "::AsignLayerIndex::im = "<<im<<".\n";
  }
 
  m_NLayer = nLayer;
  m_layerIndix = true;
}

◆ AvalancheElectron()

void Garfield::AvalancheGrid::AvalancheElectron	(	const double	x,
		const double	y,
		const double	z,
		const double	t = 0,
		const int	n = 1 )

Setting the starting point of an electron that .

Parameters

z	z-coordinate of initial electron.
x	x-coordinate of initial electron.
v	speed of initial electron.
t	starting time of avalanche.

Definition at line 360 of file AvalancheGrid.cc.

                                                   {
  m_driftAvalanche = true;
 
  if (m_avgrid.time == 0 && m_avgrid.time != t && m_debug)
    std::cerr << m_className
              << "::CreateAvalanche::Overwriting start time of avalanche for t "
                 "= 0 to " << t << ".\n";
  m_avgrid.time = t;
 
  if (SnapToGrid(m_avgrid, x, y, z, 0, n) && m_debug)
    std::cerr << m_className
              << "::CreateAvalanche::Electron added at (t,x,y,z) =  (" << t
              << "," << x << "," << y << "," << z << ").\n";
}

◆ EnableDebugging()

void Garfield::AvalancheGrid::EnableDebugging ( )

inline

Definition at line 83 of file AvalancheGrid.hh.

83{ m_debug = true; }

◆ EnableDiffusion()

void Garfield::AvalancheGrid::EnableDiffusion ( const double diffSigma )

inline

Enable transverse diffusion of electrons with transverse diffusion coefficients (in √cm).

Definition at line 54 of file AvalancheGrid.hh.

                                               {
    m_diffusion = true;
    m_DiffSigma = diffSigma;
  }

◆ GetAmountOfStartingElectrons()

int Garfield::AvalancheGrid::GetAmountOfStartingElectrons ( )

inline

Returns the initial number of electrons in the avalanche.

Definition at line 76 of file AvalancheGrid.hh.

76{ return m_nestart; }

◆ GetAvalancheSize()

int Garfield::AvalancheGrid::GetAvalancheSize ( )

inline

Returns the final number of electrons in the avalanche.

Definition at line 78 of file AvalancheGrid.hh.

78{ return m_avgrid.N; }

◆ ImportElectronsFromAvalancheMicroscopic()

void Garfield::AvalancheGrid::ImportElectronsFromAvalancheMicroscopic ( AvalancheMicroscopic * avmc )

Import electron data from AvalancheMicroscopic class.

Definition at line 377 of file AvalancheGrid.cc.

                                {
  // Get the information of the electrons from the AvalancheMicroscopic class.
  if (!avmc) return;
 
  if (!m_importAvalanche) m_importAvalanche = true;
 
  // Get initial positions of electrons
  for (const auto& electron : avmc->GetElectrons()) {
    // If the electron is not stopped due to
    // the upper bound of the time range: then skip this electron.
    if (electron.status != -17) continue;
    const auto& p1 = electron.path.at(0);
    const auto& p2 = electron.path.back();
    const double vel = (p2.z - p1.z) / (p2.t - p1.t);
    m_avgrid.time = p2.t;
 
    if (SnapToGrid(m_avgrid, p2.x, p2.y, p2.z, vel) && m_debug) {
      std::cerr << m_className
                << "::ImportElectronsFromAvalancheMicroscopic: Electron added at "
                   "(x,y,z) =  (" << p2.x << "," << p2.y << "," << p2.z << ").\n";
    }
  }
}

◆ Reset()

void Garfield::AvalancheGrid::Reset ( )

Definition at line 492 of file AvalancheGrid.cc.

                          {
 
  std::cerr << m_className << "::Reset::Resetting AvalancheGrid.\n";
  m_avgrid.time = 0;
  m_avgrid.N = 0;
  m_avgrid.run = true;
 
  m_Saturated = false;
  m_SaturationTime = -1;
 
  m_driftAvalanche = false;
 
  m_activeNodes.clear();
  m_layerIndix = false;
  m_NLayer.clear();
}

◆ SetElectronAttachment()

void Garfield::AvalancheGrid::SetElectronAttachment ( const double att )

inline

Set the electron attachment coefficient (in 1 / cm).

Definition at line 49 of file AvalancheGrid.hh.

49{ m_Attachment = att; }

Garfield::Magboltz::att

double att

Definition MagboltzInterface.hh:185

◆ SetElectronTownsend()

void Garfield::AvalancheGrid::SetElectronTownsend ( const double town )

inline

Set the electron Townsend coefficient (in 1 / cm).

Definition at line 47 of file AvalancheGrid.hh.

47{ m_Townsend = town; }

◆ SetElectronVelocity()

void Garfield::AvalancheGrid::SetElectronVelocity	(	const double	vx,
		const double	vy,
		const double	vz )

inline

Set the electron drift velocity (in cm / ns).

Definition at line 36 of file AvalancheGrid.hh.

                                                                              {
    double vel = sqrt(vx * vx + vy * vy + vz * vz);
    if (vel != std::abs(vx) && vel != std::abs(vy) && vel != std::abs(vz))
      return;
    int nx = (int)vx / vel;
    int ny = (int)vy / vel;
    int nz = (int)vz / vel;
    m_velNormal = {nx, ny, nz};
    m_Velocity = -std::abs(vel);
  }

◆ SetGrid()

void Garfield::AvalancheGrid::SetGrid	(	const double	xmin,
		const double	xmax,
		const int	xsteps,
		const double	ymin,
		const double	ymax,
		const int	ysteps,
		const double	zmin,
		const double	zmax,
		const int	zsteps )

Import electron data from AvalancheMicroscopic class.

Definition at line 51 of file AvalancheGrid.cc.

                                              {
  m_avgrid.gridset = true;
 
  if (zmin >= zmax || zsteps <= 0 || xmin > xmax || xsteps <= 0 ||
      ymin > ymax || ysteps <= 0) {
    std::cerr << m_className
              << "::SetGrid:Error: Grid is not properly defined.\n";
    return;
  }
 
  // Setting grid
 
  SetZGrid(m_avgrid, zmax, zmin, zsteps);
  SetYGrid(m_avgrid, ymax, ymin, ysteps);
  SetXGrid(m_avgrid, xmax, xmin, xsteps);
 
  if (m_debug) {
    std::cerr << m_className << "::SetGrid: Grid created:\n";
    std::cerr << "       x range = (" << xmin << "," << xmax << ").\n";
    std::cerr << "       y range = (" << ymin << "," << ymax << ").\n";
    std::cerr << "       z range = (" << zmin << "," << zmax << ").\n";
  }
}

◆ SetMaxAvalancheSize()

void Garfield::AvalancheGrid::SetMaxAvalancheSize ( const double size )

inline

Set the maximum avalanche size (1e7 by default).

Definition at line 51 of file AvalancheGrid.hh.

51{ m_MaxSize = size; }

◆ SetSensor()

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

inline

Set the sensor.

Definition at line 25 of file AvalancheGrid.hh.

25{ m_sensor = sensor; }

◆ StartGridAvalanche()

void Garfield::AvalancheGrid::StartGridAvalanche ( )

Start grid based avalanche simulation.

Parameters

zmin,zmax	z-coordinate range of grid [cm].
zsteps	amount of z-coordinate points in grid.
xmin,xmax	x-coordinate range of grid [cm].
xsteps	amount of x-coordinate points in grid.

Definition at line 319 of file AvalancheGrid.cc.

                                       {
  // Start the AvalancheGrid algorithm.
  if ((!m_importAvalanche && !m_driftAvalanche) || !m_sensor) return;
 
  std::cerr << m_className
            << "::StartGridAvalanche::Starting grid based simulation with "
            << m_avgrid.N << " initial electrons.\n";
  if (m_avgrid.N <= 0) {
    std::cerr << m_className << "::StartGridAvalanche::Cancelled.\n";
    return;
  }
 
  m_nestart = m_avgrid.N;
 
  // Main loop.
  while (m_avgrid.run == true) {
    if (m_debug)
      std::cerr
          << "============ \n" << m_className
          << "::StartGridAvalanche: Looping over nodes.\n ============ \n";
    NextAvalancheGridPoint(m_avgrid);
  }
 
  std::vector<double> tlist = {};
  for (AvalancheNode &node : m_activeNodes) {
    tlist.push_back(node.time);
  }
  double maxTime = *max_element(std::begin(tlist), std::end(tlist));
 
  if (m_Saturated)
    std::cerr << m_className
              << "::StartGridAvalanche::Avalanche maximum size of " << m_MaxSize
              << " electrons reached at " << m_SaturationTime << " ns.\n";
 
  std::cerr << m_className
            << "::StartGridAvalanche::Final avalanche size = " << m_avgrid.N
            << " ended at t = " << maxTime << " ns.\n";
 
  return;
}

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AvalancheGrid()

◆ ~AvalancheGrid()

Member Function Documentation

◆ AsignLayerIndex()

◆ AvalancheElectron()

◆ EnableDebugging()

◆ EnableDiffusion()

◆ GetAmountOfStartingElectrons()

◆ GetAvalancheSize()

◆ ImportElectronsFromAvalancheMicroscopic()

◆ Reset()

◆ SetElectronAttachment()

◆ SetElectronTownsend()

◆ SetElectronVelocity()

◆ SetGrid()

◆ SetMaxAvalancheSize()

◆ SetSensor()

◆ StartGridAvalanche()