Interpolation in a two-dimensional field map created by Sentaurus Device. More...

#include <ComponentTcad2d.hh>

Inheritance diagram for Garfield::ComponentTcad2d:

Public Member Functions
	ComponentTcad2d ()
	Constructor.

	~ComponentTcad2d ()
	Destructor.

void	ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, double &v, Medium *&m, int &status) override
	Calculate the drift field [V/cm] and potential [V] at (x, y, z).

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

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

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

bool	GetElementaryCell (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) override
	Get the coordinates of the elementary cell.

void	SetRangeZ (const double zmin, const double zmax)
	Set the z-extent of the bounding box (default: unlimited).

bool	GetElement (const size_t i, double &vol, double &dmin, double &dmax, int &type, std::vector< size_t > &nodes, int &reg) const

bool	GetNode (const size_t i, double &x, double &y, double &v, double &ex, double &ey) const

Public Member Functions inherited from Garfield::ComponentTcadBase< 2 >
	ComponentTcadBase ()=delete
	Default constructor.

	ComponentTcadBase (const std::string &name)
	Constructor.

virtual	~ComponentTcadBase ()
	Destructor.

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

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

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

bool	Initialise (const std::string &gridfilename, const std::string &datafilename)

bool	SetWeightingField (const std::string &datfile1, const std::string &datfile2, const double dv, const std::string &label)

bool	SetWeightingFieldShift (const std::string &label, const double x, const double y, const double z)

void	PrintRegions () const
	List all currently defined regions.

size_t	GetNumberOfRegions () const
	Get the number of regions in the device.

void	GetRegion (const size_t ireg, std::string &name, bool &active) const
	Get the name and "active volume" flag of a region.

void	SetDriftRegion (const size_t ireg)
	Make a region active ("driftable").

void	UnsetDriftRegion (const size_t ireg)
	Make a region inactive.

void	SetMedium (const size_t ireg, Medium *m)
	Set the medium to be associated to a given region.

size_t	GetNumberOfElements () const
	Get the number of elements in the mesh.

size_t	GetNumberOfNodes () const
	Get the number of vertices in the mesh.

void	EnableVelocityMap (const bool on)
	Switch use of the imported velocity map on/off.

bool	HasVelocityMap () const override
	Does the component have velocity maps?

bool	ElectronVelocity (const double x, const double y, const double z, double &vx, double &vy, double &vz) override
	Get the electron drift velocity.

bool	HoleVelocity (const double x, const double y, const double z, double &vx, double &vy, double &vz) override
	Get the hole drift velocity.

size_t	GetNumberOfDonors ()
	Get the number of donor states found in the map.

size_t	GetNumberOfAcceptors ()
	Get the number of acceptor states found in the map.

bool	SetDonor (const size_t donorNumber, const double exsec, const double hxsec, const double concentration)

bool	SetAcceptor (const size_t acceptorNumber, const double exsec, const double hxsec, const double concentration)
	Set the properties of an acceptor-type defect state.

void	EnableAttachmentMap (const bool on)
	Switch use of the imported trapping map on/off.

bool	HasAttachmentMap () const override
	Does the component have attachment maps?

bool	ElectronAttachment (const double x, const double y, const double z, double &eta) override
	Get the electron attachment coefficient.

bool	HoleAttachment (const double x, const double y, const double z, double &eta) override
	Get the hole attachment coefficient.

bool	GetElectronLifetime (const double x, const double y, const double z, double &etau) override

bool	GetHoleLifetime (const double x, const double y, const double z, double &htau) override

bool	GetElectronMobility (const double x, const double y, const double z, double &mob)

bool	GetHoleMobility (const double x, const double y, const double z, double &mob)

Public Member Functions inherited from Garfield::Component
	Component ()=delete
	Default constructor.

	Component (const std::string &name)
	Constructor.

virtual	~Component ()
	Destructor.

virtual void	SetGeometry (Geometry *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
	Calculate the drift field [V/cm] and potential [V] at (x, y, z).

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	DelayedWeightingField (const double x, const double y, const double z, const double t, double &wx, double &wy, double &wz, const std::string &label)

virtual double	DelayedWeightingPotential (const double x, const double y, const double z, const double t, 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	GetElementaryCell (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax)
	Get the coordinates of the elementary cell.

double	IntegrateFluxCircle (const double xc, const double yc, const double r, const unsigned int nI=50)

double	IntegrateFluxSphere (const double xc, const double yc, const double zc, const double r, const unsigned int nI=20)

double	IntegrateFluxParallelogram (const double x0, const double y0, const double z0, const double dx1, const double dy1, const double dz1, const double dx2, const double dy2, const double dz2, const unsigned int nU=20, const unsigned int nV=20)

double	IntegrateWeightingFluxParallelogram (const std::string &label, const double x0, const double y0, const double z0, const double dx1, const double dy1, const double dz1, const double dx2, const double dy2, const double dz2, const unsigned int nU=20, const unsigned int nV=20)

double	IntegrateFluxLine (const double x0, const double y0, const double z0, const double x1, const double y1, const double z1, const double xp, const double yp, const double zp, const unsigned int nI, const int isign=0)

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, const bool centre, double &rc)

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	EnablePeriodicityY (const bool on=true)
	Enable simple periodicity in the direction.

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

void	IsPeriodic (bool &perx, bool &pery, bool &perz)
	Return periodicity flags.

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

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

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

void	IsMirrorPeriodic (bool &perx, bool &pery, bool &perz)
	Return mirror periodicity flags.

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

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

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

void	IsAxiallyPeriodic (bool &perx, bool &pery, bool &perz)
	Return axial periodicity flags.

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

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

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

void	IsRotationSymmetric (bool &rotx, bool &roty, bool &rotz)
	Return rotation symmetry flags.

void	EnableDebugging ()
	Switch on debugging messages.

void	DisableDebugging ()
	Switch off debugging messages.

virtual bool	HasAttachmentMap () const
	Does the component have attachment maps?

virtual bool	HasVelocityMap () const
	Does the component have velocity maps?

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 bool	ElectronVelocity (const double, const double, const double, double &vx, double &vy, double &vz)
	Get the electron drift velocity.

virtual bool	HoleVelocity (const double, const double, const double, double &vx, double &vy, double &vz)
	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
Protected Member Functions inherited from Garfield::ComponentTcadBase< 2 >
void	UpdatePeriodicity () override
	Verify periodicities.

void	Cleanup ()

virtual bool	Interpolate (const double x, const double y, const double z, const std::vector< double > &field, double &f)=0

virtual bool	Interpolate (const double x, const double y, const double z, const std::vector< std::array< double, N > > &field, double &fx, double &fy, double &fz)=0

virtual void	FillTree ()=0

size_t	FindRegion (const std::string &name) const

void	MapCoordinates (std::array< double, N > &x, std::array< bool, N > &mirr) const

bool	InBoundingBox (const std::array< double, N > &x) const

void	UpdateAttachment ()

bool	LoadGrid (const std::string &gridfilename)

bool	LoadData (const std::string &datafilename)

bool	ReadDataset (std::ifstream &datafile, const std::string &dataset)

bool	LoadWeightingField (const std::string &datafilename, std::vector< std::array< double, N > > &wf, std::vector< double > &wp)

virtual void	Reset ()=0
	Reset the component.

virtual void	UpdatePeriodicity ()=0
	Verify periodicities.

Static Protected Member Functions inherited from Garfield::ComponentTcadBase< 2 >
static unsigned int	ElementVertices (const Element &element)

Protected Attributes inherited from Garfield::ComponentTcadBase< 2 >
std::vector< Region >	m_regions

std::vector< std::array< double, N > >	m_vertices

std::vector< Element >	m_elements

std::vector< double >	m_epot

std::vector< std::array< double, N > >	m_efield

std::vector< std::array< double, N > >	m_wfield

std::vector< double >	m_wpot

std::vector< std::string >	m_wlabel

std::vector< std::array< double, 3 > >	m_wshift

std::vector< std::array< double, N > >	m_eVelocity

std::vector< std::array< double, N > >	m_hVelocity

std::vector< double >	m_eMobility

std::vector< double >	m_hMobility

std::vector< double >	m_eLifetime

std::vector< double >	m_hLifetime

std::vector< std::vector< float > >	m_donorOcc

std::vector< std::vector< float > >	m_acceptorOcc

std::vector< double >	m_eAttachment

std::vector< double >	m_hAttachment

std::vector< Defect >	m_donors

std::vector< Defect >	m_acceptors

bool	m_useVelocityMap

bool	m_useAttachmentMap

std::array< double, 3 >	m_bbMin

std::array< double, 3 >	m_bbMax

double	m_pMin

double	m_pMax

Protected Attributes inherited from Garfield::Component
std::string	m_className = "Component"
	Class name.

Geometry *	m_geometry = nullptr
	Pointer to the geometry.

std::array< double, 3 >	m_b0 = {{0., 0., 0.}}
	Constant magnetic field.

bool	m_ready = false
	Ready for use?

bool	m_debug = false
	Switch on/off debugging messages.

std::array< bool, 3 >	m_periodic = {{false, false, false}}
	Simple periodicity in x, y, z.

std::array< bool, 3 >	m_mirrorPeriodic = {{false, false, false}}
	Mirror periodicity in x, y, z.

std::array< bool, 3 >	m_axiallyPeriodic = {{false, false, false}}
	Axial periodicity in x, y, z.

std::array< bool, 3 >	m_rotationSymmetric = {{false, false, false}}
	Rotation symmetry around x-axis, y-axis, z-axis.

Static Protected Attributes inherited from Garfield::ComponentTcadBase< 2 >
static constexpr size_t	nMaxVertices

Detailed Description

Interpolation in a two-dimensional field map created by Sentaurus Device.

Definition at line 13 of file ComponentTcad2d.hh.

Constructor & Destructor Documentation

◆ ComponentTcad2d()

Garfield::ComponentTcad2d::ComponentTcad2d ( )

Constructor.

Definition at line 11 of file ComponentTcad2d.cc.

11: ComponentTcadBase("Tcad2d") {}

Garfield::ComponentTcadBase< 2 >::ComponentTcadBase

ComponentTcadBase()=delete

Default constructor.

◆ ~ComponentTcad2d()

Garfield::ComponentTcad2d::~ComponentTcad2d ( )

inline

Destructor.

Definition at line 18 of file ComponentTcad2d.hh.

18{}

Member Function Documentation

◆ ElectricField() [1/2]

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

overridevirtual

Calculate the drift field [V/cm] and potential [V] at (x, y, z).

Implements Garfield::Component.

Definition at line 13 of file ComponentTcad2d.cc.

                                                 {
  // Assume this will work.
  status = 0;
  // Initialise.
  ex = ey = ez = p = 0.;
  m = nullptr;
 
  // Make sure the field map has been loaded.
  if (!m_ready) {
    std::cerr << m_className << "::ElectricField:\n"
              << "    Field map is not available for interpolation.\n";
    status = -10;
    return;
  }
 
  if (m_hasRangeZ && (zin < m_bbMin[2] || zin > m_bbMax[2])) {
    status = -6;
    return;
  }
  // In case of periodicity, reduce to the cell volume.
  std::array<double, 2> x = {xin, yin};
  std::array<bool, 2> mirr = {false, false};
  MapCoordinates(x, mirr);
  // Check if the point is inside the bounding box.
  if (!InBoundingBox(x)) {
    status = -6;
    return;
  }
 
  std::array<double, nMaxVertices> w;
  const auto i = FindElement(x[0], x[1], w);
  if (i >= m_elements.size()) {
    // Point is outside the mesh.
    status = -6;
    return;
  }
 
  const Element& element = m_elements[i];
  const size_t nVertices = ElementVertices(element);
  for (size_t j = 0; j < nVertices; ++j) {
    const size_t index = element.vertex[j];
    ex += w[j] * m_efield[index][0];
    ey += w[j] * m_efield[index][1];
    p += w[j] * m_epot[index];
  }
  if (mirr[0]) ex = -ex;
  if (mirr[1]) ey = -ey;
  m = m_regions[element.region].medium;
  if (!m_regions[element.region].drift || !m) status = -5;
}

Referenced by ElectricField().

◆ ElectricField() [2/2]

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

inlineoverridevirtual

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::Component.

Definition at line 24 of file ComponentTcad2d.hh.

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

◆ GetBoundingBox()

bool Garfield::ComponentTcad2d::GetBoundingBox	(	double &	xmin,
		double &	ymin,
		double &	zmin,
		double &	xmax,
		double &	ymax,
		double &	zmax
	)

overridevirtual

Get the bounding box coordinates.

Reimplemented from Garfield::Component.

Definition at line 174 of file ComponentTcad2d.cc.

                                                                               {
  if (!m_ready) return false;
  if (m_periodic[0] || m_mirrorPeriodic[0]) {
    xmin = -std::numeric_limits<double>::infinity();
    xmax = +std::numeric_limits<double>::infinity();
  } else {
    xmin = m_bbMin[0];
    xmax = m_bbMax[0];
  }
 
  if (m_periodic[1] || m_mirrorPeriodic[1]) {
    ymin = -std::numeric_limits<double>::infinity();
    ymax = +std::numeric_limits<double>::infinity();
  } else {
    ymin = m_bbMin[1];
    ymax = m_bbMax[1];
  }
 
  if (m_hasRangeZ) {
    zmin = m_bbMin[2];
    zmax = m_bbMax[2];
  }
  return true;
}

◆ GetElement()

bool Garfield::ComponentTcad2d::GetElement	(	const size_t	i,
		double &	vol,
		double &	dmin,
		double &	dmax,
		int &	type,
		std::vector< size_t > &	nodes,
		int &	reg
	)		const

Retrieve the properties of an element.

Parameters

i	index of the element
vol	volume
dmin	smallest length in the element
dmax	largest length in the element
type	element type
nodes	indices of the constituent vertices
reg	region

Definition at line 230 of file ComponentTcad2d.cc.

                                                                           {
  nodes.clear();
  if (i >= m_elements.size()) {
    std::cerr << m_className << "::GetElement: Index out of range.\n";
    return false;
  }
 
  const Element& element = m_elements[i];
  if (element.type == 0) {
    dmin = dmax = vol = 0;
  } else if (element.type == 1) {
    const auto& v0 = m_vertices[element.vertex[0]];
    const auto& v1 = m_vertices[element.vertex[1]];
    const double d = std::hypot(v1[0] - v0[0], v1[1] - v0[1]);
    dmin = dmax = vol = d;
  } else if (m_elements[i].type == 2) {
    const auto& v0 = m_vertices[element.vertex[0]];
    const auto& v1 = m_vertices[element.vertex[1]];
    const auto& v2 = m_vertices[element.vertex[2]];
    vol = 0.5 * fabs((v2[0] - v0[0]) * (v1[1] - v0[1]) - 
                     (v2[1] - v0[1]) * (v1[0] - v0[0]));
    const double a = std::hypot(v1[0] - v0[0], v1[1] - v0[1]);
    const double b = std::hypot(v2[0] - v0[0], v2[1] - v0[1]);
    const double c = std::hypot(v1[0] - v2[0], v1[1] - v2[1]);
    dmin = std::min({a, b, c});
    dmax = std::max({a, b, c});
  } else if (m_elements[i].type == 3) {
    const auto& v0 = m_vertices[element.vertex[0]];
    const auto& v1 = m_vertices[element.vertex[1]];
    const auto& v3 = m_vertices[element.vertex[3]];
    const double a = std::hypot(v1[0] - v0[0], v1[1] - v0[1]);
    const double b = std::hypot(v3[0] - v0[0], v3[1] - v0[1]);
    vol = a * b;
    dmin = std::min(a, b);
    dmax = sqrt(a * a + b * b);
  } else {
    std::cerr << m_className << "::GetElement:\n"
              << "    Unexpected element type (" << type << ")\n";
    return false;
  }
  const size_t nVertices = ElementVertices(element);
  for (size_t j = 0; j < nVertices; ++j) {
    nodes.push_back(element.vertex[j]);
  }
  reg = element.region;
  return true;
}

◆ GetElementaryCell()

bool Garfield::ComponentTcad2d::GetElementaryCell	(	double &	xmin,
		double &	ymin,
		double &	zmin,
		double &	xmax,
		double &	ymax,
		double &	zmax
	)

overridevirtual

Get the coordinates of the elementary cell.

Reimplemented from Garfield::Component.

Definition at line 200 of file ComponentTcad2d.cc.

                                              {
  if (!m_ready) return false;
  xmin = m_bbMin[0];
  xmax = m_bbMax[0];
  ymin = m_bbMin[1];
  ymax = m_bbMax[1];
  if (m_hasRangeZ) {
    zmin = m_bbMin[2];
    zmax = m_bbMax[2];
  } else {
    const double xymax = std::max({fabs(xmin), fabs(xmax), 
                                   fabs(ymin), fabs(ymax)});
    zmin = -xymax;
    zmax = +xymax;
  }
  return true;
}

◆ GetMedium()

Medium * Garfield::ComponentTcad2d::GetMedium	(	const double	x,
		const double	y,
		const double	z
	)

overridevirtual

Get the medium at a given location (x, y, z).

Reimplemented from Garfield::Component.

Definition at line 125 of file ComponentTcad2d.cc.

                                                     {
  // Make sure the field map has been loaded.
  if (!m_ready) {
    std::cerr << m_className << "::GetMedium:\n"
              << "    Field map not available for interpolation.\n";
    return nullptr;
  }
 
  if (m_hasRangeZ && (zin < m_bbMin[2] || zin > m_bbMax[2])) return nullptr;
  std::array<double, 2> x = {xin, yin};
  std::array<bool, 2> mirr = {false, false};
  MapCoordinates(x, mirr);
  // Check if the point is inside the bounding box.
  if (!InBoundingBox(x)) return nullptr;
 
  // Determine the shape functions.
  std::array<double, nMaxVertices> w;
  const size_t i = FindElement(x[0], x[1], w);
  if (i >= m_elements.size()) {
    // Point is outside the mesh.
    return nullptr;
  }
  return m_regions[m_elements[i].region].medium;
}

◆ GetNode()

bool Garfield::ComponentTcad2d::GetNode	(	const size_t	i,
		double &	x,
		double &	y,
		double &	v,
		double &	ex,
		double &	ey
	)		const

Get the coordinates of a mesh node and the potential and electric field at this node.

Definition at line 280 of file ComponentTcad2d.cc.

                                                                       {
  if (i >= m_vertices.size()) {
    std::cerr << m_className << "::GetNode: Index out of range.\n";
    return false;
  }
 
  x = m_vertices[i][0];
  y = m_vertices[i][1];
  if (!m_epot.empty()) v = m_epot[i];
  if (!m_efield.empty()) {
    ex = m_efield[i][0];
    ey = m_efield[i][1];
  }
  return true;
}

◆ SetRangeZ()

void Garfield::ComponentTcad2d::SetRangeZ	(	const double	zmin,
		const double	zmax
	)

Set the z-extent of the bounding box (default: unlimited).

Definition at line 220 of file ComponentTcad2d.cc.

                                                                    {
  if (fabs(zmax - zmin) <= 0.) {
    std::cerr << m_className << "::SetRangeZ: Zero range is not permitted.\n";
    return;
  }
  m_bbMin[2] = std::min(zmin, zmax);
  m_bbMax[2] = std::max(zmin, zmax);
  m_hasRangeZ = true;
}

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ComponentTcad2d()

◆ ~ComponentTcad2d()

Member Function Documentation

◆ ElectricField() [1/2]

◆ ElectricField() [2/2]

◆ GetBoundingBox()

◆ GetElement()

◆ GetElementaryCell()

◆ GetMedium()

◆ GetNode()

◆ SetRangeZ()