Two-dimensional implementation of the nearly exact Boundary Element Method. More...

#include <ComponentNeBem2d.hh>

Inheritance diagram for Garfield::ComponentNeBem2d:

Public Member Functions
	ComponentNeBem2d ()

	~ComponentNeBem2d ()

void	ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, Medium *&m, int &status)

void	ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, double &v, Medium *&m, int &status)

bool	GetVoltageRange (double &vmin, double &vmax)
	Calculate the voltage range [V].

void	SetProjectionX ()

void	SetProjectionY ()

void	SetProjectionZ ()

void	AddPanel (const double x0, const double y0, const double x1, const double y1, const int bctype, const double bcval, const double lambda)

void	AddWire (const double x0, const double y0, const double d, const double bcval)

void	SetNumberOfDivisions (const int ndiv)

void	SetNumberOfCollocationPoints (const int ncoll)

void	SetMinimumElementSize (const double min)

void	EnableAutoResizing ()

void	DisableAutoResizing ()

void	EnableRandomCollocation ()

void	DisableRandomCollocation ()

void	SetMaxNumberOfIterations (const int niter)

int	GetNumberOfPanels ()

int	GetNumberOfWires ()

int	GetNumberOfElements ()

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

virtual	~ComponentBase ()
	Destructor.

virtual void	SetGeometry (GeometryBase *geo)
	Define the geometry.

virtual void	Clear ()
	Reset.

virtual Medium *	GetMedium (const double x, const double y, const double z)
	Get the medium at a given location (x, y, z).

virtual void	ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, Medium *&m, int &status)=0

virtual void	ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, double &v, Medium *&m, int &status)=0

virtual bool	GetVoltageRange (double &vmin, double &vmax)=0
	Calculate the voltage range [V].

virtual void	WeightingField (const double x, const double y, const double z, double &wx, double &wy, double &wz, const std::string &label)

virtual double	WeightingPotential (const double x, const double y, const double z, const std::string &label)

virtual void	MagneticField (const double x, const double y, const double z, double &bx, double &by, double &bz, int &status)

void	SetMagneticField (const double bx, const double by, const double bz)
	Set a constant magnetic field.

virtual bool	IsReady ()
	Ready for use?

virtual bool	GetBoundingBox (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax)
	Get the bounding box coordinates.

virtual bool	IsWireCrossed (const double x0, const double y0, const double z0, const double x1, const double y1, const double z1, double &xc, double &yc, double &zc)

virtual bool	IsInTrapRadius (const double q0, const double x0, const double y0, const double z0, double &xw, double &yw, double &rw)

void	EnablePeriodicityX (const bool on=true)
	Enable simple periodicity in the direction.

void	DisablePeriodicityX ()

void	EnablePeriodicityY (const bool on=true)
	Enable simple periodicity in the direction.

void	DisablePeriodicityY ()

void	EnablePeriodicityZ (const bool on=true)
	Enable simple periodicity in the direction.

void	DisablePeriodicityZ ()

void	EnableMirrorPeriodicityX (const bool on=true)
	Enable mirror periodicity in the direction.

void	DisableMirrorPeriodicityX ()

void	EnableMirrorPeriodicityY (const bool on=true)
	Enable mirror periodicity in the direction.

void	DisableMirrorPeriodicityY ()

void	EnableMirrorPeriodicityZ (const bool on=true)
	Enable mirror periodicity in the direction.

void	DisableMirrorPeriodicityZ ()

void	EnableAxialPeriodicityX (const bool on=true)
	Enable axial periodicity in the direction.

void	DisableAxialPeriodicityX ()

void	EnableAxialPeriodicityY (const bool on=true)
	Enable axial periodicity in the direction.

void	DisableAxialPeriodicityY ()

void	EnableAxialPeriodicityZ (const bool on=true)
	Enable axial periodicity in the direction.

void	DisableAxialPeriodicityZ ()

void	EnableRotationSymmetryX (const bool on=true)
	Enable rotation symmetry around the axis.

void	DisableRotationSymmetryX ()

void	EnableRotationSymmetryY (const bool on=true)
	Enable rotation symmetry around the axis.

void	DisableRotationSymmetryY ()

void	EnableRotationSymmetryZ (const bool on=true)
	Enable rotation symmetry around the axis.

void	DisableRotationSymmetryZ ()

void	EnableDebugging ()
	Switch on debugging messages.

void	DisableDebugging ()
	Switch off debugging messages.

void	ActivateTraps ()
	Request trapping to be taken care of by the component (for TCAD).

void	DeactivateTraps ()

bool	IsTrapActive ()

void	ActivateVelocityMap ()
	Request velocity to be taken care of by the component (for TCAD).

void	DectivateVelocityMap ()

bool	IsVelocityActive ()

virtual bool	ElectronAttachment (const double, const double, const double, double &eta)
	Get the electron attachment coefficient.

virtual bool	HoleAttachment (const double, const double, const double, double &eta)
	Get the hole attachment coefficient.

virtual void	ElectronVelocity (const double, const double, const double, double &vx, double &vy, double &vz, Medium *&, int &status)
	Get the electron drift velocity.

virtual void	HoleVelocity (const double, const double, const double, double &vx, double &vy, double &vz, Medium *&, int &status)
	Get the hole drift velocity.

virtual bool	GetElectronLifetime (const double, const double, const double, double &etau)

virtual bool	GetHoleLifetime (const double, const double, const double, double &htau)

Additional Inherited Members
virtual void	Reset ()=0
	Geometry checks.

virtual void	UpdatePeriodicity ()=0
	Verify periodicities.

Protected Attributes inherited from Garfield::ComponentBase
std::string	m_className
	Class name.

GeometryBase *	m_geometry
	Pointer to the geometry.

bool	m_ready
	Ready for use?

bool	m_activeTraps
	Does the component have traps?

bool	m_hasVelocityMap
	Does the component have velocity maps?

bool	m_xPeriodic
	Simple periodicity in x.

bool	m_yPeriodic
	Simple periodicity in y.

bool	m_zPeriodic
	Simple periodicity in z.

bool	m_xMirrorPeriodic
	Mirror periodicity in x.

bool	m_yMirrorPeriodic
	Mirror periodicity in y.

bool	m_zMirrorPeriodic
	Mirror periodicity in z.

bool	m_xAxiallyPeriodic
	Axial periodicity in x.

bool	m_yAxiallyPeriodic
	Axial periodicity in y.

bool	m_zAxiallyPeriodic
	Axial periodicity in z.

bool	m_xRotationSymmetry
	Rotation symmetry around x-axis.

bool	m_yRotationSymmetry
	Rotation symmetry around y-axis.

bool	m_zRotationSymmetry
	Rotation symmetry around z-axis.

double	m_bx0

double	m_by0

double	m_bz0

bool	m_debug
	Switch on/off debugging messages.

Detailed Description

Two-dimensional implementation of the nearly exact Boundary Element Method.

Definition at line 10 of file ComponentNeBem2d.hh.

Constructor & Destructor Documentation

◆ ComponentNeBem2d()

Garfield::ComponentNeBem2d::ComponentNeBem2d ( )

Definition at line 13 of file ComponentNeBem2d.cc.

    : projAxis(2),
      nDivisions(5),
      nCollocationPoints(3),
      minSize(1.e-3),
      autoSize(false),
      randomCollocation(false),
      nMaxIterations(3),
      nPanels(0),
      nWires(0),
      nElements(0),
      matrixInversionFlag(false) {
 
  m_className = "ComponentNeBem2d";
 
  influenceMatrix.clear();
  inverseMatrix.clear();
}

◆ ~ComponentNeBem2d()

Garfield::ComponentNeBem2d::~ComponentNeBem2d ( )

inline

Definition at line 15 of file ComponentNeBem2d.hh.

15{}

Member Function Documentation

◆ AddPanel()

void Garfield::ComponentNeBem2d::AddPanel	(	const double	x0,
		const double	y0,
		const double	x1,
		const double	y1,
		const int	bctype,
		const double	bcval,
		const double	lambda
	)

Definition at line 127 of file ComponentNeBem2d.cc.

                                                     {
 
  const double dx = x1 - x0;
  const double dy = y1 - y0;
  if (dx * dx + dy * dy <= Small) {
    std::cerr << m_className << "::AddPanel:\n";
    std::cerr << "    Panel length must be greater than zero.\n";
    return;
  }
 
  panel newPanel;
  newPanel.x0 = x0;
  newPanel.y0 = y0;
  newPanel.x1 = x1;
  newPanel.y1 = y1;
  if (bctype < 0 || bctype > 3) {
    std::cerr << m_className << "::AddPanel:\n";
    std::cerr << "    Unknown boundary condition type: " << bctype << "\n";
    return;
  }
  newPanel.bcType = bctype;
  newPanel.bcValue = bcval;
  newPanel.lambda = lambda;
  panels.push_back(newPanel);
  ++nPanels;
 
  if (m_debug) {
    std::cout << m_className << "::AddPanel:\n";
    std::cout << "    From: (" << x0 << ", " << y0 << ")\n";
    std::cout << "    To:   (" << x1 << ", " << y1 << ")\n";
    switch (bctype) {
      case 0:
        std::cout << "    Type: Conductor\n";
        std::cout << "    Potential: " << bcval << " V\n";
        break;
      case 1:
        std::cout << "    Floating conductor\n";
        break;
      case 2:
        std::cout << "    Dielectric-dielectric interface\n";
        std::cout << "    Lambda: " << lambda << "\n";
        break;
      case 3:
        std::cout << "    Surface charge\n";
        break;
      default:
        std::cout << "    Unknown boundary condition (program bug!)\n";
    }
  }
 
  m_ready = false;
  matrixInversionFlag = false;
}

◆ AddWire()

void Garfield::ComponentNeBem2d::AddWire	(	const double	x0,
		const double	y0,
		const double	d,
		const double	bcval
	)

Definition at line 184 of file ComponentNeBem2d.cc.

                                                   {
 
  if (d < Small) {
    std::cerr << m_className << "::AddWire:\n";
    std::cerr << "    Wire diameter must be greater than zero.\n";
    return;
  }
 
  wire newWire;
  newWire.cX = x0;
  newWire.cY = y0;
  newWire.d = d;
  newWire.bcValue = bcval;
  wires.push_back(newWire);
  ++nWires;
 
  if (m_debug) {
    std::cout << m_className << "::AddWire:\n";
    std::cout << "    Center: (" << x0 << ", " << y0 << ")\n";
    std::cout << "    Diameter: " << d << " cm\n";
    std::cout << "    Potential: " << bcval << " V\n";
  }
 
  m_ready = false;
  matrixInversionFlag = false;
}

◆ DisableAutoResizing()

void Garfield::ComponentNeBem2d::DisableAutoResizing ( )

inline

Definition at line 41 of file ComponentNeBem2d.hh.

41{ autoSize = false; }

◆ DisableRandomCollocation()

void Garfield::ComponentNeBem2d::DisableRandomCollocation ( )

inline

Definition at line 43 of file ComponentNeBem2d.hh.

43{ randomCollocation = false; }

◆ ElectricField() [1/2]

void Garfield::ComponentNeBem2d::ElectricField	(	const double	x,
		const double	y,
		const double	z,
		double &	ex,
		double &	ey,
		double &	ez,
		double &	v,
		Medium *&	m,
		int &	status
	)

virtual

Implements Garfield::ComponentBase.

Definition at line 32 of file ComponentNeBem2d.cc.

                                                  {
 
  ex = ey = ez = v = 0.;
  status = 0;
  // Check if the requested point is inside a medium
  m = GetMedium(x, y, z);
  if (m == NULL) {
    status = -6;
    return;
  }
 
  if (!m_ready) {
    if (!Initialise()) {
      std::cerr << m_className << "::ElectricField:\n";
      std::cerr << "    Initialisation failed.\n";
      status = -11;
      return;
    }
    m_ready = true;
  }
 
  double dx = 0., dy = 0.;
  double xLoc, yLoc;
  double fx, fy, u;
 
  // Sum up the contributions from all boundary elements
  for (int i = nElements; i--;) {
    dx = x - elements[i].cX;
    dy = y - elements[i].cY;
    // Transform to local coordinate system
    Rotate(dx, dy, elements[i].phi, Global2Local, xLoc, yLoc);
    // Compute the potential
    if (!ComputePotential(elements[i].geoType, elements[i].len, xLoc, yLoc,
                          u)) {
      std::cerr << m_className << "::ElectricField:\n";
      std::cerr << "    Potential contribution from element " << i
                << " could not be calculated.\n";
      status = -11;
      return;
    }
    // Compute the field
    if (!ComputeFlux(elements[i].geoType, elements[i].len, elements[i].phi,
                     xLoc, yLoc, fx, fy)) {
      std::cerr << m_className << "::ElectricField:\n";
      std::cerr << "    Field contribution from element " << i
                << " could not be calculated.\n";
      status = -11;
      return;
    }
    v += u * elements[i].solution;
    ex += fx * elements[i].solution;
    ey += fy * elements[i].solution;
  }
}

◆ ElectricField() [2/2]

void Garfield::ComponentNeBem2d::ElectricField	(	const double	x,
		const double	y,
		const double	z,
		double &	ex,
		double &	ey,
		double &	ez,
		Medium *&	m,
		int &	status
	)

virtual

Calculate the drift field at given point.

Parameters

x,y,z	coordinates [cm].
ex,ey,ez	components of the electric field [V/cm].
m	pointer to the medium at this location.
status	status flag

Status flags:

        0: Inside an active medium
      > 0: Inside a wire of type X
-4 ... -1: On the side of a plane where no wires are
       -5: Inside the mesh but not in an active medium
       -6: Outside the mesh
      -10: Unknown potential type (should not occur)
    other: Other cases (should not occur)

Implements Garfield::ComponentBase.

Definition at line 90 of file ComponentNeBem2d.cc.

                                                                          {
 
  double v = 0.;
  ElectricField(x, y, z, ex, ey, ez, v, m, status);
}

Referenced by ElectricField().

◆ EnableAutoResizing()

void Garfield::ComponentNeBem2d::EnableAutoResizing ( )

inline

Definition at line 40 of file ComponentNeBem2d.hh.

40{ autoSize = true; }

◆ EnableRandomCollocation()

void Garfield::ComponentNeBem2d::EnableRandomCollocation ( )

inline

Definition at line 42 of file ComponentNeBem2d.hh.

42{ randomCollocation = true; }

◆ GetNumberOfElements()

int Garfield::ComponentNeBem2d::GetNumberOfElements ( )

inline

Definition at line 48 of file ComponentNeBem2d.hh.

48{ return nElements; }

◆ GetNumberOfPanels()

int Garfield::ComponentNeBem2d::GetNumberOfPanels ( )

inline

Definition at line 46 of file ComponentNeBem2d.hh.

46{ return nPanels; }

◆ GetNumberOfWires()

int Garfield::ComponentNeBem2d::GetNumberOfWires ( )

inline

Definition at line 47 of file ComponentNeBem2d.hh.

47{ return nWires; }

◆ GetVoltageRange()

bool Garfield::ComponentNeBem2d::GetVoltageRange	(	double &	vmin,
		double &	vmax
	)

virtual

Calculate the voltage range [V].

Implements Garfield::ComponentBase.

Definition at line 98 of file ComponentNeBem2d.cc.

                                                                 {
 
  if (nPanels <= 0 && nWires <= 0) return false;
  bool gotValue = false;
 
  for (int i = nPanels; i--;) {
    if (panels[i].bcType != 0) continue;
    if (!gotValue) {
      vmin = vmax = panels[i].bcValue;
      gotValue = true;
    } else {
      if (panels[i].bcValue < vmin) vmin = panels[i].bcValue;
      if (panels[i].bcValue > vmax) vmax = panels[i].bcValue;
    }
  }
 
  for (int i = nWires; i--;) {
    if (!gotValue) {
      vmin = vmax = wires[i].bcValue;
      gotValue = true;
    } else {
      if (wires[i].bcValue < vmin) vmin = wires[i].bcValue;
      if (wires[i].bcValue > vmax) vmax = wires[i].bcValue;
    }
  }
 
  return gotValue;
}

◆ SetMaxNumberOfIterations()

void Garfield::ComponentNeBem2d::SetMaxNumberOfIterations ( const int niter )

Definition at line 251 of file ComponentNeBem2d.cc.

                                                               {
 
  if (niter <= 0) {
    std::cerr << m_className << "::SetMaxNumberOfIterations:\n";
    std::cerr << "    Number of iterations must be greater than zero.\n";
    return;
  }
 
  nMaxIterations = niter;
}

◆ SetMinimumElementSize()

void Garfield::ComponentNeBem2d::SetMinimumElementSize ( const double min )

Definition at line 238 of file ComponentNeBem2d.cc.

                                                             {
 
  if (min < Small) {
    std::cerr << m_className << "::SetMinimumElementSize:\n";
    std::cerr << "    Provided element size is too small.\n";
    return;
  }
 
  minSize = min;
  m_ready = false;
  matrixInversionFlag = false;
}

◆ SetNumberOfCollocationPoints()

void Garfield::ComponentNeBem2d::SetNumberOfCollocationPoints ( const int ncoll )

Definition at line 225 of file ComponentNeBem2d.cc.

                                                                   {
 
  if (ncoll <= 0) {
    std::cerr << m_className << "::SetNumberOfCollocationPoints:\n";
    std::cerr << "    Number of coll. points must be greater than zero.\n";
    return;
  }
 
  nCollocationPoints = ncoll;
  m_ready = false;
  matrixInversionFlag = false;
}

◆ SetNumberOfDivisions()

void Garfield::ComponentNeBem2d::SetNumberOfDivisions ( const int ndiv )

Definition at line 212 of file ComponentNeBem2d.cc.

                                                          {
 
  if (ndiv <= 0) {
    std::cerr << m_className << "::SetNumberOfDivisions:\n";
    std::cerr << "    Number of divisions must be greater than zero.\n";
    return;
  }
 
  nDivisions = ndiv;
  m_ready = false;
  matrixInversionFlag = false;
}

◆ SetProjectionX()

void Garfield::ComponentNeBem2d::SetProjectionX ( )

inline

Definition at line 27 of file ComponentNeBem2d.hh.

27{ projAxis = 0; }

◆ SetProjectionY()

void Garfield::ComponentNeBem2d::SetProjectionY ( )

inline

Definition at line 28 of file ComponentNeBem2d.hh.

28{ projAxis = 1; }

◆ SetProjectionZ()

void Garfield::ComponentNeBem2d::SetProjectionZ ( )

inline

Definition at line 29 of file ComponentNeBem2d.hh.

29{ projAxis = 2; }

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ComponentNeBem2d()

◆ ~ComponentNeBem2d()

Member Function Documentation

◆ AddPanel()

◆ AddWire()

◆ DisableAutoResizing()

◆ DisableRandomCollocation()

◆ ElectricField() [1/2]

◆ ElectricField() [2/2]

◆ EnableAutoResizing()

◆ EnableRandomCollocation()

◆ GetNumberOfElements()

◆ GetNumberOfPanels()

◆ GetNumberOfWires()

◆ GetVoltageRange()

◆ SetMaxNumberOfIterations()

◆ SetMinimumElementSize()

◆ SetNumberOfCollocationPoints()

◆ SetNumberOfDivisions()

◆ SetProjectionX()

◆ SetProjectionY()

◆ SetProjectionZ()