Garfield::ComponentVoxel Class Reference

Component for interpolating field maps stored in a regular mesh. More...

#include <ComponentVoxel.hh>

Inheritance diagram for Garfield::ComponentVoxel:

Public Member Functions
	ComponentVoxel ()
	Constructor.
	~ComponentVoxel ()
	Destructor.
void	Clear () override
	Reset.
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
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	DelayedWeightingField (const double x, const double y, const double z, const double t, double &wx, double &wy, double &wz, const std::string &label) override
void	MagneticField (const double x, const double y, const double z, double &bx, double &by, double &bz, int &status) override
void	EnableInterpolation (const bool on=true)
	Interpolate between field values at the element centres.
void	SetWeightingFieldOffset (const double x, const double y, const double z)
Medium *	GetMedium (const double x, const double y, const double z) override
	Get the medium at a given location (x, y, z).
bool	GetVoltageRange (double &vmin, double &vmax) override
	Calculate the voltage range [V].
bool	GetElectricFieldRange (double &exmin, double &exmax, double &eymin, double &eymax, double &ezmin, double &ezmax)
bool	GetBoundingBox (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) override
	Get the bounding box coordinates.
void	SetMesh (const unsigned int nx, const unsigned int ny, const unsigned int nz, const double xmin, const double xmax, const double ymin, const double ymax, const double zmin, const double zmax)
bool	LoadElectricField (const std::string &filename, const std::string &format, const bool withPotential, const bool withRegion, const double scaleX=1., const double scaleE=1., const double scaleP=1.)
bool	LoadWeightingField (const std::string &filename, const std::string &format, const bool withPotential, const double scaleX=1., const double scaleE=1., const double scaleP=1.)
	Import (prompt) weighting field from file.
bool	LoadWeightingField (const std::string &filename, const std::string &format, const double time, const bool withPotential, const double scaleX=1., const double scaleE=1., const double scaleP=1.)
	Import delayed weighting field from file.
bool	LoadMagneticField (const std::string &filename, const std::string &format, const double scaleX=1., const double scaleB=1.)
	Import magnetic field values from a file.
bool	GetElement (const double xi, const double yi, const double zi, unsigned int &i, unsigned int &j, unsigned int &k, bool &xMirrored, bool &yMirrored, bool &zMirrored) const
	Return the indices of the element at a given point.
bool	GetElement (const unsigned int i, const unsigned int j, const unsigned int k, double &v, double &ex, double &ey, double &ez) const
	Return the field for an element with given index.
void	SetMedium (const unsigned int i, Medium *m)
	Set the medium in region i.
Medium *	GetMedium (const unsigned int i) const
	Get the medium in region i.
void	PrintRegions () const
	Print all regions.
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 for interpolating field maps stored in a regular mesh.

Definition at line 10 of file ComponentVoxel.hh.

Constructor & Destructor Documentation

ComponentVoxel()

Garfield::ComponentVoxel::ComponentVoxel

(

)

Constructor.

Definition at line 14 of file ComponentVoxel.cc.

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

~ComponentVoxel()

Garfield::ComponentVoxel::~ComponentVoxel ( )

inline

Destructor.

Definition at line 15 of file ComponentVoxel.hh.

{}

Member Function Documentation

Clear()

void Garfield::ComponentVoxel::Clear ( )

inlineoverridevirtual

Reset.

Reimplemented from Garfield::ComponentBase.

Definition at line 17 of file ComponentVoxel.hh.

{ Reset(); }

DelayedWeightingField()

void Garfield::ComponentVoxel::DelayedWeightingField ( const double  x, const double  y, const double  z, const double  t, double &  wx, double &  wy, double &  wz, const std::string &  label  )

overridevirtual

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

Parameters

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

Reimplemented from Garfield::ComponentBase.

Definition at line 84 of file ComponentVoxel.cc.

                                                               {
 
  wx = wy = wz = 0.;
  if (m_wdtimes.empty()) return;
  // Assume no weighting field for times outside the range of available maps.
  if (t < m_wdtimes.front() || t > m_wdtimes.back()) return;
 
  const double xx = x - m_wField_xOffset;
  const double yy = y - m_wField_yOffset;
  const double zz = z - m_wField_zOffset;
 
  const auto it1 = std::upper_bound(m_wdtimes.cbegin(), m_wdtimes.cend(), t);
  const auto it0 = std::prev(it1);
 
  const double dt = t - *it0; 
  double wp = 0.;
  int region = 0;
  const unsigned int i0 = it0 - m_wdtimes.cbegin();
  double wx0 = 0., wy0 = 0., wz0 = 0.;
  if (!GetField(xx, yy, zz, m_wdfields[i0], wx0, wy0, wz0, wp, region)) {
    return;
  } 
  if (dt < Small || it1 == m_wdtimes.cend()) {
    wx = wx0;
    wy = wy0;
    wz = wz0;
    return; 
  }
  const unsigned int i1 = it1 - m_wdtimes.cbegin();
  double wx1 = 0., wy1 = 0., wz1 = 0.;
  if (!GetField(xx, yy, zz, m_wdfields[i1], wx1, wy1, wz1, wp, region)) {
    return;
  } 
  const double f1 = dt / (*it1 - *it0);
  const double f0 = 1. - f1;
  wx = f0 * wx0 + f1 * wx1;
  wy = f0 * wy0 + f1 * wy1;
  wz = f0 * wz0 + f1 * wz1;
}

ElectricField() [1/2]

void Garfield::ComponentVoxel::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 18 of file ComponentVoxel.cc.

                                                {
  m = nullptr;
  status = 0;
 
  // 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;
  }
 
  status = 0;
  int region = -1;
  if (!GetField(x, y, z, m_efields, ex, ey, ez, p, region)) {
    status = -6;
    return;
  }
 
  if (region < 0 || region > (int)m_media.size()) {
    m = nullptr;
    status = -5;
    return;
  }
  m = m_media[region];
  if (!m) status = -5;
}

Referenced by ElectricField().

ElectricField() [2/2]

void Garfield::ComponentVoxel::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 49 of file ComponentVoxel.cc.

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

EnableInterpolation()

void Garfield::ComponentVoxel::EnableInterpolation ( const bool  on = true )

inline

Interpolate between field values at the element centres.

Definition at line 38 of file ComponentVoxel.hh.

{ m_interpolate = on; }

GetBoundingBox()

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

overridevirtual

Get the bounding box coordinates.

Reimplemented from Garfield::ComponentBase.

Definition at line 567 of file ComponentVoxel.cc.

                                                                              {
  if (!m_ready) return false;
  if (m_periodic[0] || m_mirrorPeriodic[0]) {
    xmin = -INFINITY;
    xmax = +INFINITY;
  } else {
    xmin = m_xMin;
    xmax = m_xMax;
  }
 
  if (m_periodic[1] || m_mirrorPeriodic[1]) {
    ymin = -INFINITY;
    ymax = +INFINITY;
  } else {
    ymin = m_yMin;
    ymax = m_yMax;
  }
 
  if (m_periodic[2] || m_mirrorPeriodic[2]) {
    zmin = -INFINITY;
    zmax = +INFINITY;
  } else {
    zmin = m_zMin;
    zmax = m_zMax;
  }
  return true;
}

GetElectricFieldRange()

bool Garfield::ComponentVoxel::GetElectricFieldRange	(	double &	exmin,
		double &	exmax,
		double &	eymin,
		double &	eymax,
		double &	ezmin,
		double &	ezmax
	)

Definition at line 603 of file ComponentVoxel.cc.

                                                                         {
  if (!m_ready) {
    std::cerr << m_className << "::GetElectricFieldRange:\n"
              << "    Field map is not ready for interpolation.\n";
    return false;
  }
 
  exmin = exmax = m_efields[0][0][0].fx;
  eymin = eymax = m_efields[0][0][0].fy;
  ezmin = ezmax = m_efields[0][0][0].fz;
  for (unsigned int i = 0; i < m_nX; ++i) {
    for (unsigned int j = 0; j < m_nY; ++j) {
      for (unsigned int k = 0; k < m_nZ; ++k) {
        const Element& element = m_efields[i][j][k];
        if (element.fx < exmin) exmin = element.fx;
        if (element.fx > exmax) exmax = element.fx;
        if (element.fy < eymin) eymin = element.fy;
        if (element.fy > eymax) eymax = element.fy;
        if (element.fz < ezmin) ezmin = element.fz;
        if (element.fz > ezmax) ezmax = element.fz;
      }
    }
  }
  return true;
}

GetElement() [1/2]

bool Garfield::ComponentVoxel::GetElement	(	const double	xi,
		const double	yi,
		const double	zi,
		unsigned int &	i,
		unsigned int &	j,
		unsigned int &	k,
		bool &	xMirrored,
		bool &	yMirrored,
		bool &	zMirrored
	)		const

Return the indices of the element at a given point.

Definition at line 808 of file ComponentVoxel.cc.

                                                       {
  if (!m_hasMesh) {
    std::cerr << m_className << "::GetElement: Mesh is not set.\n";
    return false;
  }
 
  // Reduce the point to the basic cell (in case of periodicity) and
  // check if it is inside the mesh.
  const double x =
      Reduce(xi, m_xMin, m_xMax, m_periodic[0], m_mirrorPeriodic[0], xMirrored);
  if (x < m_xMin || x > m_xMax) return false;
  const double y =
      Reduce(yi, m_yMin, m_yMax, m_periodic[1], m_mirrorPeriodic[1], yMirrored);
  if (y < m_yMin || y > m_yMax) return false;
  const double z =
      Reduce(zi, m_zMin, m_zMax, m_periodic[2], m_mirrorPeriodic[2], zMirrored);
  if (z < m_zMin || z > m_zMax) return false;
 
  // Get the indices.
  i = (unsigned int)((x - m_xMin) / m_dx);
  j = (unsigned int)((y - m_yMin) / m_dy);
  k = (unsigned int)((z - m_zMin) / m_dz);
  if (i >= m_nX) i = m_nX - 1;
  if (j >= m_nY) j = m_nY - 1;
  if (k >= m_nZ) k = m_nZ - 1;
  return true;
}

Referenced by GetMedium().

GetElement() [2/2]

bool Garfield::ComponentVoxel::GetElement	(	const unsigned int	i,
		const unsigned int	j,
		const unsigned int	k,
		double &	v,
		double &	ex,
		double &	ey,
		double &	ez
	)		const

Return the field for an element with given index.

Definition at line 840 of file ComponentVoxel.cc.

                                                              {
  v = ex = ey = ez = 0.;
  if (!m_ready) {
    if (!m_hasMesh) {
      std::cerr << m_className << "::GetElement: Mesh not set.\n";
      return false;
    }
    std::cerr << m_className << "::GetElement: Field map not set.\n";
    return false;
  }
  if (i >= m_nX || j >= m_nY || k >= m_nZ) {
    std::cerr << m_className << "::GetElement: Index out of range.\n";
    return false;
  }
  const Element& element = m_efields[i][j][k];
  v = element.v;
  ex = element.fx;
  ey = element.fy;
  ez = element.fz;
  return true;
}

GetMedium() [1/2]

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

overridevirtual

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

Reimplemented from Garfield::ComponentBase.

Definition at line 149 of file ComponentVoxel.cc.

                                                  {
  // Make sure the field map has been loaded.
  if (!m_ready) {
    std::cerr << m_className << "::GetMedium:\n"
              << "    Field map is not available for interpolation.\n";
    return nullptr;
  }
 
  unsigned int i, j, k;
  bool xMirrored, yMirrored, zMirrored;
  if (!GetElement(x, y, z, i, j, k, xMirrored, yMirrored, zMirrored)) {
    return nullptr;
  }
  const int region = m_regions[i][j][k];
  if (region < 0 || region > (int)m_media.size()) return nullptr;
  return m_media[region];
}

GetMedium() [2/2]

Medium * Garfield::ComponentVoxel::GetMedium

(

const unsigned int

i

)

const

Get the medium in region i.

Definition at line 662 of file ComponentVoxel.cc.

                                                            {
  if (i > m_media.size()) {
    std::cerr << m_className << "::GetMedium: Index out of range.\n";
    return nullptr;
  }
  return m_media[i];
}

GetVoltageRange()

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

overridevirtual

Calculate the voltage range [V].

Implements Garfield::ComponentBase.

Definition at line 596 of file ComponentVoxel.cc.

                                                               {
  if (!m_ready) return false;
  vmin = m_pMin;
  vmax = m_pMax;
  return true;
}

LoadElectricField()

bool Garfield::ComponentVoxel::LoadElectricField	(	const std::string &	filename,
		const std::string &	format,
		const bool	withPotential,
		const bool	withRegion,
		const double	scaleX = 1.,
		const double	scaleE = 1.,
		const double	scaleP = 1.
	)

Import electric field and potential values from a file. The file is supposed to contain one line for each mesh point starting with

• either two or three floating point numbers, specifying the coordinates (in cm) of the element centre or
• two or three integers specifying the index of the element in the mesh,

followed by

• two or three floating point numbers for the electric field (in V/cm), and (depending on the values of withPotential and withRegion),
• a floating point number specifying the potential (in V), and
• an integer specifying the "region" of the element.

Format types are:

• "xy", "xyz": elements are specified by the coordinates of their centres
• "ij", "ijk": elements are specified by their indices

Definition at line 204 of file ComponentVoxel.cc.

                                                            {
  m_ready = false;
  m_efields.clear();
  m_hasPotential = m_hasEfield = false;
  if (!m_hasMesh) {
    std::cerr << m_className << "::LoadElectricField:\n"
              << "    Mesh is not set. Call SetMesh first.\n";
    return false;
  }
 
  // Set up the grid.
  Initialise(m_efields);
  InitialiseRegions();
 
  m_pMin = m_pMax = 0.;
  if (withP) {
    m_pMin = 1.;
    m_pMax = -1.;
  }
  if (!LoadData(fname, fmt, withP, withR, scaleX, scaleE, scaleP, m_efields)) {
    return false;
  }
  m_hasEfield = true;
  m_ready = true;
  if (withP) m_hasPotential = true;
  return true;
}

LoadMagneticField()

bool Garfield::ComponentVoxel::LoadMagneticField	(	const std::string &	filename,
		const std::string &	format,
		const double	scaleX = 1.,
		const double	scaleB = 1.
	)

Import magnetic field values from a file.

Definition at line 292 of file ComponentVoxel.cc.

                                                            {
  m_hasBfield = false;
  if (!m_hasMesh) {
    std::cerr << m_className << "::LoadMagneticField:\n"
              << "    Mesh is not set. Call SetMesh first.\n";
    return false;
  }
 
  // Set up the grid.
  Initialise(m_bfields);
  InitialiseRegions();
 
  // Read the file.
  if (!LoadData(fname, fmt, false, false, scaleX, scaleB, 1., m_bfields)) {
    return false;
  }
  m_hasBfield = true;
  return true;
}

LoadWeightingField() [1/2]

bool Garfield::ComponentVoxel::LoadWeightingField	(	const std::string &	filename,
		const std::string &	format,
		const bool	withPotential,
		const double	scaleX = 1.,
		const double	scaleE = 1.,
		const double	scaleP = 1.
	)

Import (prompt) weighting field from file.

Definition at line 236 of file ComponentVoxel.cc.

                                                             {
  m_hasWfield = false;
  if (!m_hasMesh) {
    std::cerr << m_className << "::LoadWeightingField:\n"
              << "    Mesh is not set. Call SetMesh first.\n";
    return false;
  }
 
  // Set up the grid.
  Initialise(m_wfields);
  if (m_regions.empty()) InitialiseRegions();
 
  // Read the file.
  if (!LoadData(fname, fmt, withP, false, scaleX, scaleE, scaleP, m_wfields)) {
    return false;
  }
  m_hasWfield = true;
  return true;
}

LoadWeightingField() [2/2]

bool Garfield::ComponentVoxel::LoadWeightingField	(	const std::string &	filename,
		const std::string &	format,
		const double	time,
		const bool	withPotential,
		const double	scaleX = 1.,
		const double	scaleE = 1.,
		const double	scaleP = 1.
	)

Import delayed weighting field from file.

Definition at line 260 of file ComponentVoxel.cc.

                                                             {
 
  if (!m_hasMesh) {
    std::cerr << m_className << "::LoadWeightingField:\n"
              << "    Mesh is not set. Call SetMesh first.\n";
    return false;
  }
 
  std::vector<std::vector<std::vector<Element> > > wfield;
  Initialise(wfield);
  if (m_regions.empty()) InitialiseRegions();
 
  // Read the file.
  if (!LoadData(fname, fmt, withP, false, scaleX, scaleE, scaleP, wfield)) {
    return false;
  }
  if (m_wdtimes.empty() || t > m_wdtimes.back()) {
    m_wdtimes.push_back(t);
    m_wdfields.push_back(std::move(wfield));
  } else {
    const auto it = std::upper_bound(m_wdtimes.cbegin(), m_wdtimes.cend(), t);
    const auto n = std::distance(m_wdtimes.cbegin(), it);
    m_wdtimes.insert(it, t); 
    m_wdfields.insert(m_wdfields.cbegin() + n, std::move(wfield));
  }
  return true;
}

MagneticField()

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

overridevirtual

Calculate the magnetic field at a given point.

Parameters

x,y,z	coordinates [cm].
bx,by,bz	components of the magnetic field [Tesla].
status	status flag.

Reimplemented from Garfield::ComponentBase.

Definition at line 134 of file ComponentVoxel.cc.

                                                            {
  status = 0;
  if (!m_hasBfield) {
    return ComponentBase::MagneticField(x, y, z, bx, by, bz, status);
  }
 
  int region = -1;
  double p = 0.;
  if (!GetField(x, y, z, m_bfields, bx, by, bz, p, region)) {
    status = -6;
  }
}

PrintRegions()

void Garfield::ComponentVoxel::PrintRegions

(

)

const

Print all regions.

Definition at line 631 of file ComponentVoxel.cc.

                                        {
  // Do not proceed if not properly initialised.
  if (!m_ready) {
    std::cerr << m_className << "::PrintRegions:\n"
              << "    Field map not yet initialised.\n";
    return;
  }
 
  if (m_media.empty()) {
    std::cerr << m_className << "::PrintRegions: No regions defined.\n";
    return;
  }
 
  std::cout << m_className << "::PrintRegions:\n";
  std::cout << "      Index     Medium\n";
  const unsigned int nMedia = m_media.size();
  for (unsigned int i = 0; i < nMedia; ++i) {
    const std::string name = m_media[i] ? m_media[i]->GetName() : "none";
    std::cout << "      " << i << "            " << name << "\n";
  }
}

SetMedium()

void Garfield::ComponentVoxel::SetMedium	(	const unsigned int	i,
		Medium *	m
	)

Set the medium in region i.

Definition at line 653 of file ComponentVoxel.cc.

                                                              {
  if (!m) {
    std::cerr << m_className << "::SetMedium: Null pointer.\n";
    if (m_media.empty()) return;
  }
  if (i >= m_media.size()) m_media.resize(i + 1, nullptr);
  m_media[i] = m;
}

SetMesh()

void Garfield::ComponentVoxel::SetMesh	(	const unsigned int	nx,
		const unsigned int	ny,
		const unsigned int	nz,
		const double	xmin,
		const double	xmax,
		const double	ymin,
		const double	ymax,
		const double	zmin,
		const double	zmax
	)

Define the grid.

Parameters

nx,ny,nz	number of bins along x, y, z.
xmin,xmax	range along .
ymin,ymax	range along .
zmin,zmax	range along .

Definition at line 168 of file ComponentVoxel.cc.

                                                {
  Reset();
  if (nx == 0 || ny == 0 || nz == 0) {
    std::cerr << m_className << "::SetMesh:\n"
              << "    Number of mesh elements must be positive.\n";
    return;
  }
  if (xmin >= xmax) {
    std::cerr << m_className << "::SetMesh: Invalid x range.\n";
    return;
  } else if (ymin >= ymax) {
    std::cerr << m_className << "::SetMesh: Invalid y range.\n";
    return;
  } else if (zmin >= zmax) {
    std::cerr << m_className << "::SetMesh: Invalid z range.\n";
    return;
  }
  m_nX = nx;
  m_nY = ny;
  m_nZ = nz;
  m_xMin = xmin;
  m_yMin = ymin;
  m_zMin = zmin;
  m_xMax = xmax;
  m_yMax = ymax;
  m_zMax = zmax;
  m_dx = (m_xMax - m_xMin) / m_nX;
  m_dy = (m_yMax - m_yMin) / m_nY;
  m_dz = (m_zMax - m_zMin) / m_nZ;
  m_hasMesh = true;
}

SetWeightingFieldOffset()

void Garfield::ComponentVoxel::SetWeightingFieldOffset	(	const double	x,
		const double	y,
		const double	z
	)

Offset coordinates in the weighting field, such that the same numerical weighting field map can be used for electrodes at different positions.

Definition at line 127 of file ComponentVoxel.cc.

                                                             {
  m_wField_xOffset = x;
  m_wField_yOffset = y;
  m_wField_zOffset = z;
}

WeightingField()

void Garfield::ComponentVoxel::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 56 of file ComponentVoxel.cc.

                                                                    {
 
  wx = wy = wz = 0.;
  if (!m_hasWfield) return;
  const double xx = x - m_wField_xOffset;
  const double yy = y - m_wField_yOffset;
  const double zz = z - m_wField_zOffset;
  double wp = 0.;
  int region = 0;
  GetField(xx, yy, zz, m_wfields, wx, wy, wz, wp, region);
}

WeightingPotential()

double Garfield::ComponentVoxel::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 70 of file ComponentVoxel.cc.

                                                              {
  if (!m_hasWfield) return 0.;
  const double xx = x - m_wField_xOffset;
  const double yy = y - m_wField_yOffset;
  const double zz = z - m_wField_zOffset;
  double wx = 0., wy = 0., wz = 0.;
  double wp = 0.;
  int region = 0;
  if (!GetField(xx, yy, zz, m_wfields, wx, wy, wz, wp, region)) return 0.;
  return wp;
}

---

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

• ComponentVoxel.hh
• ComponentVoxel.cc