Garfield::ComponentUser Class Reference

Simple component with electric field given by a user function. More...

#include <ComponentUser.hh>

Inheritance diagram for Garfield::ComponentUser:

Public Member Functions
	ComponentUser ()
	Constructor.
	~ComponentUser ()
	Destructor.
void	SetElectricField (std::function< void(const double, const double, const double, double &, double &, double &)>)
	Set the function to be called for calculating the electric field.
void	SetElectricField (const std::string &expression)
	Set the expression to be used for calculating the electric field.
void	SetPotential (std::function< double(const double, const double, const double)>)
	Set the function to be called for calculating the electric potential.
void	SetPotential (const std::string &expression)
	Set the expression to be used for calculating the electric potential.
void	SetWeightingField (std::function< void(const double, const double, const double, double &, double &, double &)>, const std::string &label)
	Set the function to be called for calculating the weighting field.
void	SetWeightingField (const std::string &expression, const std::string &label)
	Set the expression to be used for calculating the weighting field.
void	SetWeightingPotential (std::function< double(const double, const double, const double)>, const std::string &label)
	Set the function to be called for calculating the weighting potential.
void	SetWeightingPotential (const std::string &expression, const std::string &label)
	Set the expression to be used for calculating the weighting potential.
void	SetDelayedWeightingField (std::function< void(const double, const double, const double, const double, double &, double &, double &)>, const std::string &label)
	Set the function to be called for calculating the delayed weighting field.
void	SetDelayedWeightingField (const std::string &expression, const std::string &label)
	Set the expression to be used for calculating the delayed weighting field.
void	SetDelayedWeightingPotential (std::function< double(const double, const double, const double, const double)>, const std::string &label)
void	SetDelayedWeightingPotential (const std::string &expression, const std::string &label)
void	SetMagneticField (std::function< void(const double, const double, const double, double &, double &, double &)>)
	Set the function to be called for calculating the magnetic field.
void	SetMagneticField (const std::string &expression)
	Set the expression to be used for calculating the magnetic field.
void	SetArea (const double xmin, const double ymin, const double zmin, const double xmax, const double ymax, const double zmax)
void	UnsetArea ()
	Remove the explicit limits of the active area.
void	SetMedium (Medium *medium)
	Set the medium in the active area.
Medium *	GetMedium (const double x, const double y, const double z) override
	Get the medium at a given location (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	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	MagneticField (const double x, const double y, const double z, double &bx, double &by, double &bz, 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
double	DelayedWeightingPotential (const double x, const double y, const double z, const double t, const std::string &label) override
bool	GetBoundingBox (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) override
	Get the bounding box coordinates.
bool	HasMagneticField () const override
	Does the component have a non-zero magnetic field?
std::array< double, 3 >	ElectricField (const double x, const double y, const double z)
	Calculate the drift field [V/cm] at (x, y, z).
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.
std::array< double, 3 >	ElectricField (const double x, const double y, const double z)
	Calculate the drift field [V/cm] at (x, y, z).
virtual double	ElectricPotential (const double x, const double y, const double z)
	Calculate the (drift) electrostatic potential [V] at (x, y, z).
void	SetMagneticField (const double bx, const double by, const double bz)
	Set a constant magnetic field.
virtual bool	IsReady ()
	Ready for use?
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	CrossedWire (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	InTrapRadius (const double q0, const double x0, const double y0, const double z0, double &xw, double &yw, double &rw)
virtual bool	CrossedPlane (const double x0, const double y0, const double z0, const double x1, const double y1, const double z1, double &xc, double &yc, double &zc)
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	HasTownsendMap () const
	Does the component have maps of the Townsend coefficient?
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	ElectronTownsend (const double, const double, const double, double &alpha)
	Get the electron Townsend coefficient.
virtual bool	HoleTownsend (const double, const double, const double, double &alpha)
	Get the hole Townsend 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)
virtual double	StepSizeHint ()

Additional Inherited Members
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.

Detailed Description

Simple component with electric field given by a user function.

Definition at line 13 of file ComponentUser.hh.

Constructor & Destructor Documentation

ComponentUser()

Garfield::ComponentUser::ComponentUser

(

)

Constructor.

Definition at line 73 of file ComponentUser.cc.

: Component("User") {}

~ComponentUser()

Garfield::ComponentUser::~ComponentUser ( )

inline

Destructor.

Definition at line 18 of file ComponentUser.hh.

{}

Member Function Documentation

DelayedWeightingField()

void Garfield::ComponentUser::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::Component.

Definition at line 158 of file ComponentUser.cc.

                                                                  {
  wx = wy = wz = 0.;
  if (m_dwfield.count(label) > 0) {
    m_dwfield[label](x, y, z, t, wx, wy, wz);
  }
}

DelayedWeightingPotential()

double Garfield::ComponentUser::DelayedWeightingPotential ( const double x, const double y, const double z, const double t, const std::string & label )

overridevirtual

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

Parameters

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

Reimplemented from Garfield::Component.

Definition at line 168 of file ComponentUser.cc.

                            {
 
  double v = 0.;
  if (m_dwpot.count(label) > 0) v = m_dwpot[label](x, y, z, t);
  return v;
}

ElectricField() [1/3]

std::array< double, 3 > Garfield::Component::ElectricField	(	const double	x,
		const double	y,
		const double	z )

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

Definition at line 55 of file Component.cc.

                                                    {
  double ex = 0., ey = 0., ez = 0.;
  Medium* medium = nullptr;
  int status = 0;
  ElectricField(x, y, z, ex, ey, ez, medium, status);
  std::array<double, 3> efield = {ex, ey, ez};
  return efield;
}

ElectricField() [2/3]

void Garfield::ComponentUser::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 99 of file ComponentUser.cc.

                                               {
  if (!m_efield) {
    ex = ey = ez = v = 0.;
    m = nullptr;
    status = -10;
    return;
  }
  m_efield(x, y, z, ex, ey, ez);
 
  v = m_epot ? m_epot(x, y, z) : 0.;
  m = GetMedium(x, y, z);
  if (!m) {
    if (m_debug) {
      std::cerr << m_className << "::ElectricField:\n    (" << x << ", " << y
                << ", " << z << ") is not inside a medium.\n";
    }
    status = -6;
    return;
  }
 
  status = m->IsDriftable() ? 0 : -5;
}

ElectricField() [3/3]

void Garfield::ComponentUser::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::Component.

Definition at line 75 of file ComponentUser.cc.

                                                                       {
  if (!m_efield) {
    ex = ey = ez = 0.;
    m = nullptr;
    status = -10;
    return;
  }
 
  m_efield(x, y, z, ex, ey, ez);
  m = GetMedium(x, y, z);
  if (!m) {
    if (m_debug) {
      std::cerr << m_className << "::ElectricField:\n    (" << x << ", " << y
                << ", " << z << ") is not inside a medium.\n";
    }
    status = -6;
    return;
  }
 
  status = m->IsDriftable() ? 0 : -5;
}

GetBoundingBox()

bool Garfield::ComponentUser::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 177 of file ComponentUser.cc.

                                              {
 
  if (!m_hasArea) {
    return Component::GetBoundingBox(xmin, ymin, zmin, xmax, ymax, zmax);
  }
  xmin = m_xmin[0];
  ymin = m_xmin[1];
  zmin = m_xmin[2];
  xmax = m_xmax[0];
  ymax = m_xmax[1];
  zmax = m_xmax[2];
  return true;
}

GetMedium()

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

inlineoverridevirtual

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

Reimplemented from Garfield::Component.

Definition at line 87 of file ComponentUser.hh.

                                                                             {
    return !m_hasArea ? Component::GetMedium(x, y, z) : 
                        InArea(x, y, z) ? m_medium : nullptr;
  }

Referenced by ElectricField(), and ElectricField().

GetVoltageRange()

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

overridevirtual

Calculate the voltage range [V].

Implements Garfield::Component.

Definition at line 125 of file ComponentUser.cc.

                                                              {
  vmin = vmax = 0.;
  return false;
}

HasMagneticField()

bool Garfield::ComponentUser::HasMagneticField ( ) const

overridevirtual

Does the component have a non-zero magnetic field?

Reimplemented from Garfield::Component.

Definition at line 193 of file ComponentUser.cc.

                                           {
  return m_bfield ? true : Component::HasMagneticField();
}

MagneticField()

void Garfield::ComponentUser::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::Component.

Definition at line 130 of file ComponentUser.cc.

                                                           {
  if (!m_bfield) {
    Component::MagneticField(x, y, z, bx, by, bz, status);
    return;
  }
  m_bfield(x, y, z, bx, by, bz);
  status = 0;
}

SetArea()

void Garfield::ComponentUser::SetArea	(	const double	xmin,
		const double	ymin,
		const double	zmin,
		const double	xmax,
		const double	ymax,
		const double	zmax )

Set the limits of the active area explicitly (instead of using a Geometry object).

Definition at line 384 of file ComponentUser.cc.

                                                             {
 
  m_xmin[0] = std::min(xmin, xmax);
  m_xmin[1] = std::min(ymin, ymax);
  m_xmin[2] = std::min(zmin, zmax);
  m_xmax[0] = std::max(xmin, xmax);
  m_xmax[1] = std::max(ymin, ymax);
  m_xmax[2] = std::max(zmin, zmax);
  m_hasArea = true; 
}

SetDelayedWeightingField() [1/2]

void Garfield::ComponentUser::SetDelayedWeightingField	(	const std::string &	expression,
		const std::string &	label )

Set the expression to be used for calculating the delayed weighting field.

Definition at line 312 of file ComponentUser.cc.

                                                                     {
 
  std::string fname = label;
  RemoveSpecialCharacters(fname);
  fname = "fComponentUserDWfield" + fname; 
  auto fPtr = MakeFieldFunction(fname, expression, true, false, true);
  if (!fPtr) {
    std::cerr << m_className << "::SetDelayedWeightingField: "
              << "Could not convert the expression.\n";
    return;
  }
  typedef std::function<void(const double, const double, const double,
                             const double, double&, double&, double&)> Fcn; 
  Fcn& f = *((Fcn *) fPtr);
  m_dwfield[label] = f;
}

SetDelayedWeightingField() [2/2]

void Garfield::ComponentUser::SetDelayedWeightingField	(	std::function< void(const double, const double, const double, const double, double &, double &, double &)>	f,
		const std::string &	label )

Set the function to be called for calculating the delayed weighting field.

Definition at line 299 of file ComponentUser.cc.

                            {
 
  if (!f) {
    std::cerr << m_className << "::SetDelayedWeightingField: "
              << "Function is empty.\n";
    return;
  }
  m_dwfield[label] = f;
}

SetDelayedWeightingPotential() [1/2]

void Garfield::ComponentUser::SetDelayedWeightingPotential	(	const std::string &	expression,
		const std::string &	label )

Set the expression to be used for calculating the delayed weighting potential.

Definition at line 342 of file ComponentUser.cc.

                                                         {
  std::string fname = label;
  RemoveSpecialCharacters(fname);
  fname = "fComponentUserDWpot" + fname; 
  auto fPtr = MakePotentialFunction(fname, expression, true);
  if (!fPtr) {
    std::cerr << m_className << "::SetDelayedWeightingPotential: "
              << "Could not convert the expression.\n";
    return;
  }
  typedef std::function<double(const double, const double, const double,
                               const double)> Fcn;
  Fcn& f = *((Fcn *) fPtr);
  m_dwpot[label] = f;
}

SetDelayedWeightingPotential() [2/2]

void Garfield::ComponentUser::SetDelayedWeightingPotential	(	std::function< double(const double, const double, const double, const double)>	f,
		const std::string &	label )

Set the function to be called for calculating the delayed weighting potential.

Definition at line 330 of file ComponentUser.cc.

                            {
  if (!f) {
    std::cerr << m_className << "::SetDelayedWeightingPotential: "
              << "Function is empty.\n";
    return;
  }
  m_dwpot[label] = f;
}

SetElectricField() [1/2]

void Garfield::ComponentUser::SetElectricField

(

const std::string &

expression

)

Set the expression to be used for calculating the electric field.

Definition at line 208 of file ComponentUser.cc.

                                                                {
  const std::string fname = "fComponentUserEfield";
  auto fPtr = MakeFieldFunction(fname, expression);
  if (!fPtr) {
    std::cerr << m_className << "::SetElectricField: "
              << "Could not convert the expression.\n";
    return;
  }
  typedef std::function<void(const double, const double, const double,
                             double&, double&, double&)> Fcn; 
  Fcn& f = *((Fcn *) fPtr);
  m_efield = f;
  m_ready = true;
}

SetElectricField() [2/2]

void Garfield::ComponentUser::SetElectricField

(

std::function< void(const double, const double, const double, double &, double &, double &)>

f

)

Set the function to be called for calculating the electric field.

Definition at line 197 of file ComponentUser.cc.

                                                      {
  if (!f) {
    std::cerr << m_className << "::SetElectricField: Function is empty.\n";
    return;
  }
  m_efield = f;
  m_ready = true;
}

SetMagneticField() [1/2]

void Garfield::ComponentUser::SetMagneticField

(

const std::string &

expression

)

Set the expression to be used for calculating the magnetic field.

Definition at line 369 of file ComponentUser.cc.

                                                                {
 
  const std::string fname = "fComponentUserBfield";
  auto fPtr = MakeFieldFunction(fname, expression, false, true);
  if (!fPtr) {
    std::cerr << m_className << "::SetMagneticField: "
              << "Could not convert the expression.\n";
    return;
  }
  typedef std::function<void(const double, const double, const double,
                             double&, double&, double&)> Fcn; 
  Fcn& f = *((Fcn *) fPtr);
  m_bfield = f;
}

SetMagneticField() [2/2]

void Garfield::ComponentUser::SetMagneticField

(

std::function< void(const double, const double, const double, double &, double &, double &)>

f

)

Set the function to be called for calculating the magnetic field.

Definition at line 359 of file ComponentUser.cc.

                                                      {
  if (!f) {
    std::cerr << m_className << "::SetMagneticField: Function is empty.\n";
    return;
  }
  m_bfield = f;
}

SetMedium()

void Garfield::ComponentUser::SetMedium ( Medium * medium )

inline

Set the medium in the active area.

Definition at line 85 of file ComponentUser.hh.

{ m_medium = medium; }

SetPotential() [1/2]

void Garfield::ComponentUser::SetPotential

(

const std::string &

expression

)

Set the expression to be used for calculating the electric potential.

Definition at line 232 of file ComponentUser.cc.

                                                            {
  const std::string fname = "fComponentUserEpot";
  auto fPtr = MakePotentialFunction(fname, expression);
  if (!fPtr) {
    std::cerr << m_className << "::SetPotential: "
              << "Could not convert the expression.\n";
    return;
  }
  typedef std::function<double(const double, const double, const double)> Fcn;
  Fcn& f = *((Fcn *) fPtr);
  m_epot = f;
}

SetPotential() [2/2]

void Garfield::ComponentUser::SetPotential

(

std::function< double(const double, const double, const double)>

f

)

Set the function to be called for calculating the electric potential.

Definition at line 223 of file ComponentUser.cc.

                                                                     {
  if (!f) {
    std::cerr << m_className << "::SetPotential: Function is empty.\n";
    return;
  }
  m_epot = f;
}

SetWeightingField() [1/2]

void Garfield::ComponentUser::SetWeightingField	(	const std::string &	expression,
		const std::string &	label )

Set the expression to be used for calculating the weighting field.

Definition at line 256 of file ComponentUser.cc.

                                                              {
  std::string fname = label;
  RemoveSpecialCharacters(fname);
  fname = "fComponentUserWfield" + fname; 
  auto fPtr = MakeFieldFunction(fname, expression, true);
  if (!fPtr) {
    std::cerr << m_className << "::SetWeightingField: "
              << "Could not convert the expression.\n";
    return;
  }
  typedef std::function<void(const double, const double, const double,
                             double&, double&, double&)> Fcn; 
  Fcn& f = *((Fcn *) fPtr);
  m_wfield[label] = f;
}

SetWeightingField() [2/2]

void Garfield::ComponentUser::SetWeightingField	(	std::function< void(const double, const double, const double, double &, double &, double &)>	f,
		const std::string &	label )

Set the function to be called for calculating the weighting field.

Definition at line 245 of file ComponentUser.cc.

                            {
  if (!f) {
    std::cerr << m_className << "::SetWeightingField: Function is empty.\n";
    return;
  }
  m_wfield[label] = f;
}

SetWeightingPotential() [1/2]

void Garfield::ComponentUser::SetWeightingPotential	(	const std::string &	expression,
		const std::string &	label )

Set the expression to be used for calculating the weighting potential.

Definition at line 283 of file ComponentUser.cc.

                                                                  {
  std::string fname = label;
  RemoveSpecialCharacters(fname);
  fname = "fComponentUserWpot" + fname; 
  auto fPtr = MakePotentialFunction(fname, expression);
  if (!fPtr) {
    std::cerr << m_className << "::SetWeightingPotential: "
              << "Could not convert the expression.\n";
    return;
  }
  typedef std::function<double(const double, const double, const double)> Fcn;
  Fcn& f = *((Fcn *) fPtr);
  m_wpot[label] = f;
}

SetWeightingPotential() [2/2]

void Garfield::ComponentUser::SetWeightingPotential	(	std::function< double(const double, const double, const double)>	f,
		const std::string &	label )

Set the function to be called for calculating the weighting potential.

Definition at line 273 of file ComponentUser.cc.

                            {
  if (!f) {
    std::cerr << m_className << "::SetWeightingPotential: Function is empty.\n";
    return;
  }
  m_wpot[label] = f;
}

UnsetArea()

void Garfield::ComponentUser::UnsetArea

(

)

Remove the explicit limits of the active area.

Definition at line 397 of file ComponentUser.cc.

                              {
  m_xmin.fill(0.);
  m_xmax.fill(0.);
  m_hasArea = false;
}

WeightingField()

void Garfield::ComponentUser::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::Component.

Definition at line 141 of file ComponentUser.cc.

                                                                       {
  wx = wy = wz = 0.;
  if (m_wfield.count(label) > 0) {
    m_wfield[label](x, y, z, wx, wy, wz);
  }
}

WeightingPotential()

double Garfield::ComponentUser::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::Component.

Definition at line 150 of file ComponentUser.cc.

                                                                 {
  double v = 0.;
  if (m_wpot.count(label) > 0) v = m_wpot[label](x, y, z);
  return v;
}

---

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

• ComponentUser.hh
• ComponentUser.cc