Garfield Namespace Reference

Namespaces
namespace	Degrade
namespace	Magboltz
namespace	Numerics
	Collection of numerical routines.
namespace	Polygon

Classes
class	AvalancheGrid
	Calculate avalanches in a uniform electric field using avalanche statistics. More...
class	AvalancheGridSpaceCharge
	Propagates avalanches with the 2d (axi-symmetric) space-charge routine from Lippmann, Riegler (2004) in uniform background fields. More...
class	AvalancheMC
	Calculate drift lines and avalanches based on macroscopic transport coefficients, using Monte Carlo integration. More...
class	AvalancheMicroscopic
	Calculate electron drift lines and avalanches using microscopic tracking. More...
class	Component
	Abstract base class for components. More...
class	ComponentAnalyticField
	Semi-analytic calculation of two-dimensional configurations consisting of wires, planes, and tubes. More...
class	ComponentAnsys121
	Component for importing and interpolating two-dimensional ANSYS field maps. More...
class	ComponentAnsys123
	Component for importing and interpolating three-dimensional ANSYS field maps. More...
class	ComponentChargedRing
	Component for calculating the field of a system of charged r,z rings. More...
class	ComponentComsol
	Component for importing and interpolating Comsol field maps. More...
class	ComponentConstant
	Component with constant electric field. More...
class	ComponentCST
	Component for importing and interpolating field maps from CST. More...
class	ComponentElmer
	Component for importing field maps computed by Elmer. More...
class	ComponentElmer2d
	Component for importing two-dimensional field maps computed by Elmer. More...
class	ComponentFieldMap
	Base class for components based on finite-element field maps. More...
class	ComponentGrid
	Component for interpolating field maps on a regular mesh. More...
class	ComponentNeBem2d
	Two-dimensional implementation of the nearly exact Boundary Element Method. More...
class	ComponentNeBem3d
	Interface to neBEM. More...
class	ComponentNeBem3dMap
	Component for interpolating field maps stored in a mesh generated by neBEM. More...
class	ComponentParallelPlate
	Component for parallel-plate geometries. More...
class	ComponentTcad2d
	Interpolation in a two-dimensional field map created by Sentaurus Device. More...
class	ComponentTcad3d
	Interpolation in a three-dimensional field map created by Sentaurus Device. More...
class	ComponentTcadBase
	Interpolation in a field map created by Sentaurus Device. More...
class	ComponentUser
	Simple component with electric field given by a user function. More...
class	ComponentVoxel
	Component for interpolating field maps stored in a regular mesh. More...
class	DriftLineRKF
	Calculation of drift lines based on macroscopic transport coefficients using Runge-Kutta-Fehlberg integration. More...
class	Geometry
	Abstract base class for geometry classes. More...
class	GeometryRoot
	Use a geometry defined using the ROOT TGeo package. More...
class	GeometrySimple
	"Native" geometry, using simple shapes. More...
class	KDTree
	Main k-d tree class. More...
class	KDTreeNode
	A node in the k-d tree. More...
struct	KDTreeResult
	Search result. More...
class	Medium
	Abstract base class for components. More...
class	MediumCdTe
	Cadmium-Telluride. More...
class	MediumConductor
	Conducting medium. More...
class	MediumDiamond
	Diamond. More...
class	MediumGaAs
	Gallium-Arsenide. More...
class	MediumGaN
	Gallium-Nitride. More...
class	MediumGas
	Base class for gas media. More...
class	MediumMagboltz
	Interface to Magboltz (version 11). More...
class	MediumPlastic
	Plastic medium. More...
class	MediumSilicon
	Solid crystalline silicon More...
class	OpticalData
	Photoabsorption cross-sections for some gases. More...
struct	Panel
	Surface panel. More...
class	PlottingEngine
	Plotting style. More...
class	QuadTree
	Quadtree search. More...
class	Random
class	RandomEngine
	Abstract base class for random number generators. More...
class	RandomEngineRoot
class	RandomEngineSTL
class	Sensor
	Sensor. More...
class	Shaper
	Class for signal processing. More...
class	Solid
	Abstract base class for solids. More...
class	SolidBox
	Box. More...
class	SolidExtrusion
	Extrusion. More...
class	SolidHole
	Box with a cylindrical hole. More...
class	SolidRidge
	Triangular prism (Toblerone bar). More...
class	SolidSphere
	Sphere. More...
class	SolidTube
	Cylindrical tube. More...
class	SolidWire
	Wire. More...
class	Track
	Abstract base class for track generation. More...
class	TrackBichsel
	Generate tracks using differential cross-sections for silicon computed by Hans Bichsel. More...
class	TrackDegrade
	Interface to Degrade. More...
class	TrackElectron
	[WIP] Ionization calculation based on MIP program (S. Biagi). More...
class	TrackHeed
	Generate tracks using Heed++. More...
class	TrackPAI
class	TrackSimple
	Generate tracks based on a cluster density given by the user. More...
class	TrackSrim
	Generate tracks based on SRIM energy loss, range and straggling tables. More...
class	TrackTrim
	Generate tracks based on TRIM output files. More...
class	Vec1Impl
class	Vec2Impl
class	Vec3Impl
class	Vector
class	ViewBase
	Base class for visualization classes. More...
class	ViewCell
	Visualize the "cell" defined in an analytic-field component. More...
class	ViewDrift
	Visualize drift lines and tracks. More...
class	ViewFEMesh
	Draw the mesh of a field-map component. More...
class	ViewField
	Visualize the potential or electric field of a component or sensor. More...
class	ViewGeometry
	Visualize a geometry defined using the "native" shapes. More...
class	ViewIsochrons
	Draw equal time contour lines. More...
class	ViewMedium
	Plot transport coefficients as function of electric and magnetic field. More...
class	ViewSignal
	Plot the signal computed by a sensor as a ROOT histogram. More...

Typedefs
typedef std::vector< std::vector< double > >	KDTreeArray
using	Vec3 = Vec3Impl<double>
using	Vec3D = Vec3Impl<double>
using	Vec3F = Vec3Impl<float>
using	ViewMesh = ViewFEMesh

Enumerations
enum class	Particle {   Electron = 0 , Ion , Hole , Positron ,   NegativeIon , Photon }
enum class	MPRunMode { Normal = 0 , GPUExclusive }

Functions
double	RndmUniform ()
	Draw a random number uniformly distributed in the range [0, 1).
double	RndmUniformPos ()
	Draw a random number uniformly distributed in the range (0, 1).
std::pair< double, double >	RndmGaussians ()
	Draw two Gaussian random variates with mean zero and standard deviation one.
double	RndmGaussian ()
	Draw a Gaussian random variate with mean zero and standard deviation one.
std::pair< double, double >	RndmGaussians (const double mu, const double sigma)
	Draw two Gaussian random variates with mean mu and standard deviation sigma.
double	RndmGaussian (const double mu, const double sigma)
	Draw a Gaussian random variate with mean mu and standard deviation sigma.
double	RndmLorentzian (const double mu, const double gamma)
	Draw a Lorentzian random variate with mean mu and half-width at half maximum gamma.
double	RndmVoigt (const double mu, const double sigma, const double gamma)
	Draw a random number according to a Voigt function with mean mu.
unsigned int	RndmYuleFurry (const double mean)
	Draw a random number from a geometric distribution.
double	RndmPolya (const double theta)
	Draw a Polya distributed random number.
double	RndmLandau ()
	Draw a random number from a Landau distribution.
double	RndmVavilov (const double rkappa, const double beta2)
	Draw a random number from a Vavilov distribution.
int	RndmPoisson (const double mean)
	Draw a random number from a Poisson distribution.
double	RndmHeedWF (const double w, const double f)
	Draw a random energy needed to create a single electron in a material asymptotic work function W and Fano factor F, according to Igor Smirnov's phenomenological model.
void	RndmDirection (double &dx, double &dy, double &dz, const double length=1.)
	Draw a random (isotropic) direction vector.
class	GARFIELD_CLASS_NAME (TetrahedralTree)
	Helper class for searches in field maps.
void	ltrim (std::string &line)
void	rtrim (std::string &line)
std::vector< std::string >	tokenize (const std::string &line)
bool	startsWith (const std::string &line, const std::string &s)

Variables
ComponentNeBem3d *	gComponentNeBem3d

Typedef Documentation

KDTreeArray

typedef std::vector<std::vector<double> > Garfield::KDTreeArray

Definition at line 19 of file KDTree.hh.

Vec3

using Garfield::Vec3 = Vec3Impl<double>

Definition at line 27 of file TetrahedralTree.hh.

Vec3D

using Garfield::Vec3D = Vec3Impl<double>

Definition at line 98 of file Vector.hh.

Vec3F

using Garfield::Vec3F = Vec3Impl<float>

Definition at line 99 of file Vector.hh.

ViewMesh

using Garfield::ViewMesh = ViewFEMesh

Definition at line 163 of file ViewFEMesh.hh.

Enumeration Type Documentation

MPRunMode

enum class Garfield::MPRunMode

strong

Enumerator
Normal
GPUExclusive

Definition at line 7 of file MultiProcessInterface.hh.

{ Normal = 0, GPUExclusive };

Particle

enum class Garfield::Particle

strong

Enumerator
Electron
Ion
Hole
Positron
NegativeIon
Photon

Definition at line 7 of file GarfieldConstants.hh.

{ Electron = 0, Ion, Hole, Positron, NegativeIon, Photon };

Function Documentation

GARFIELD_CLASS_NAME()

class Garfield::GARFIELD_CLASS_NAME

(

TetrahedralTree

)

Helper class for searches in field maps.

This class stores the mesh nodes and elements in an Octree data structure to optimize the element search operations

Author: Ali Sheharyar

Organization: Texas A&M University at Qatar

Destructor

Insert a mesh element with given bounding box and index to the tree.

Create and initialise GPU Transfer class

Definition at line 1 of file TetrahedralTree.hh.

                                           {
 public:
#ifdef __GPUCOMPILE__
  // Constructor
  GARFIELD_CLASS_NAME(TetrahedralTree)() = default;
 
  // Destructor
  ~GARFIELD_CLASS_NAME(TetrahedralTree)() = default;
#else
  // Constructor
  GARFIELD_CLASS_NAME(TetrahedralTree)(const Vec3& origin,
                                       const Vec3& halfDimension);

  ~GARFIELD_CLASS_NAME(TetrahedralTree)();
#endif
 
#ifndef __GPUCOMPILE__
  // Insert a mesh node (a vertex/point) to the tree
  void InsertMeshNode(Vec3 point, const int index);

  void InsertMeshElement(const double bb[6], const int index);

  double CreateGPUTransferObject(TetrahedralTreeGPU*& tree_gpu);
#endif
 
 private:
  static std::vector<int> emptyBlock;
 
  // Physical centre of this tree node.
  Vec3 m_origin;
  // Half the width/height/depth of this tree node.
  Vec3 m_halfDimension;
  // Storing min and max points for convenience
  Vec3 m_min, m_max;
 
  // The tree has up to eight children and can additionally store
  // a list of mesh nodes and mesh elements.
  // Pointers to child octants.
  GARFIELD_CLASS_NAME(TetrahedralTree) * children[8];
 
  // Children follow a predictable pattern to make accesses simple.
  // Here, - means less than 'origin' in that dimension, + means greater than.
  // child: 0 1 2 3 4 5 6 7
  // x:     - - - - + + + +
  // y:     - - + + - - + +
  // z:     - + - + - + - +
 
#ifndef __GPUCOMPILE__
  std::vector<std::pair<Vec3, int> > nodes;
#endif
 
#ifdef __GPUCOMPILE__
  int* elements{nullptr};
  int numelements{0};
#else
  std::vector<int> elements;
#endif
 
  static const size_t BlockCapacity = 10;
 
#ifndef __GPUCOMPILE__
  // Check if the given box overlaps with this tree node.
  bool DoesBoxOverlap(const double bb[6]) const;
#endif
  // Check if this tree node is a leaf or intermediate node.
  __DEVICE__ bool IsLeafNode() const;
 
 public:
// Get all tetrahedra linked to a block corresponding to the given point
#ifdef __GPUCOMPILE__
  __device__ void GetElementsInBlock(const Vec3& point,
                                     const int*& tet_list_elems,
                                     int& num_elems) const;
#else
  const std::vector<int>& GetElementsInBlock(const Vec3& point) const;
#endif
 
 private:
  __DEVICE__ int GetOctantContainingPoint(const Vec3& point) const;
  // Get a block containing the input point
  __DEVICE__ const GARFIELD_CLASS_NAME(TetrahedralTree) *
      GetBlockFromPoint(const Vec3& point) const;
  // A helper function used by the function above.
  // Called recursively on the child nodes.
  __DEVICE__ const GARFIELD_CLASS_NAME(TetrahedralTree) *
      GetBlockFromPointHelper(const Vec3& point) const;
 
#ifdef __GPUCOMPILE__
  friend class TetrahedralTree;
#endif
};

ltrim()

void Garfield::ltrim ( std::string & line )

inline

Definition at line 11 of file Utilities.hh.

                                   {
  line.erase(line.begin(), std::find_if(line.begin(), line.end(), [](int ch) {
               return !std::isspace(ch);
             }));
}

RndmDirection()

void Garfield::RndmDirection ( double & dx, double & dy, double & dz, const double length = 1. )

inline

Draw a random (isotropic) direction vector.

Definition at line 146 of file Random.hh.

                                                    {
  const double phi = TwoPi * RndmUniform();
  const double ctheta = 2 * RndmUniform() - 1.;
  const double stheta = sqrt(1. - ctheta * ctheta);
  dx = length * cos(phi) * stheta;
  dy = length * sin(phi) * stheta;
  dz = length * ctheta;
}

RndmGaussian() [1/2]

double Garfield::RndmGaussian ( )

inline

Draw a Gaussian random variate with mean zero and standard deviation one.

Definition at line 51 of file Random.hh.

                             {
  const auto r = RndmGaussians();
  return r.first;
}

RndmGaussian() [2/2]

double Garfield::RndmGaussian ( const double mu, const double sigma )

inline

Draw a Gaussian random variate with mean mu and standard deviation sigma.

Definition at line 66 of file Random.hh.

                                                                {
  return mu + sigma * RndmGaussian();
}

RndmGaussians() [1/2]

std::pair< double, double > Garfield::RndmGaussians ( )

inline

Draw two Gaussian random variates with mean zero and standard deviation one.

Definition at line 36 of file Random.hh.

                                               {
  // Box-Muller algorithm
  double u = 2. * RndmUniform() - 1.;
  double v = 2. * RndmUniform() - 1.;
  double r2 = u * u + v * v;
  while (r2 > 1.) {
    u = 2. * RndmUniform() - 1.;
    v = 2. * RndmUniform() - 1.;
    r2 = u * u + v * v;
  }
  const double p = sqrt(-2. * log(r2) / r2);
  return std::make_pair(u * p, v * p);
}

RndmGaussians() [2/2]

std::pair< double, double > Garfield::RndmGaussians ( const double mu, const double sigma )

inline

Draw two Gaussian random variates with mean mu and standard deviation sigma.

Definition at line 57 of file Random.hh.

                                                                   {
  auto r = RndmGaussians();
  r.first = mu + sigma * r.first;
  r.second = mu + sigma * r.second;
  return r;
}

RndmHeedWF()

double Garfield::RndmHeedWF	(	const double	w,
		const double	f )

Draw a random energy needed to create a single electron in a material asymptotic work function W and Fano factor F, according to Igor Smirnov's phenomenological model.

RndmLandau()

double Garfield::RndmLandau

(

)

Draw a random number from a Landau distribution.

RndmLorentzian()

double Garfield::RndmLorentzian ( const double mu, const double gamma )

inline

Draw a Lorentzian random variate with mean mu and half-width at half maximum gamma.

Definition at line 72 of file Random.hh.

                                                                  {
  return mu + gamma * tan(Pi * (RndmUniform() - 0.5));
}

RndmPoisson()

int Garfield::RndmPoisson

(

const double

mean

)

Draw a random number from a Poisson distribution.

RndmPolya()

double Garfield::RndmPolya ( const double theta )

inline

Draw a Polya distributed random number.

Definition at line 109 of file Random.hh.

                                            {
  // Algorithm from Review of Particle Physics
  // C. Amsler et al, Phys. Lett. B 667 (2008)
  if (theta <= 0.) return -log(RndmUniformPos());
  const double c = 3 * (theta + 1.) - 0.75;
  double u1, u2, v1, v2, v3;
  double x;
  while (1) {
    u1 = RndmUniformPos();
    v1 = u1 * (1. - u1);
    if (v1 == 0.) continue;
    v2 = (u1 - 0.5) * sqrt(c / v1);
    x = theta + v2;
    if (x <= 0.) continue;
    u2 = RndmUniformPos();
    v3 = 64 * u2 * u2 * pow(v1, 3);
    if (v3 <= 1. - 2 * v2 * v2 / x ||
        log(v3) <= 2 * (theta * log(x / theta) - v2)) {
      return x / (theta + 1.);
    }
  }
}

RndmUniform()

double Garfield::RndmUniform ( )

inline

Draw a random number uniformly distributed in the range [0, 1).

Definition at line 26 of file Random.hh.

{ return Random::Draw(); }

RndmUniformPos()

double Garfield::RndmUniformPos ( )

inline

Draw a random number uniformly distributed in the range (0, 1).

Definition at line 29 of file Random.hh.

                               {
  double r = RndmUniform();
  while (r <= 0.) r = RndmUniform();
  return r;
}

RndmVavilov()

double Garfield::RndmVavilov	(	const double	rkappa,
		const double	beta2 )

Draw a random number from a Vavilov distribution.

RndmVoigt()

double Garfield::RndmVoigt ( const double mu, const double sigma, const double gamma )

inline

Draw a random number according to a Voigt function with mean mu.

The Voigt function is a convolution of a Gaussian (standard deviation sigma) and a Lorentzian (half width gamma).

Definition at line 80 of file Random.hh.

                                            {
  if (sigma <= 0.) return RndmLorentzian(mu, gamma);
  const double a = gamma / (Sqrt2 * sigma);
  const double x = RndmLorentzian(0., a) + RndmGaussian(0., 1. / Sqrt2);
  return mu + x * Sqrt2 * sigma;
}

RndmYuleFurry()

unsigned int Garfield::RndmYuleFurry ( const double mean )

inline

Draw a random number from a geometric distribution.

Definition at line 89 of file Random.hh.

                                                     {
  if (mean <= 0.) return 0;
  return 1 + static_cast<unsigned int>(std::log(RndmUniformPos()) /
                                       std::log1p(-1. / mean));
  /*
  const double u = RndmUniform();
  double p = 1. / mean;
  const double q = 1. - p;
  double sum = p;
  unsigned int k = 1;
  while (sum < u) {
    ++k;
    p *= q;
    sum += p;
  }
  return k;
  */
}

rtrim()

void Garfield::rtrim ( std::string & line )

inline

Definition at line 17 of file Utilities.hh.

                                   {
  line.erase(std::find_if(line.rbegin(), line.rend(),
                          [](int ch) { return !std::isspace(ch); })
                 .base(),
             line.end());
}

startsWith()

bool Garfield::startsWith ( const std::string & line, const std::string & s )

inline

Definition at line 33 of file Utilities.hh.

                                                                  {
  return (line.rfind(s, 0) == 0);
}

tokenize()

std::vector< std::string > Garfield::tokenize ( const std::string & line )

inline

Definition at line 24 of file Utilities.hh.

                                                            {
  std::vector<std::string> words;
  std::istringstream ss(line);
  for (std::string word; ss >> word;) {
    words.push_back(word);
  }
  return words;
}

Variable Documentation

gComponentNeBem3d

ComponentNeBem3d* Garfield::gComponentNeBem3d

extern