Garfield++ 4.0
A toolkit for the detailed simulation of particle detectors based on ionisation measurement in gases and semiconductors
Loading...
Searching...
No Matches
Public Member Functions | List of all members
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.
 
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 WeightingField (const double x, const double y, const double z, double &wx, double &wy, double &wz, const std::string &label) override
 
double WeightingPotential (const double x, const double y, const double z, const std::string &label) override
 
bool GetBoundingBox (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) override
 Get the bounding box coordinates.
 
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.
 
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.
 
- Public Member Functions inherited from Garfield::Component
 Component ()=delete
 Default constructor.
 
 Component (const std::string &name)
 Constructor.
 
virtual ~Component ()
 Destructor.
 
virtual void SetGeometry (Geometry *geo)
 Define the geometry.
 
virtual void Clear ()
 Reset.
 
virtual Medium * GetMedium (const double x, const double y, const double z)
 Get the medium at a given location (x, y, z).
 
virtual void ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, Medium *&m, int &status)=0
 
virtual void ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, double &v, Medium *&m, int &status)=0
 Calculate the drift field [V/cm] and potential [V] at (x, y, z).
 
virtual bool GetVoltageRange (double &vmin, double &vmax)=0
 Calculate the voltage range [V].
 
virtual void WeightingField (const double x, const double y, const double z, double &wx, double &wy, double &wz, const std::string &label)
 
virtual double WeightingPotential (const double x, const double y, const double z, const std::string &label)
 
virtual void DelayedWeightingField (const double x, const double y, const double z, const double t, double &wx, double &wy, double &wz, const std::string &label)
 
virtual double DelayedWeightingPotential (const double x, const double y, const double z, const double t, const std::string &label)
 
virtual void MagneticField (const double x, const double y, const double z, double &bx, double &by, double &bz, int &status)
 
void SetMagneticField (const double bx, const double by, const double bz)
 Set a constant magnetic field.
 
virtual bool IsReady ()
 Ready for use?
 
virtual bool GetBoundingBox (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax)
 Get the bounding box coordinates.
 
virtual bool GetElementaryCell (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax)
 Get the coordinates of the elementary cell.
 
double IntegrateFluxCircle (const double xc, const double yc, const double r, const unsigned int nI=50)
 
double IntegrateFluxSphere (const double xc, const double yc, const double zc, const double r, const unsigned int nI=20)
 
double IntegrateFluxParallelogram (const double x0, const double y0, const double z0, const double dx1, const double dy1, const double dz1, const double dx2, const double dy2, const double dz2, const unsigned int nU=20, const unsigned int nV=20)
 
double IntegrateWeightingFluxParallelogram (const std::string &label, const double x0, const double y0, const double z0, const double dx1, const double dy1, const double dz1, const double dx2, const double dy2, const double dz2, const unsigned int nU=20, const unsigned int nV=20)
 
double IntegrateFluxLine (const double x0, const double y0, const double z0, const double x1, const double y1, const double z1, const double xp, const double yp, const double zp, const unsigned int nI, const int isign=0)
 
virtual bool IsWireCrossed (const double x0, const double y0, const double z0, const double x1, const double y1, const double z1, double &xc, double &yc, double &zc, const bool centre, double &rc)
 
virtual bool IsInTrapRadius (const double q0, const double x0, const double y0, const double z0, double &xw, double &yw, double &rw)
 
void EnablePeriodicityX (const bool on=true)
 Enable simple periodicity in the $x$ direction.
 
void EnablePeriodicityY (const bool on=true)
 Enable simple periodicity in the $y$ direction.
 
void EnablePeriodicityZ (const bool on=true)
 Enable simple periodicity in the $z$ direction.
 
void IsPeriodic (bool &perx, bool &pery, bool &perz)
 Return periodicity flags.
 
void EnableMirrorPeriodicityX (const bool on=true)
 Enable mirror periodicity in the $x$ direction.
 
void EnableMirrorPeriodicityY (const bool on=true)
 Enable mirror periodicity in the $y$ direction.
 
void EnableMirrorPeriodicityZ (const bool on=true)
 Enable mirror periodicity in the $y$ direction.
 
void IsMirrorPeriodic (bool &perx, bool &pery, bool &perz)
 Return mirror periodicity flags.
 
void EnableAxialPeriodicityX (const bool on=true)
 Enable axial periodicity in the $x$ direction.
 
void EnableAxialPeriodicityY (const bool on=true)
 Enable axial periodicity in the $y$ direction.
 
void EnableAxialPeriodicityZ (const bool on=true)
 Enable axial periodicity in the $z$ direction.
 
void IsAxiallyPeriodic (bool &perx, bool &pery, bool &perz)
 Return axial periodicity flags.
 
void EnableRotationSymmetryX (const bool on=true)
 Enable rotation symmetry around the $x$ axis.
 
void EnableRotationSymmetryY (const bool on=true)
 Enable rotation symmetry around the $y$ axis.
 
void EnableRotationSymmetryZ (const bool on=true)
 Enable rotation symmetry around the $z$ axis.
 
void IsRotationSymmetric (bool &rotx, bool &roty, bool &rotz)
 Return rotation symmetry flags.
 
void EnableDebugging ()
 Switch on debugging messages.
 
void DisableDebugging ()
 Switch off debugging messages.
 
virtual bool HasAttachmentMap () const
 Does the component have attachment maps?
 
virtual bool HasVelocityMap () const
 Does the component have velocity maps?
 
virtual bool ElectronAttachment (const double, const double, const double, double &eta)
 Get the electron attachment coefficient.
 
virtual bool HoleAttachment (const double, const double, const double, double &eta)
 Get the hole attachment coefficient.
 
virtual bool ElectronVelocity (const double, const double, const double, double &vx, double &vy, double &vz)
 Get the electron drift velocity.
 
virtual bool HoleVelocity (const double, const double, const double, double &vx, double &vy, double &vz)
 Get the hole drift velocity.
 
virtual bool GetElectronLifetime (const double, const double, const double, double &etau)
 
virtual bool GetHoleLifetime (const double, const double, const double, double &htau)
 

Additional Inherited Members

virtual void Reset ()=0
 Reset the component.
 
virtual void UpdatePeriodicity ()=0
 Verify periodicities.
 
- 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

Component with constant electric field.

Definition at line 14 of file ComponentConstant.hh.

Constructor & Destructor Documentation

◆ ComponentConstant()

Garfield::ComponentConstant::ComponentConstant ( )

Constructor.

Definition at line 9 of file ComponentConstant.cc.

9: Component("Constant") {}
Garfield::Component::Component
Component()=delete
Default constructor.

◆ ~ComponentConstant()

Garfield::ComponentConstant::~ComponentConstant ( )
inline

Destructor.

Definition at line 19 of file ComponentConstant.hh.

19{}

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

Definition at line 38 of file ComponentConstant.cc.

41 {
42 ex = m_efield[0];
43 ey = m_efield[1];
44 ez = m_efield[2];
45 if (m_hasPotential) {
46 // Compute the potential at this point.
47 const std::array<double, 3> d = {x - m_x0, y - m_y0, z - m_z0};
48 v = m_v0 - std::inner_product(d.begin(), d.end(), m_efield.begin(), 0.);
49 } else {
50 v = 0.;
51 if (m_debug) {
52 std::cerr << m_className << "::ElectricField: Potential not defined.\n";
53 }
54 }
55 m = GetMedium(x, y, z);
56 if (!m) {
57 if (m_debug) {
58 std::cout << m_className << "::ElectricField: No medium at ("
59 << x << ", " << y << ", " << z << ").\n";
60 }
61 status = -6;
62 return;
63 }
64
65 if (m->IsDriftable()) {
66 status = 0;
67 } else {
68 status = -5;
69 }
70}
Garfield::ComponentConstant::GetMedium
Medium * GetMedium(const double x, const double y, const double z) override
Get the medium at a given location (x, y, z).
Definition: ComponentConstant.cc:11
Garfield::Component::m_debug
bool m_debug
Switch on/off debugging messages.
Definition: Component.hh:341
Garfield::Component::m_className
std::string m_className
Class name.
Definition: Component.hh:329

◆ 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,zcoordinates [cm].
ex,ey,ezcomponents of the electric field [V/cm].
mpointer to the medium at this location.
statusstatus 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 18 of file ComponentConstant.cc.

20 {
21 ex = m_efield[0];
22 ey = m_efield[1];
23 ez = m_efield[2];
24 m = GetMedium(x, y, z);
25 if (!m) {
26 // No medium at this point.
27 status = -6;
28 return;
29 }
30
31 if (m->IsDriftable()) {
32 status = 0;
33 } else {
34 status = -5;
35 }
36}

◆ GetBoundingBox()

bool Garfield::ComponentConstant::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 107 of file ComponentConstant.cc.

109 {
110
111 if (!m_hasArea) {
112 return Component::GetBoundingBox(xmin, ymin, zmin, xmax, ymax, zmax);
113 }
114 xmin = m_xmin[0];
115 ymin = m_xmin[1];
116 zmin = m_xmin[2];
117 xmax = m_xmax[0];
118 ymax = m_xmax[1];
119 zmax = m_xmax[2];
120 return true;
121}
Garfield::Component::GetBoundingBox
virtual bool GetBoundingBox(double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax)
Get the bounding box coordinates.
Definition: Component.cc:99

Referenced by GetVoltageRange().

◆ GetMedium()

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

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

Reimplemented from Garfield::Component.

Definition at line 11 of file ComponentConstant.cc.

12 {
13
14 if (!m_hasArea) return Component::GetMedium(x, y, z);
15 return InArea(x, y, z) ? m_medium : nullptr;
16}
Garfield::Component::GetMedium
virtual Medium * GetMedium(const double x, const double y, const double z)
Get the medium at a given location (x, y, z).
Definition: Component.cc:22

Referenced by ElectricField(), WeightingField(), and WeightingPotential().

◆ GetVoltageRange()

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

Calculate the voltage range [V].

Implements Garfield::Component.

Definition at line 72 of file ComponentConstant.cc.

72 {
73 if (!m_hasPotential) return false;
74
75 double xmin, ymin, zmin;
76 double xmax, ymax, zmax;
77 if (!GetBoundingBox(xmin, ymin, zmin, xmax, ymax, zmax)) {
78 std::cerr << m_className << "::GetVoltageRange:\n"
79 << " Could not determine the bounding box.\n";
80 return false;
81 }
82 // Calculate potentials at each corner
83 const double pxmin = m_v0 - (xmin - m_x0) * m_efield[0];
84 const double pxmax = m_v0 - (xmax - m_x0) * m_efield[0];
85 const double pymin = m_v0 - (ymin - m_y0) * m_efield[1];
86 const double pymax = m_v0 - (ymax - m_y0) * m_efield[1];
87 const double pzmin = m_v0 - (zmin - m_z0) * m_efield[2];
88 const double pzmax = m_v0 - (zmax - m_z0) * m_efield[2];
89 double p[8];
90 p[0] = pxmin + pymin + pzmin;
91 p[1] = pxmin + pymin + pzmax;
92 p[2] = pxmin + pymax + pzmin;
93 p[3] = pxmin + pymax + pzmax;
94 p[4] = pxmax + pymin + pzmin;
95 p[5] = pxmax + pymin + pzmax;
96 p[6] = pxmax + pymax + pzmin;
97 p[7] = pxmax + pymax + pzmax;
98 vmin = vmax = p[7];
99 for (int i = 7; i--;) {
100 if (p[i] > vmax) vmax = p[i];
101 if (p[i] < vmin) vmin = p[i];
102 }
103
104 return true;
105}
Garfield::ComponentConstant::GetBoundingBox
bool GetBoundingBox(double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) override
Get the bounding box coordinates.
Definition: ComponentConstant.cc:107

◆ SetArea()

void Garfield::ComponentConstant::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 193 of file ComponentConstant.cc.

195 {
196
197 m_xmin[0] = std::min(xmin, xmax);
198 m_xmin[1] = std::min(ymin, ymax);
199 m_xmin[2] = std::min(zmin, zmax);
200 m_xmax[0] = std::max(xmin, xmax);
201 m_xmax[1] = std::max(ymin, ymax);
202 m_xmax[2] = std::max(zmin, zmax);
203 m_hasArea = true;
204}

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

154 {
155 m_efield = {ex, ey, ez};
156 if (ex * ex + ey * ey + ez * ez < Small) {
157 std::cerr << m_className << "::SetElectricField: Field set to zero.\n";
158 }
159 m_ready = true;
160}
Garfield::Component::m_ready
bool m_ready
Ready for use?
Definition: Component.hh:338

◆ SetMedium()

void Garfield::ComponentConstant::SetMedium ( Medium *  medium)
inline

Set the medium in the active area.

Definition at line 57 of file ComponentConstant.hh.

57{ m_medium = medium; }

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

163 {
164 m_x0 = x;
165 m_y0 = y;
166 m_z0 = z;
167 m_v0 = v;
168 m_hasPotential = true;
169}

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

173 {
174 m_label = label;
175 m_wfield = {wx, wy, wz};
176 m_hasWeightingField = true;
177}

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

180 {
181 if (!m_hasWeightingField) {
182 std::cerr << m_className << "::SetWeightingPotential:\n"
183 << " Set the weighting field first!\n";
184 return;
185 }
186 m_wx0 = x;
187 m_wy0 = y;
188 m_wz0 = z;
189 m_w0 = v;
190 m_hasWeightingPotential = true;
191}

◆ UnsetArea()

void Garfield::ComponentConstant::UnsetArea ( )

Remove the explicit limits of the active area.

Definition at line 206 of file ComponentConstant.cc.

206 {
207 m_xmin.fill(0.);
208 m_xmax.fill(0.);
209 m_hasArea = false;
210}

◆ 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,zcoordinates [cm].
wx,wy,wzcomponents of the weighting field [1/cm].
labelname of the electrode

Reimplemented from Garfield::Component.

Definition at line 123 of file ComponentConstant.cc.

125 {
126 if (!m_hasWeightingField || label != m_label) return;
127
128 Medium* m = GetMedium(x, y, z);
129 if (!m) {
130 wx = wy = wz = 0.;
131 if (m_debug) {
132 std::cout << m_className << "::WeightingField: No medium at ("
133 << x << ", " << y << ", " << z << ")\n";
134 }
135 return;
136 }
137 wx = m_wfield[0];
138 wy = m_wfield[1];
139 wz = m_wfield[2];
140}

◆ 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,zcoordinates [cm].
labelname of the electrode.
Returns
weighting potential [dimensionless].

Reimplemented from Garfield::Component.

Definition at line 142 of file ComponentConstant.cc.

144 {
145 if (!m_hasWeightingPotential || label != m_label) return 0.;
146 // Make sure we are in the active area.
147 if (!GetMedium(x, y, z)) return 0.;
148 // Compute the potential.
149 const std::array<double, 3> d = {x - m_wx0, y - m_wy0, z - m_wz0};
150 return m_w0 - std::inner_product(d.begin(), d.end(), m_wfield.begin(), 0.);
151}
The documentation for this class was generated from the following files: