Garfield::ComponentAnalyticField Class Reference

#include <ComponentAnalyticField.hh>

Inheritance diagram for Garfield::ComponentAnalyticField:

Public Member Functions
	ComponentAnalyticField ()
	~ComponentAnalyticField ()
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 &pmin, double &pmax)
void	WeightingField (const double x, const double y, const double z, double &wx, double &wy, double &wz, const std::string label)
double	WeightingPotential (const double x, const double y, const double z, const std::string label)
bool	GetBoundingBox (double &x0, double &y0, double &z0, double &x1, double &y1, double &z1)
bool	IsWireCrossed (double x0, double y0, double z0, double x1, double y1, double z1, double &xc, double &yc, double &zc)
bool	IsInTrapRadius (double x0, double y0, double z0, double &xw, double &yx, double &rw)
void	AddWire (const double x, const double y, const double diameter, const double voltage, const std::string label, const double length=100., const double tension=50., const double rho=19.3, const int ntrap=5)
void	AddTube (const double radius, const double voltage, const int nEdges, const std::string label)
void	AddPlaneX (const double x, const double voltage, const std::string label)
void	AddPlaneY (const double y, const double voltage, const std::string label)
void	AddStripOnPlaneX (const char direction, const double x, const double smin, const double smax, const std::string label, const double gap=-1.)
void	AddStripOnPlaneY (const char direction, const double y, const double smin, const double smax, const std::string label, const double gap=-1.)
void	SetPeriodicityX (const double s)
void	SetPeriodicityY (const double s)
bool	GetPeriodicityX (double &s)
bool	GetPeriodicityY (double &s)
void	AddCharge (const double x, const double y, const double z, const double q)
void	ClearCharges ()
void	PrintCharges ()
std::string	GetCellType ()
void	AddReadout (const std::string label)
void	EnableChargeCheck ()
void	DisableChargeCheck ()
int	GetNumberOfWires ()
bool	GetWire (const int i, double &x, double &y, double &diameter, double &voltage, std::string &label, double &length, double &charge, int &ntrap)
int	GetNumberOfPlanesX ()
int	GetNumberOfPlanesY ()
bool	GetPlaneX (const int i, double &x, double &voltage, std::string &label)
bool	GetPlaneY (const int i, double &y, double &voltage, std::string &label)
bool	GetTube (double &r, double &voltage, int &nEdges, std::string &label)
Public Member Functions inherited from Garfield::ComponentBase
	ComponentBase ()
virtual	~ComponentBase ()
virtual void	SetGeometry (GeometryBase *geo)
virtual void	Clear ()
virtual Medium *	GetMedium (const double &x, const double &y, const double &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
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)
virtual bool	IsReady ()
virtual bool	GetBoundingBox (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax)
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 (double x0, double y0, double z0, double &xw, double &yw, double &rw)
void	EnablePeriodicityX ()
void	DisablePeriodicityX ()
void	EnablePeriodicityY ()
void	DisablePeriodicityY ()
void	EnablePeriodicityZ ()
void	DisablePeriodicityZ ()
void	EnableMirrorPeriodicityX ()
void	DisableMirrorPeriodicityX ()
void	EnableMirrorPeriodicityY ()
void	DisableMirrorPeriodicityY ()
void	EnableMirrorPeriodicityZ ()
void	DisableMirrorPeriodicityZ ()
void	EnableAxialPeriodicityX ()
void	DisableAxialPeriodicityX ()
void	EnableAxialPeriodicityY ()
void	DisableAxialPeriodicityY ()
void	EnableAxialPeriodicityZ ()
void	DisableAxialPeriodicityZ ()
void	EnableRotationSymmetryX ()
void	DisableRotationSymmetryX ()
void	EnableRotationSymmetryY ()
void	DisableRotationSymmetryY ()
void	EnableRotationSymmetryZ ()
void	DisableRotationSymmetryZ ()
void	EnableDebugging ()
void	DisableDebugging ()

Additional Inherited Members
virtual void	Reset ()=0
virtual void	UpdatePeriodicity ()=0
Protected Attributes inherited from Garfield::ComponentBase
std::string	m_className
GeometryBase *	theGeometry
bool	ready
bool	xPeriodic
bool	yPeriodic
bool	zPeriodic
bool	xMirrorPeriodic
bool	yMirrorPeriodic
bool	zMirrorPeriodic
bool	xAxiallyPeriodic
bool	yAxiallyPeriodic
bool	zAxiallyPeriodic
bool	xRotationSymmetry
bool	yRotationSymmetry
bool	zRotationSymmetry
double	bx0
double	by0
double	bz0
bool	debug

Detailed Description

Definition at line 12 of file ComponentAnalyticField.hh.

Constructor & Destructor Documentation

ComponentAnalyticField()

Garfield::ComponentAnalyticField::ComponentAnalyticField

(

)

Definition at line 11 of file ComponentAnalyticField.cc.

                                               {
 
  m_className = "ComponentAnalyticField";
  chargeCheck = false;
  CellInit();
}

~ComponentAnalyticField()

Garfield::ComponentAnalyticField::~ComponentAnalyticField ( )

inline

Definition at line 18 of file ComponentAnalyticField.hh.

{}

Member Function Documentation

AddCharge()

void Garfield::ComponentAnalyticField::AddCharge	(	const double	x,
		const double	y,
		const double	z,
		const double	q
	)

Definition at line 682 of file ComponentAnalyticField.cc.

                                                                       {
 
  // Convert from fC to internal units (division by 4 pi epsilon0).
  charge3d newCharge;
  newCharge.x = x;
  newCharge.y = y;
  newCharge.z = z;
  newCharge.e = q / FourPiEpsilon0;
  ch3d.push_back(newCharge);
  ++n3d;
}

AddPlaneX()

void Garfield::ComponentAnalyticField::AddPlaneX	(	const double	x,
		const double	voltage,
		const std::string	label
	)

Definition at line 415 of file ComponentAnalyticField.cc.

                                                            {
 
  if (ynplan[0] && ynplan[1]) {
    std::cerr << m_className << "::AddPlaneX:\n";
    std::cerr << "    There are already two x planes defined.\n";
    return;
  }
 
  if (ynplan[0]) {
    ynplan[1] = true;
    coplan[1] = x;
    vtplan[1] = v;
    planes[1].type = lab;
    planes[1].ind = -1;
  } else {
    ynplan[0] = true;
    coplan[0] = x;
    vtplan[0] = v;
    planes[0].type = lab;
    planes[0].ind = -1;
  }
 
  // Force recalculation of the capacitance and signal matrices.
  cellset = false;
  sigset = false;
}

AddPlaneY()

void Garfield::ComponentAnalyticField::AddPlaneY	(	const double	y,
		const double	voltage,
		const std::string	label
	)

Definition at line 443 of file ComponentAnalyticField.cc.

                                                            {
 
  if (ynplan[2] && ynplan[3]) {
    std::cerr << m_className << "::AddPlaneY:\n";
    std::cerr << "    There are already two y planes defined.\n";
    return;
  }
 
  if (ynplan[2]) {
    ynplan[3] = true;
    coplan[3] = y;
    vtplan[3] = v;
    planes[3].type = lab;
    planes[3].ind = -1;
  } else {
    ynplan[2] = true;
    coplan[2] = y;
    vtplan[2] = v;
    planes[2].type = lab;
    planes[2].ind = -1;
  }
 
  // Force recalculation of the capacitance and signal matrices.
  cellset = false;
  sigset = false;
}

AddReadout()

void Garfield::ComponentAnalyticField::AddReadout

(

const std::string

label

)

Definition at line 1938 of file ComponentAnalyticField.cc.

                                                             {
 
  // Check if this readout group already exists.
  for (int i = 0; i < nReadout; ++i) {
    if (readout[i] == label) {
      std::cout << m_className << "::AddReadout:\n";
      std::cout << "    Readout group " << label << " already exists.\n";
      return;
    }
  }
 
  readout.push_back(label);
  ++nReadout;
 
  int nWiresFound = 0;
  for (int i = 0; i < nWires; ++i) {
    if (w[i].type == label) ++nWiresFound;
  }
 
  int nPlanesFound = 0;
  int nStripsFound = 0;
  for (int i = 0; i < 5; ++i) {
    if (planes[i].type == label) ++nPlanesFound;
    for (int j = 0; j < planes[i].nStrips1; ++j) {
      if (planes[i].strips1[j].type == label) ++nStripsFound;
    }
    for (int j = 0; j < planes[i].nStrips2; ++j) {
      if (planes[i].strips2[j].type == label) ++nStripsFound;
    }
  }
 
  if (nWiresFound == 0 && nPlanesFound == 0 && nStripsFound == 0) {
    std::cerr << m_className << "::AddReadout:\n";
    std::cerr << "    At present there are no wires, planes or strips\n";
    std::cerr << "    associated to readout group " << label << ".\n";
  } else {
    std::cout << m_className << "::AddReadout:\n";
    std::cout << "    Readout group " << label << " comprises:\n";
    if (nWiresFound > 1) {
      std::cout << "      " << nWiresFound << " wires\n";
    } else if (nWiresFound == 1) {
      std::cout << "      1 wire\n";
    }
    if (nPlanesFound > 1) {
      std::cout << "      " << nPlanesFound << " planes\n";
    } else if (nPlanesFound == 1) {
      std::cout << "      1 plane\n";
    }
    if (nStripsFound > 1) {
      std::cout << "      " << nStripsFound << " strips\n";
    } else if (nStripsFound == 1) {
      std::cout << "      1 strip\n";
    }
  }
 
  sigset = false;
}

AddStripOnPlaneX()

void Garfield::ComponentAnalyticField::AddStripOnPlaneX	(	const char	direction,
		const double	x,
		const double	smin,
		const double	smax,
		const std::string	label,
		const double	gap = -1.
	)

Definition at line 471 of file ComponentAnalyticField.cc.

                                                                {
 
  if (!ynplan[0] && !ynplan[1]) {
    std::cerr << m_className << "::AddStripOnPlaneX:\n";
    std::cerr << "    There are no planes at constant x defined.\n";
    return;
  }
 
  if (direction != 'y' && direction != 'Y' && direction != 'z' &&
      direction != 'Z') {
    std::cerr << m_className << "::AddStripOnPlaneX:\n";
    std::cerr << "    Invalid direction (" << direction << ").\n";
    std::cerr << "    Only strips in y or z direction are possible.\n";
    return;
  }
 
  if (fabs(smax - smin) < Small) {
    std::cerr << m_className << "::AddStripOnPlaneX:\n";
    std::cerr << "    Strip width must be greater than zero.\n";
    return;
  }
 
  strip newStrip;
  newStrip.type = label;
  newStrip.ind = -1;
  newStrip.smin = std::min(smin, smax);
  newStrip.smax = std::max(smin, smax);
  if (gap > Small) {
    newStrip.gap = gap;
  } else {
    newStrip.gap = -1.;
  }
 
  int iplane = 0;
  if (ynplan[1]) {
    const double d0 = fabs(coplan[0] - x);
    const double d1 = fabs(coplan[1] - x);
    if (d1 < d0) iplane = 1;
  }
 
  if (direction == 'y' || direction == 'Y') {
    planes[iplane].nStrips1++;
    planes[iplane].strips1.push_back(newStrip);
  } else {
    planes[iplane].nStrips2++;
    planes[iplane].strips2.push_back(newStrip);
  }
}

AddStripOnPlaneY()

void Garfield::ComponentAnalyticField::AddStripOnPlaneY	(	const char	direction,
		const double	y,
		const double	smin,
		const double	smax,
		const std::string	label,
		const double	gap = -1.
	)

Definition at line 524 of file ComponentAnalyticField.cc.

                                                                {
 
  if (!ynplan[2] && !ynplan[3]) {
    std::cerr << m_className << "::AddStripOnPlaneY:\n";
    std::cerr << "    There are no planes at constant y defined.\n";
    return;
  }
 
  if (direction != 'x' && direction != 'X' && direction != 'z' &&
      direction != 'Z') {
    std::cerr << m_className << "::AddStripOnPlaneY:\n";
    std::cerr << "    Invalid direction (" << direction << ").\n";
    std::cerr << "    Only strips in x or z direction are possible.\n";
    return;
  }
 
  if (fabs(smax - smin) < Small) {
    std::cerr << m_className << "::AddStripOnPlaneY:\n";
    std::cerr << "    Strip width must be greater than zero.\n";
    return;
  }
 
  strip newStrip;
  newStrip.type = label;
  newStrip.ind = -1;
  newStrip.smin = std::min(smin, smax);
  newStrip.smax = std::max(smin, smax);
  if (gap > Small) {
    newStrip.gap = gap;
  } else {
    newStrip.gap = -1.;
  }
 
  int iplane = 2;
  if (ynplan[3]) {
    const double d2 = fabs(coplan[2] - y);
    const double d3 = fabs(coplan[3] - y);
    if (d3 < d2) iplane = 3;
  }
 
  if (direction == 'x' || direction == 'X') {
    planes[iplane].nStrips1++;
    planes[iplane].strips1.push_back(newStrip);
  } else {
    planes[iplane].nStrips2++;
    planes[iplane].strips2.push_back(newStrip);
  }
}

AddTube()

void Garfield::ComponentAnalyticField::AddTube	(	const double	radius,
		const double	voltage,
		const int	nEdges,
		const std::string	label
	)

Definition at line 374 of file ComponentAnalyticField.cc.

                                                            {
 
  // Check if the provided parameters make sense.
  if (radius <= 0.0) {
    std::cerr << m_className << "::AddTube:\n";
    std::cerr << "    Unphysical tube dimension.\n";
    return;
  }
 
  if (nEdges < 3 && nEdges != 0) {
    std::cerr << m_className << "::AddTube:\n";
    std::cerr << "    Unphysical number of tube edges (" << nEdges << ")\n";
    return;
  }
 
  // If there is already a tube defined, print a warning message.
  if (tube) {
    std::cout << m_className << "::AddTube:\n";
    std::cout << "    Warning: Existing tube settings will be overwritten.\n";
  }
 
  // Set the coordinate system.
  tube = true;
  polar = false;
 
  // Set the tube parameters.
  cotube = radius;
  vttube = voltage;
 
  ntube = nEdges;
 
  planes[4].type = label;
  planes[4].ind = -1;
 
  // Force recalculation of the capacitance and signal matrices.
  cellset = false;
  sigset = false;
}

Referenced by GarfieldPhysics::CreateGeometry().

AddWire()

void Garfield::ComponentAnalyticField::AddWire	(	const double	x,
		const double	y,
		const double	diameter,
		const double	voltage,
		const std::string	label,
		const double	length = 100.,
		const double	tension = 50.,
		const double	rho = 19.3,
		const int	ntrap = 5
	)

Definition at line 317 of file ComponentAnalyticField.cc.

                                                                  {
 
  // Check if the provided parameters make sense.
  if (diameter <= 0.) {
    std::cerr << m_className << "::AddWire:\n";
    std::cerr << "    Unphysical wire diameter.\n";
    return;
  }
 
  if (tension <= 0.) {
    std::cerr << m_className << "::AddWire:\n";
    std::cerr << "    Unphysical wire tension.\n";
    return;
  }
 
  if (rho <= 0.0) {
    std::cerr << m_className << "::AddWire:\n";
    std::cerr << "    Unphysical wire density.\n";
    return;
  }
 
  if (length <= 0.0) {
    std::cerr << m_className << "::AddWire:\n";
    std::cerr << "    Unphysical wire length.\n";
    return;
  }
 
  if (ntrap <= 0) {
    std::cerr << m_className << "::AddWire:\n";
    std::cerr << "    Number of trap radii must be > 0.\n";
    return;
  }
  // Create a new wire
  wire newWire;
  newWire.x = x;
  newWire.y = y;
  newWire.d = diameter;
  newWire.v = voltage;
  newWire.u = length;
  newWire.type = label;
  newWire.e = 0.;
  newWire.ind = -1;
  newWire.nTrap = ntrap;
  // Add the wire to the list
  w.push_back(newWire);
  ++nWires;
 
  // Force recalculation of the capacitance and signal matrices.
  cellset = false;
  sigset = false;
}

Referenced by GarfieldPhysics::CreateGeometry().

ClearCharges()

void Garfield::ComponentAnalyticField::ClearCharges

(

)

Definition at line 695 of file ComponentAnalyticField.cc.

                                          {
 
  n3d = 0;
  ch3d.clear();
  nTermBessel = 10;
  nTermPoly = 100;
}

DisableChargeCheck()

void Garfield::ComponentAnalyticField::DisableChargeCheck ( )

inline

Definition at line 96 of file ComponentAnalyticField.hh.

{ chargeCheck = false; }

ElectricField() [1/2]

void Garfield::ComponentAnalyticField::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 53 of file ComponentAnalyticField.cc.

                                                                    {
 
  // Initialize electric field and medium.
  ex = ey = ez = v = 0.;
  m = NULL;
 
  // Make sure the charges have been calculated.
  if (!cellset) {
    if (!Prepare()) {
      status = -11;
      return;
    }
  }
 
  // Request calculation of the potential.
  const bool opt = true;
 
  // Calculate the field.
  status = Field(x, y, z, ex, ey, ez, v, opt);
 
  // If the field is ok, get the medium.
  if (status == 0) {
    m = GetMedium(x, y, z);
    if (m == NULL) {
      status = -6;
    } else if (!m->IsDriftable()) {
      status = -5;
    }
  }
}

ElectricField() [2/2]

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

virtual

Implements Garfield::ComponentBase.

Definition at line 18 of file ComponentAnalyticField.cc.

                                                        {
 
  // Initialize electric field and medium.
  ex = ey = ez = 0.;
  m = NULL;
 
  // Make sure the charges have been calculated.
  if (!cellset) {
    if (!Prepare()) {
      status = -11;
      return;
    }
  }
 
  // Disable calculation of the potential.
  const bool opt = false;
  double v = 0.;
 
  // Calculate the field.
  status = Field(x, y, z, ex, ey, ez, v, opt);
 
  // If the field is ok, get the medium.
  if (status == 0) {
    m = GetMedium(x, y, z);
    if (m == NULL) {
      status = -6;
    } else if (!m->IsDriftable()) {
      status = -5;
    }
  }
}

EnableChargeCheck()

void Garfield::ComponentAnalyticField::EnableChargeCheck ( )

inline

Definition at line 95 of file ComponentAnalyticField.hh.

{ chargeCheck = true; }

GetBoundingBox()

bool Garfield::ComponentAnalyticField::GetBoundingBox ( double &  x0, double &  y0, double &  z0, double &  x1, double &  y1, double &  z1  )

virtual

Reimplemented from Garfield::ComponentBase.

Definition at line 165 of file ComponentAnalyticField.cc.

                                                        {
 
  // If a geometry is present, try to get the bounding box from there.
  if (theGeometry != 0) {
    if (theGeometry->GetBoundingBox(x0, y0, z0, x1, y1, z1)) return true;
  }
  // Otherwise, return the cell dimensions.
  if (!cellset) return false;
  x0 = xmin;
  y0 = ymin;
  z0 = zmin;
  x1 = xmax;
  y1 = ymax;
  z1 = zmax;
  return true;
}

GetCellType()

std::string Garfield::ComponentAnalyticField::GetCellType ( )

inline

Definition at line 74 of file ComponentAnalyticField.hh.

{ return cellType; }

GetNumberOfPlanesX()

int Garfield::ComponentAnalyticField::GetNumberOfPlanesX

(

)

Definition at line 718 of file ComponentAnalyticField.cc.

                                               {
 
  if (ynplan[0] && ynplan[1]) {
    return 2;
  } else if (ynplan[0] || ynplan[1]) {
    return 1;
  }
  return 0;
}

GetNumberOfPlanesY()

int Garfield::ComponentAnalyticField::GetNumberOfPlanesY

(

)

Definition at line 728 of file ComponentAnalyticField.cc.

                                               {
 
  if (ynplan[2] && ynplan[3]) {
    return 2;
  } else if (ynplan[2] || ynplan[3]) {
    return 1;
  }
  return 0;
}

GetNumberOfWires()

int Garfield::ComponentAnalyticField::GetNumberOfWires ( )

inline

Definition at line 98 of file ComponentAnalyticField.hh.

{ return nWires; }

GetPeriodicityX()

bool Garfield::ComponentAnalyticField::GetPeriodicityX

(

double &

s

)

Definition at line 603 of file ComponentAnalyticField.cc.

                                                      {
 
  if (!xPeriodic) {
    s = 0.;
    return false;
  }
 
  s = sx;
  return true;
}

GetPeriodicityY()

bool Garfield::ComponentAnalyticField::GetPeriodicityY

(

double &

s

)

Definition at line 614 of file ComponentAnalyticField.cc.

                                                      {
 
  if (!yPeriodic) {
    s = 0.;
    return false;
  }
 
  s = sy;
  return true;
}

GetPlaneX()

bool Garfield::ComponentAnalyticField::GetPlaneX	(	const int	i,
		double &	x,
		double &	voltage,
		std::string &	label
	)

Definition at line 760 of file ComponentAnalyticField.cc.

                                                         {
 
  if (i < 0 || i >= 2 || (i == 1 && !ynplan[1])) {
    std::cerr << m_className << "::GetPlaneX:\n";
    std::cerr << "    Plane index is out of range.\n";
    return false;
  }
 
  x = coplan[i];
  voltage = vtplan[i];
  label = planes[i].type;
  return true;
}

GetPlaneY()

bool Garfield::ComponentAnalyticField::GetPlaneY	(	const int	i,
		double &	y,
		double &	voltage,
		std::string &	label
	)

Definition at line 775 of file ComponentAnalyticField.cc.

                                                         {
 
  if (i < 0 || i >= 2 || (i == 1 && !ynplan[3])) {
    std::cerr << m_className << "::GetPlaneY:\n";
    std::cerr << "    Plane index is out of range.\n";
    return false;
  }
 
  y = coplan[i + 2];
  voltage = vtplan[i + 2];
  label = planes[i + 2].type;
  return true;
}

GetTube()

bool Garfield::ComponentAnalyticField::GetTube	(	double &	r,
		double &	voltage,
		int &	nEdges,
		std::string &	label
	)

Definition at line 790 of file ComponentAnalyticField.cc.

                                                       {
 
  if (!tube) return false;
  r = cotube;
  voltage = vttube;
  nEdges = ntube;
  label = planes[4].type;
  return true;
}

GetVoltageRange()

bool Garfield::ComponentAnalyticField::GetVoltageRange ( double &  pmin, double &  pmax  )

virtual

Implements Garfield::ComponentBase.

Definition at line 87 of file ComponentAnalyticField.cc.

                                                                       {
 
  // Make sure the cell is prepared.
  if (!cellset) {
    if (!Prepare()) {
      std::cerr << m_className << "::GetVoltageRange:\n";
      std::cerr << "    Unable to return voltage range.\n";
      std::cerr << "   Cell could not be setup.\n";
      return false;
    }
  }
 
  pmin = vmin;
  pmax = vmax;
  return true;
}

GetWire()

bool Garfield::ComponentAnalyticField::GetWire	(	const int	i,
		double &	x,
		double &	y,
		double &	diameter,
		double &	voltage,
		std::string &	label,
		double &	length,
		double &	charge,
		int &	ntrap
	)

Definition at line 738 of file ComponentAnalyticField.cc.

                                                                 {
 
  if (i < 0 || i >= nWires) {
    std::cerr << m_className << "::GetWire:\n";
    std::cerr << "    Wire index is out of range.\n";
    return false;
  }
 
  x = w[i].x;
  y = w[i].y;
  diameter = w[i].d;
  voltage = w[i].v;
  label = w[i].type;
  length = w[i].u;
  charge = w[i].e;
  ntrap = w[i].nTrap;
  return true;
}

IsInTrapRadius()

bool Garfield::ComponentAnalyticField::IsInTrapRadius ( double  x0, double  y0, double  z0, double &  xw, double &  yx, double &  rw  )

virtual

Reimplemented from Garfield::ComponentBase.

Definition at line 256 of file ComponentAnalyticField.cc.

                                                        {
 
  // In case of periodicity, move the point into the basic cell.
  double x0 = xin, y0 = yin;
  int nX = 0, nY = 0, nPhi = 0;
  if (perx) {
    nX = int(round(xin / sx));
    x0 -= sx * nX;
  }
  if (pery && tube) {
    Cartesian2Polar(xin, yin, x0, y0);
    nPhi = int(round((Pi * y0) / (sy * 180.)));
    y0 -= 180. * sy * nPhi / Pi;
    Polar2Cartesian(x0, y0, x0, y0);
  } else if (pery) {
    nY = int(round(yin / sy));
    y0 -= sy * nY;
  }
 
  // Move the point to the correct side of the plane.
  if (perx && ynplan[0] && x0 <= coplan[0]) x0 += sx;
  if (perx && ynplan[1] && x0 >= coplan[1]) x0 -= sx;
  if (pery && ynplan[2] && y0 <= coplan[2]) y0 += sy;
  if (pery && ynplan[3] && y0 >= coplan[3]) y0 -= sy;
 
  for (int i = 0; i < nWires; i++) {
    const double xwc = w[i].x;
    const double yxc = w[i].y;
    const double r = sqrt(pow(xwc - x0, 2) + pow(yxc - y0, 2));
    const double rTrap = 0.5 * w[i].d * w[i].nTrap;
    if (r < rTrap) {
      xw = w[i].x;
      yw = w[i].y;
      rw = w[i].d * 0.5;
      if (perx && ynplan[0] && x0 <= coplan[0]) x0 -= sx;
      if (perx && ynplan[1] && x0 >= coplan[1]) x0 += sx;
      if (pery && ynplan[2] && y0 <= coplan[2]) y0 -= sy;
      if (pery && ynplan[3] && y0 >= coplan[3]) y0 += sy;
      if (pery && tube) {
        double rhow, phiw;
        Cartesian2Polar(xw, yw, rhow, phiw);
        phiw += 180. * sy * nPhi / Pi;
        Polar2Cartesian(rhow, phiw, xw, yw);
      } else if (pery) {
        y0 += sy * nY;
      }
      if (perx) xw += sx * nX;
      if (debug) {
        std::cout << m_className << "::IsInTrapRadius:\n";
        std::cout << "    (" << xin << ", " << yin << ", " << zin << ")"
                  << " within trap radius of wire " << i << ".\n";
      }
      return true;
    }
  }
 
  return false;
}

IsWireCrossed()

bool Garfield::ComponentAnalyticField::IsWireCrossed ( double  x0, double  y0, double  z0, double  x1, double  y1, double  z1, double &  xc, double &  yc, double &  zc  )

virtual

Reimplemented from Garfield::ComponentBase.

Definition at line 184 of file ComponentAnalyticField.cc.

                                                                               {
 
  xc = x0;
  yc = y0;
  zc = z0;
 
  if (nWires <= 0) return false;
 
  const double dx = x1 - x0;
  const double dy = y1 - y0;
  const double d2 = dx * dx + dy * dy;
  // Check that the step length is non-zero.
  if (d2 < Small) return false;
 
  // Check if a whole period has been crossed.
  if ((perx && fabs(dx) >= sx) || (pery && fabs(dy) >= sy)) {
    std::cerr << m_className << "::IsWireCrossed:\n";
    std::cerr << "    Particle crossed more than one period.\n";
    return false;
  }
 
  // Both coordinates are assumed to be located inside
  // the drift area and inside a drift medium.
  // This should have been checked before this call.
 
  const double xm = 0.5 * (x0 + x1);
  const double ym = 0.5 * (y0 + y1);
  double dMin2 = 0.;
  for (int i = nWires; i--;) {
    double xw = w[i].x, yw = w[i].y;
    if (perx) {
      xw += sx * int(round((xm - xw) / sx));
    }
    if (pery) {
      yw += sy * int(round((ym - yw) / sy));
    }
    // Calculate the smallest distance between track and wire.
    const double xIn0 = dx * (xw - x0) + dy * (yw - y0);
    // Check if the minimum is located before (x0, y0).
    if (xIn0 < 0.) continue;
    const double xIn1 = -(dx * (xw - x1) + dy * (yw - y1));
    // Check if the minimum is located behind (x1, y1).
    if (xIn1 < 0.) continue;
    // Minimum is located between (x0, y0) and (x1, y1).
    const double dw02 = pow(xw - x0, 2) + pow(yw - y0, 2);
    const double dw12 = pow(xw - x1, 2) + pow(yw - y1, 2);
    if (xIn1 * xIn1 * dw02 > xIn0 * xIn0 * dw12) {
      dMin2 = dw02 - xIn0 * xIn0 / d2;
    } else {
      dMin2 = dw12 - xIn1 * xIn1 / d2;
    }
    // Add in the times nTrap to account for the trap radius.
    const double r2 = 0.25 * w[i].d * w[i].d;
    if (dMin2 < r2) {
      // Wire has been crossed.
      // Find the point of intersection.
      const double p = -xIn0 / d2;
      const double q = (dw02 - r2) / d2;
      const double t1 = -p + sqrt(p * p - q);
      const double t2 = -p - sqrt(p * p - q);
      const double t = std::min(t1, t2);
      xc = x0 + t * dx;
      yc = y0 + t * dy;
      zc = z0 + t * (z1 - z0);
      return true;
    }
  }
  return false;
}

PrintCharges()

void Garfield::ComponentAnalyticField::PrintCharges

(

)

Definition at line 703 of file ComponentAnalyticField.cc.

                                          {
 
  std::cout << m_className << "::PrintCharges:\n";
  if (n3d <= 0) {
    std::cout << "    No charges present.\n";
    return;
  }
  std::cout << "      x [cm]      y [cm]      z [cm]      charge [fC]\n";
  for (int i = 0; i < n3d; ++i) {
    std::cout << "     " << std::setw(9) << ch3d[i].x << "   " << std::setw(9)
              << ch3d[i].y << "   " << std::setw(9) << ch3d[i].z << "   "
              << std::setw(11) << ch3d[i].e * FourPiEpsilon0 << "\n";
  }
}

SetPeriodicityX()

void Garfield::ComponentAnalyticField::SetPeriodicityX

(

const double

s

)

Definition at line 577 of file ComponentAnalyticField.cc.

                                                           {
 
  if (s < Small) {
    std::cerr << m_className << "::SetPeriodicityX:\n";
    std::cerr << "    Periodic length must be greater than zero.\n";
    return;
  }
 
  xPeriodic = true;
  sx = s;
  UpdatePeriodicity();
}

SetPeriodicityY()

void Garfield::ComponentAnalyticField::SetPeriodicityY

(

const double

s

)

Definition at line 590 of file ComponentAnalyticField.cc.

                                                           {
 
  if (s < Small) {
    std::cerr << m_className << "::SetPeriodicityY:\n";
    std::cerr << "    Periodic length must be greater than zero.\n";
    return;
  }
 
  yPeriodic = true;
  sy = s;
  UpdatePeriodicity();
}

WeightingField()

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

virtual

Reimplemented from Garfield::ComponentBase.

Definition at line 104 of file ComponentAnalyticField.cc.

                                                                   {
 
  wx = wy = wz = 0.;
 
  if (nReadout <= 0) return;
  if (!sigset) {
    if (!PrepareSignals()) {
      std::cerr << m_className << "::WeightingField::\n";
      std::cerr << "    Unable to calculate weighting fields.\n";
      return;
    }
  }
 
  if (label.empty()) return;
  int index = -1;
  for (int i = nReadout; i--;) {
    if (readout[i] == label) {
      index = i;
      break;
    }
  }
  if (index < 0) return;
 
  double volt = 0.;
  Wfield(x, y, z, wx, wy, wz, volt, index, false);
}

WeightingPotential()

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

virtual

Reimplemented from Garfield::ComponentBase.

Definition at line 134 of file ComponentAnalyticField.cc.

                                                                         {
 
  double volt = 0.;
 
  if (nReadout <= 0) return volt;
  if (!sigset) {
    if (!PrepareSignals()) {
      std::cerr << m_className << "::WeightingPotential::\n";
      std::cerr << "    Unable to calculate weighting fields.\n";
      return volt;
    }
  }
 
  if (label.empty()) return volt;
  int index = -1;
  for (int i = nReadout; i--;) {
    if (readout[i] == label) {
      index = i;
      break;
    }
  }
  if (index < 0) return volt;
 
  double wx = 0., wy = 0., wz = 0.;
  Wfield(x, y, z, wx, wy, wz, volt, index, true);
  return volt;
}

---

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

• ComponentAnalyticField.hh
• ComponentAnalyticField.cc