Garfield::ComponentConstant Class Reference

Component with constant electric field. More...

#include <ComponentConstant.hh>

Inheritance diagram for Garfield::ComponentConstant:

Public Member Functions
	ComponentConstant ()
	Constructor.
	~ComponentConstant ()
	Destructor.
void	ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, Medium *&m, int &status) override
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).
bool	GetVoltageRange (double &vmin, double &vmax) override
	Calculate the voltage range [V].
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
void	SetElectricField (const double ex, const double ey, const double ez)
	Set the components of the electric field [V / cm].
void	SetPotential (const double x, const double y, const double z, const double v=0.)
	Specify the potential at a given point.
void	SetWeightingField (const double wx, const double wy, const double wz, const std::string label)
	Set the components of the weighting field [1 / cm].
void	SetWeightingPotential (const double x, const double y, const double z, const double v=0.)
	Specify the weighting potential at a given point.
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
	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 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.
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	IntegrateFlux (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)
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	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
	Reset the component.
virtual void	UpdatePeriodicity ()=0
	Verify periodicities.
Protected Attributes inherited from Garfield::ComponentBase
std::string	m_className = "ComponentBase"
	Class name.
GeometryBase *	m_geometry = nullptr
	Pointer to the geometry.
bool	m_ready = false
	Ready for use?
bool	m_activeTraps = false
	Does the component have traps?
bool	m_hasVelocityMap = false
	Does the component have velocity maps?
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.
double	m_bx0 = 0.
double	m_by0 = 0.
double	m_bz0 = 0.
bool	m_debug = false
	Switch on/off debugging messages.

Detailed Description

Component with constant electric field.

Definition at line 10 of file ComponentConstant.hh.

Constructor & Destructor Documentation

ComponentConstant()

Garfield::ComponentConstant::ComponentConstant

(

)

Constructor.

Definition at line 8 of file ComponentConstant.cc.

                                     : ComponentBase() {
  m_className = "ComponentConstant";
}

~ComponentConstant()

Garfield::ComponentConstant::~ComponentConstant ( )

inline

Destructor.

Definition at line 15 of file ComponentConstant.hh.

{}

Member Function Documentation

ElectricField() [1/2]

void Garfield::ComponentConstant::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::ComponentBase.

Definition at line 35 of file ComponentConstant.cc.

                                                   {
  ex = m_fx;
  ey = m_fy;
  ez = m_fz;
  if (m_hasPotential) {
    v = m_v0 - (x - m_x0) * m_fx - (y - m_y0) * m_fy - (z - m_z0) * m_fz;
  } else {
    v = 0.;
    if (m_debug) {
      std::cerr << m_className << "::ElectricField: Potential not defined.\n";
    }
  }
 
  m = GetMedium(x, y, z);
  if (!m) {
    if (m_debug) {
      std::cout << m_className << "::ElectricField: No medium at ("
                << x << ", " << y << ", " << z << ").\n";
    }
    status = -6;
    return;
  }
 
  if (m->IsDriftable()) {
    status = 0;
  } else {
    status = -5;
  }
}

ElectricField() [2/2]

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

overridevirtual

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 12 of file ComponentConstant.cc.

                                                                           {
  ex = m_fx;
  ey = m_fy;
  ez = m_fz;
  m = GetMedium(x, y, z);
  if (!m) {
    if (m_debug) {
      std::cout << m_className << "::ElectricField: No medium at ("
                << x << ", " << y << ", " << z << ").\n";
    }
    status = -6;
    return;
  }
 
  if (m->IsDriftable()) {
    status = 0;
  } else {
    status = -5;
  }
}

GetVoltageRange()

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

overridevirtual

Calculate the voltage range [V].

Implements Garfield::ComponentBase.

Definition at line 68 of file ComponentConstant.cc.

                                                                  {
  if (!m_hasPotential) return false;
 
  if (!m_geometry) {
    std::cerr << m_className << "::GetVoltageRange: Geometry not set.\n";
    return false;
  }
  double xmin, ymin, zmin;
  double xmax, ymax, zmax;
  if (!GetBoundingBox(xmin, ymin, zmin, xmax, ymax, zmax)) {
    std::cerr << m_className << "::GetVoltageRange:\n"
              << "    Could not determine the bounding box.\n";
    return false;
  }
  // Calculate potentials at each corner
  const double pxmin = m_v0 - (xmin - m_x0) * m_fx;
  const double pxmax = m_v0 - (xmax - m_x0) * m_fx;
  const double pymin = m_v0 - (ymin - m_y0) * m_fy;
  const double pymax = m_v0 - (ymax - m_y0) * m_fy;
  const double pzmin = m_v0 - (zmin - m_z0) * m_fz;
  const double pzmax = m_v0 - (zmax - m_z0) * m_fz;
  double p[8];
  p[0] = pxmin + pymin + pzmin;
  p[1] = pxmin + pymin + pzmax;
  p[2] = pxmin + pymax + pzmin;
  p[3] = pxmin + pymax + pzmax;
  p[4] = pxmax + pymin + pzmin;
  p[5] = pxmax + pymin + pzmax;
  p[6] = pxmax + pymax + pzmin;
  p[7] = pxmax + pymax + pzmax;
  vmin = vmax = p[7];
  for (int i = 7; i--;) {
    if (p[i] > vmax) vmax = p[i];
    if (p[i] < vmin) vmin = p[i];
  }
 
  return true;
}

SetElectricField()

void Garfield::ComponentConstant::SetElectricField	(	const double	ex,
		const double	ey,
		const double	ez
	)

Set the components of the electric field [V / cm].

Definition at line 137 of file ComponentConstant.cc.

                                                          {
  m_fx = ex;
  m_fy = ey;
  m_fz = ez;
  if (m_fx * m_fx + m_fy * m_fy + m_fz * m_fz > Small) return;
 
  std::cerr << m_className << "::SetElectricField: Field set to zero.\n";
  m_ready = true;
}

SetPotential()

void Garfield::ComponentConstant::SetPotential	(	const double	x,
		const double	y,
		const double	z,
		const double	v = 0.
	)

Specify the potential at a given point.

Definition at line 148 of file ComponentConstant.cc.

                                                                     {
  m_x0 = x;
  m_y0 = y;
  m_z0 = z;
  m_v0 = v;
  m_hasPotential = true;
}

SetWeightingField()

void Garfield::ComponentConstant::SetWeightingField	(	const double	wx,
		const double	wy,
		const double	wz,
		const std::string	label
	)

Set the components of the weighting field [1 / cm].

Definition at line 157 of file ComponentConstant.cc.

                                                                 {
  m_wfield = label;
  m_fwx = wx;
  m_fwy = wy;
  m_fwz = wz;
  m_hasWeightingField = true;
}

SetWeightingPotential()

void Garfield::ComponentConstant::SetWeightingPotential	(	const double	x,
		const double	y,
		const double	z,
		const double	v = 0.
	)

Specify the weighting potential at a given point.

Definition at line 167 of file ComponentConstant.cc.

                                                                              {
  if (!m_hasWeightingField) {
    std::cerr << m_className << "::SetWeightingPotential:\n"
              << "    Set the weighting field first!\n";
    return;
  }
  m_wx0 = x;
  m_wy0 = y;
  m_wz0 = z;
  m_w0 = v;
  m_hasWeightingPotential = true;
}

WeightingField()

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

overridevirtual

Calculate the weighting field at a given point and for a given electrode.

Parameters

x,y,z	coordinates [cm].
wx,wy,wz	components of the weighting field [1/cm].
label	name of the electrode

Reimplemented from Garfield::ComponentBase.

Definition at line 107 of file ComponentConstant.cc.

                                                                           {
  if (!m_hasWeightingField || label != m_wfield) return;
 
  Medium* m = GetMedium(x, y, z);
  if (!m) {
    wx = wy = wz = 0.;
    if (m_debug) {
      std::cout << m_className << "::WeightingField: No medium at ("
                << x << ", " << y << ", " << z << ")\n";
    }
    return;
  }
  wx = m_fwx;
  wy = m_fwy;
  wz = m_fwz;
}

WeightingPotential()

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

overridevirtual

Calculate the weighting potential at a given point.

Parameters

x,y,z	coordinates [cm].
label	name of the electrode.

Returns

weighting potential [dimensionless].

Reimplemented from Garfield::ComponentBase.

Definition at line 126 of file ComponentConstant.cc.

                                                                     {
  if (!m_hasWeightingPotential || label != m_wfield) return 0.;
 
  Medium* m = GetMedium(x, y, z);
  if (!m) return 0.;
 
  return m_w0 - (x - m_wx0) * m_fwx - (y - m_wy0) * m_fwy - (z - m_wz0) * m_fwz;
}

---

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

• ComponentConstant.hh
• ComponentConstant.cc