Garfield++ 4.0
A toolkit for the detailed simulation of particle detectors based on ionisation measurement in gases and semiconductors
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
Garfield::ComponentNeBem3dMap Class Reference

Component for interpolating field maps stored in a mesh generated by neBEM. More...

#include <ComponentNeBem3dMap.hh>

+ Inheritance diagram for Garfield::ComponentNeBem3dMap:

Public Member Functions

 ComponentNeBem3dMap ()
 Constructor.
 
 ~ComponentNeBem3dMap ()
 Destructor.
 
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 MagneticField (const double x, const double y, const double z, double &bx, double &by, double &bz, int &status) override
 
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.
 
bool LoadMapInfo (const std::string &MapInfoFile, std::string &MapVersion, int &OptMap, int &OptStaggerMap, unsigned int &NbOfXCells, unsigned int &NbOfYCells, unsigned int &NbOfZCells, double &Xmin, double &Xmax, double &Ymin, double &Ymax, double &Zmin, double &Zmax, double &XStagger, double &YStagger, double &ZStagger, std::string &MapDataFile)
 Map related information.
 
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 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::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 for interpolating field maps stored in a mesh generated by neBEM.

Definition at line 10 of file ComponentNeBem3dMap.hh.

Constructor & Destructor Documentation

◆ ComponentNeBem3dMap()

Garfield::ComponentNeBem3dMap::ComponentNeBem3dMap ( )

Constructor.

Definition at line 13 of file ComponentNeBem3dMap.cc.

13: Component("NeBem3dMap") {}
Garfield::Component::Component
Component()=delete
Default constructor.

◆ ~ComponentNeBem3dMap()

Garfield::ComponentNeBem3dMap::~ComponentNeBem3dMap ( )
inline

Destructor.

Definition at line 15 of file ComponentNeBem3dMap.hh.

15{}

Member Function Documentation

◆ ElectricField() [1/2]

void Garfield::ComponentNeBem3dMap::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 15 of file ComponentNeBem3dMap.cc.

18 {
19 if (m_debug) std::cout << m_className << ": In ElectricField\n";
20
21 m = nullptr;
22 // Make sure the field map has been loaded.
23 if (!m_ready) {
24 std::cerr << m_className << "::ElectricField:\n"
25 << " Field map is not available for interpolation.\n";
26 status = -10;
27 return;
28 }
29
30 // Get the mesh element - values of the lowest corner, i,j,k are returned
31 // For trilinear interpolation, we need to use till the i+1, j+1, k+1 corner
32 unsigned int i = 0, j = 0, k = 0;
33 bool xMirrored = false, yMirrored = false, zMirrored = false;
34 if (!GetElement(x, y, z, i, j, k, xMirrored, yMirrored, zMirrored)) {
35 status = -11;
36 return;
37 }
38 status = 0;
39 if (m_debug) {
40 std::cout << "x, y, z: " << x << ", " << y << ", " << z << "\n"
41 << "i, j, k: " << i << ", " << j << ", " << k << std::endl;
42 }
43 { // adjustment, if needed. int adj not needed outside this block
44 int adj = 0;
45 if (i >= m_nX - 1) {
46 i = m_nX - 1; // CHECK! arbitrary adjustment to avoid index overflow
47 adj = 1;
48 }
49 if (j >= m_nY - 1) {
50 j = m_nY - 1; // This should not happen
51 adj = 1;
52 }
53 if (k >= m_nZ - 1) {
54 k = m_nZ - 1;
55 adj = 1;
56 }
57 if (adj) {
58 std::cout << "x, y, z: " << x << ", " << y << ", " << z << "\n"
59 << "adjusted indices:\n "
60 << "i, j, k: " << i << ", " << j << ", " << k << std::endl;
61 }
62 } // adjustment block
63
64 // Get the electric field and potential using values of six corners.
65 Element& element = m_efields[i][j][k];
66 double ex000 = element.fx;
67 double ey000 = element.fy;
68 double ez000 = element.fz;
69 if (xMirrored) ex = -ex;
70 if (yMirrored) ey = -ey;
71 if (zMirrored) ez = -ez;
72 double p000 = element.v;
73 // Get the medium.
74 int region = m_regions[i][j][k];
75 if (region < 0 || region > (int)m_media.size()) {
76 m = nullptr;
77 status = -5;
78 return;
79 }
80 Medium* m000 = m_media[region];
81 if (!m000) status = -5;
82
83 element = m_efields[i + 1][j][k];
84 double ex100 = element.fx;
85 double ey100 = element.fy;
86 double ez100 = element.fz;
87 if (xMirrored) ex = -ex;
88 if (yMirrored) ey = -ey;
89 if (zMirrored) ez = -ez;
90 double p100 = element.v;
91 // Get the medium.
92 region = m_regions[i + 1][j][k];
93 if (region < 0 || region > (int)m_media.size()) {
94 m = nullptr;
95 status = -5;
96 return;
97 }
98 Medium* m100 = m_media[region];
99 if (!m100) status = -5;
100
101 element = m_efields[i][j + 1][k];
102 double ex010 = element.fx;
103 double ey010 = element.fy;
104 double ez010 = element.fz;
105 if (xMirrored) ex = -ex;
106 if (yMirrored) ey = -ey;
107 if (zMirrored) ez = -ez;
108 double p010 = element.v;
109 // Get the medium.
110 region = m_regions[i][j + 1][k];
111 if (region < 0 || region > (int)m_media.size()) {
112 m = nullptr;
113 status = -5;
114 return;
115 }
116 Medium* m010 = m_media[region];
117 if (!m010) status = -5;
118
119 element = m_efields[i][j][k + 1];
120 double ex001 = element.fx;
121 double ey001 = element.fy;
122 double ez001 = element.fz;
123 if (xMirrored) ex = -ex;
124 if (yMirrored) ey = -ey;
125 if (zMirrored) ez = -ez;
126 double p001 = element.v;
127 // Get the medium.
128 region = m_regions[i][j][k + 1];
129 if (region < 0 || region > (int)m_media.size()) {
130 m = nullptr;
131 status = -5;
132 return;
133 }
134 Medium* m001 = m_media[region];
135 if (!m001) status = -5;
136
137 element = m_efields[i + 1][j + 1][k];
138 double ex110 = element.fx;
139 double ey110 = element.fy;
140 double ez110 = element.fz;
141 if (xMirrored) ex = -ex;
142 if (yMirrored) ey = -ey;
143 if (zMirrored) ez = -ez;
144 double p110 = element.v;
145 // Get the medium.
146 region = m_regions[i + 1][j + 1][k];
147 if (region < 0 || region > (int)m_media.size()) {
148 m = nullptr;
149 status = -5;
150 return;
151 }
152 Medium* m110 = m_media[region];
153 if (!m110) status = -5;
154
155 element = m_efields[i + 1][j][k + 1];
156 double ex101 = element.fx;
157 double ey101 = element.fy;
158 double ez101 = element.fz;
159 if (xMirrored) ex = -ex;
160 if (yMirrored) ey = -ey;
161 if (zMirrored) ez = -ez;
162 double p101 = element.v;
163 // Get the medium.
164 region = m_regions[i + 1][j][k + 1];
165 if (region < 0 || region > (int)m_media.size()) {
166 m = nullptr;
167 status = -5;
168 return;
169 }
170 Medium* m101 = m_media[region];
171 if (!m101) status = -5;
172
173 element = m_efields[i][j + 1][k + 1];
174 double ex011 = element.fx;
175 double ey011 = element.fy;
176 double ez011 = element.fz;
177 if (xMirrored) ex = -ex;
178 if (yMirrored) ey = -ey;
179 if (zMirrored) ez = -ez;
180 double p011 = element.v;
181 // Get the medium.
182 region = m_regions[i][j + 1][k + 1];
183 if (region < 0 || region > (int)m_media.size()) {
184 m = nullptr;
185 status = -5;
186 return;
187 }
188 Medium* m011 = m_media[region];
189 if (!m011) status = -5;
190
191 element = m_efields[i + 1][j + 1][k + 1];
192 double ex111 = element.fx;
193 double ey111 = element.fy;
194 double ez111 = element.fz;
195 if (xMirrored) ex = -ex;
196 if (yMirrored) ey = -ey;
197 if (zMirrored) ez = -ez;
198 double p111 = element.v;
199 // Get the medium.
200 region = m_regions[i + 1][j + 1][k + 1];
201 if (region < 0 || region > (int)m_media.size()) {
202 m = nullptr;
203 status = -5;
204 return;
205 }
206 Medium* m111 = m_media[region];
207 if (!m111) status = -5;
208
209 double delx = (m_xMax - m_xMin) / double(m_nX - 1);
210 double x0 = m_xMin + double(i) * delx;
211 double x1 = m_xMin + double(i + 1) * delx;
212 double dely = (m_yMax - m_yMin) / double(m_nY - 1);
213 double y0 = m_yMin + double(j) * dely;
214 double y1 = m_yMin + double(j + 1) * dely;
215 double delz = (m_zMax - m_zMin) / double(m_nZ - 1);
216 double z0 = m_zMin + double(k) * delz;
217 double z1 = m_zMin + double(k + 1) * delz;
218 double dx0 = (x - x0);
219 double dx1 = (x1 - x);
220 double dy0 = (y - y0);
221 double dy1 = (y1 - y);
222 double dz0 = (z - z0);
223 double dz1 = (z1 - z);
224 double xd = (x - x0) / (x1 - x0);
225 if (xd < 0.0) xd = 0.0;
226 if (xd > 1.0) xd = 1.0;
227 double yd = (y - y0) / (y1 - y0);
228 if (yd < 0.0) yd = 0.0;
229 if (yd > 1.0) yd = 1.0;
230 double zd = (z - z0) / (z1 - z0);
231 if (zd < 0.0) zd = 0.0;
232 if (zd > 1.0) zd = 1.0;
233 ex = TriLinInt(xd, yd, zd, ex000, ex100, ex010, ex001, ex110, ex101, ex011,
234 ex111);
235 ey = TriLinInt(xd, yd, zd, ey000, ey100, ey010, ey001, ey110, ey101, ey011,
236 ey111);
237 ez = TriLinInt(xd, yd, zd, ez000, ez100, ez010, ez001, ez110, ez101, ez011,
238 ez111);
239 p = TriLinInt(xd, yd, zd, p000, p100, p010, p001, p110, p101, p011, p111);
240 /*
241 m = either this material or that!
242 Material value is that of the nearest node
243 If there are equidistant nodes, m is the lower value to give drift a chance.
244 */
245 double d000 = sqrt(dx0 * dx0 + dy0 * dy0 + dz0 * dz0);
246 double d100 = sqrt(dx1 * dx1 + dy0 * dy0 + dz0 * dz0);
247 double d010 = sqrt(dx0 * dx0 + dy1 * dy1 + dz0 * dz0);
248 double d001 = sqrt(dx0 * dx0 + dy0 * dy0 + dz1 * dz1);
249 double d110 = sqrt(dx1 * dx1 + dy1 * dy1 + dz0 * dz0);
250 double d101 = sqrt(dx1 * dx1 + dy0 * dy0 + dz1 * dz1);
251 double d011 = sqrt(dx0 * dx0 + dy1 * dy1 + dz1 * dz1);
252 double d111 = sqrt(dx1 * dx1 + dy1 * dy1 + dz1 * dz1);
253
254 // The lower value notion is not implemented yet
255 // At present the algo works benefiting the last match for a condition.
256 // int mindx = 0;
257 double mindst = d000;
258 m = m000;
259 if (d100 <= mindst) {
260 // mindx = 1;
261 mindst = d100;
262 m = m100;
263 } else if (d010 <= mindst) {
264 // mindx = 2;
265 mindst = d010;
266 m = m010;
267 } else if (d001 <= mindst) {
268 // mindx = 3;
269 mindst = d001;
270 m = m001;
271 } else if (d110 <= mindst) {
272 // mindx = 4;
273 mindst = d110;
274 m = m110;
275 } else if (d101 <= mindst) {
276 // mindx = 5;
277 mindst = d101;
278 m = m101;
279 } else if (d011 <= mindst) {
280 // mindx = 6;
281 mindst = d011;
282 m = m011;
283 } else if (d111 <= mindst) {
284 // mindx = 7;
285 mindst = d111;
286 m = m111;
287 }
288
289 if (m_debug) {
290 std::cout << "x, y, z: " << x << ", " << y << ", " << z << "\n"
291 << "i, j, k: " << i << ", " << j << ", " << k << "\n"
292 << "000=> ex, ey, ez, p, m: " << ex000 << ", " << ey000 << ", "
293 << ez000 << ", " << p000 << ", " << m000 << "\n"
294 << "100=> ex, ey, ez, p, m: " << ex100 << ", " << ey100 << ", "
295 << ez100 << ", " << p100 << ", " << m100 << std::endl
296 << "010=> ex, ey, ez, p, m: " << ex010 << ", " << ey010 << ", "
297 << ez010 << ", " << p010 << ", " << m010 << std::endl
298 << "001=> ex, ey, ez, p, m: " << ex001 << ", " << ey001 << ", "
299 << ez001 << ", " << p001 << ", " << m001 << std::endl
300 << "110=> ex, ey, ez, p, m: " << ex110 << ", " << ey110 << ", "
301 << ez110 << ", " << p110 << ", " << m110 << std::endl
302 << "101=> ex, ey, ez, p, m: " << ex101 << ", " << ey101 << ", "
303 << ez101 << ", " << p101 << ", " << m101 << std::endl
304 << "011=> ex, ey, ez, p, m: " << ex011 << ", " << ey011 << ", "
305 << ez011 << ", " << p011 << ", " << m011 << std::endl
306 << "111=> ex, ey, ez, p, m: " << ex111 << ", " << ey111 << ", "
307 << ez111 << ", " << p111 << ", " << m111 << std::endl
308 << "delx, x, x0, x1, dx0, dx1, xd: " << delx << ", " << x << ", "
309 << x0 << ", " << x1 << ", " << dx0 << ", " << dx1 << ", " << xd
310 << std::endl
311 << "dely, y, y0, y1, dy0, dy1, yd: " << dely << ", " << y << ", "
312 << y0 << ", " << y1 << ", " << dy0 << ", " << dy1 << ", " << yd
313 << std::endl
314 << "delz, z, z0, z1, dz0, dz1, zd: " << delz << ", " << z << ", "
315 << z0 << ", " << z1 << ", " << dz0 << ", " << dz1 << ", " << zd
316 << std::endl
317 << "Values after LinInt=> ex, ey, ez, p, m: " << ex << ", " << ey
318 << ", " << ez << ", " << p << ", " << m << std::endl;
319 }
320 /*
321 ex = ex000; // manual override interpolation
322 ey = ey000;
323 ez = ez000;
324 p = p000;
325 m = m000; // override the nearest node material assignment
326 */
327}
Garfield::ComponentNeBem3dMap::GetElement
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.
Definition: ComponentNeBem3dMap.cc:1146
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
Garfield::Component::m_ready
bool m_ready
Ready for use?
Definition: Component.hh:338
Heed::sqrt
DoubleAc sqrt(const DoubleAc &f)
Definition: DoubleAc.cpp:314
Element
Definition: neBEM.h:155

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

◆ ElectricField() [2/2]

void Garfield::ComponentNeBem3dMap::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 329 of file ComponentNeBem3dMap.cc.

331 {
332 double v = 0.;
333 ElectricField(x, y, z, ex, ey, ez, v, m, status);
334}
Garfield::ComponentNeBem3dMap::ElectricField
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).
Definition: ComponentNeBem3dMap.cc:15

◆ GetBoundingBox()

bool Garfield::ComponentNeBem3dMap::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 1042 of file ComponentNeBem3dMap.cc.

1044 {
1045 if (!m_ready) return false;
1046 if (m_periodic[0] || m_mirrorPeriodic[0]) {
1047 xmin = -INFINITY;
1048 xmax = +INFINITY;
1049 } else {
1050 xmin = m_xMin;
1051 xmax = m_xMax;
1052 }
1053
1054 if (m_periodic[1] || m_mirrorPeriodic[1]) {
1055 ymin = -INFINITY;
1056 ymax = +INFINITY;
1057 } else {
1058 ymin = m_yMin;
1059 ymax = m_yMax;
1060 }
1061
1062 if (m_periodic[2] || m_mirrorPeriodic[2]) {
1063 zmin = -INFINITY;
1064 zmax = +INFINITY;
1065 } else {
1066 zmin = m_zMin;
1067 zmax = m_zMax;
1068 }
1069 return true;
1070}
Garfield::Component::m_mirrorPeriodic
std::array< bool, 3 > m_mirrorPeriodic
Mirror periodicity in x, y, z.
Definition: Component.hh:346
Garfield::Component::m_periodic
std::array< bool, 3 > m_periodic
Simple periodicity in x, y, z.
Definition: Component.hh:344

◆ GetElectricFieldRange()

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

Definition at line 1079 of file ComponentNeBem3dMap.cc.

1081 {
1082 if (!m_ready) {
1083 std::cerr << m_className << "::GetElectricFieldRange:\n";
1084 std::cerr << " Field map not available.\n";
1085 return false;
1086 }
1087
1088 exmin = exmax = m_efields[0][0][0].fx;
1089 eymin = eymax = m_efields[0][0][0].fy;
1090 ezmin = ezmax = m_efields[0][0][0].fz;
1091 for (unsigned int i = 0; i < m_nX; ++i) {
1092 for (unsigned int j = 0; j < m_nY; ++j) {
1093 for (unsigned int k = 0; k < m_nZ; ++k) {
1094 const Element& element = m_efields[i][j][k];
1095 if (element.fx < exmin) exmin = element.fx;
1096 if (element.fx > exmax) exmax = element.fx;
1097 if (element.fy < eymin) eymin = element.fy;
1098 if (element.fy > eymax) eymax = element.fy;
1099 if (element.fz < ezmin) ezmin = element.fz;
1100 if (element.fz > ezmax) ezmax = element.fz;
1101 }
1102 }
1103 }
1104 return true;
1105}

◆ GetElement() [1/2]

bool Garfield::ComponentNeBem3dMap::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 1146 of file ComponentNeBem3dMap.cc.

1150 {
1151 if (!m_hasMesh) {
1152 std::cerr << m_className << "::GetElement: Mesh is not set.\n";
1153 return false;
1154 }
1155
1156 // Reduce the point to the basic cell (in case of periodicity) and
1157 // check if it is inside the mesh.
1158 const double x =
1159 Reduce(xi, m_xMin, m_xMax, m_periodic[0], m_mirrorPeriodic[0], xMirrored);
1160 if (x < m_xMin || x > m_xMax) return false;
1161 const double y =
1162 Reduce(yi, m_yMin, m_yMax, m_periodic[1], m_mirrorPeriodic[1], yMirrored);
1163 if (y < m_yMin || y > m_yMax) return false;
1164 const double z =
1165 Reduce(zi, m_zMin, m_zMax, m_periodic[2], m_mirrorPeriodic[2], zMirrored);
1166 if (z < m_zMin || z > m_zMax) return false;
1167
1168 // Get the indices.
1169 const double dx =
1170 (m_xMax - m_xMin) /
1171 (m_nX - 1); // m_nX is number of nodes, (m_nX-1) number of elements
1172 const double dy = (m_yMax - m_yMin) / (m_nY - 1);
1173 const double dz = (m_zMax - m_zMin) / (m_nZ - 1);
1174 i = (unsigned int)((x - m_xMin) / dx);
1175 j = (unsigned int)((y - m_yMin) / dy);
1176 k = (unsigned int)((z - m_zMin) / dz);
1177 if (i >= m_nX) i = m_nX - 1;
1178 if (j >= m_nY) j = m_nY - 1;
1179 if (k >= m_nZ) k = m_nZ - 1;
1180 if (m_debug) {
1181 std::cout << m_className << ":In GetElement\n"
1182 << "x, y, z: " << x << ", " << y << ", " << z << std::endl
1183 << "m_xMax, m_yMax, m_zMax: " << m_xMax << ", " << m_yMax << ", "
1184 << m_zMax << std::endl
1185 << "m_xMin, m_yMin, m_zMin: " << m_xMin << ", " << m_yMin << ", "
1186 << m_zMin << std::endl
1187 << "m_nX, m_nY, m_nZ: " << m_nX << ", " << m_nY << ", " << m_nZ
1188 << std::endl
1189 << "dx, dy, dz: " << dx << ", " << dy << ", " << dz << std::endl
1190 << "x-m_xMin, y-m_yMin, z-m_zMin: " << x - m_xMin << ", "
1191 << y - m_yMin << ", " << z - m_zMin << std::endl
1192 << "i, j, k: " << i << ", " << j << ", " << k << std::endl
1193 << "End GetElement" << std::endl;
1194 }
1195 return true;
1196}

Referenced by ElectricField(), GetMedium(), and MagneticField().

◆ GetElement() [2/2]

bool Garfield::ComponentNeBem3dMap::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 1198 of file ComponentNeBem3dMap.cc.

1200 {
1201 v = ex = ey = ez = 0.;
1202 if (!m_ready) {
1203 if (!m_hasMesh) {
1204 std::cerr << m_className << "::GetElement: Mesh not set.\n";
1205 return false;
1206 }
1207 std::cerr << m_className << "::GetElement: Field map not set.\n";
1208 return false;
1209 }
1210 if (i >= m_nX || j >= m_nY || k >= m_nZ) {
1211 std::cerr << m_className << "::GetElement: Index out of range.\n";
1212 return false;
1213 }
1214 const Element& element = m_efields[i][j][k];
1215 v = element.v;
1216 ex = element.fx;
1217 ey = element.fy;
1218 ez = element.fz;
1219 return true;
1220}

◆ GetMedium() [1/2]

Medium * Garfield::ComponentNeBem3dMap::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 396 of file ComponentNeBem3dMap.cc.

397 {
398 // Make sure the field map has been loaded.
399 if (!m_ready) {
400 std::cerr << m_className << "::GetMedium:\n"
401 << " Field map is not available for interpolation.\n";
402 return nullptr;
403 }
404
405 unsigned int i, j, k;
406 bool xMirrored, yMirrored, zMirrored;
407 if (!GetElement(x, y, z, i, j, k, xMirrored, yMirrored, zMirrored)) {
408 return nullptr;
409 }
410 const int region = m_regions[i][j][k];
411 if (region < 0 || region > (int)m_media.size()) return nullptr;
412 return m_media[region];
413}

◆ GetMedium() [2/2]

Medium * Garfield::ComponentNeBem3dMap::GetMedium ( const unsigned int  i) const

Get the medium in region i.

Definition at line 1138 of file ComponentNeBem3dMap.cc.

1138 {
1139 if (i >= m_media.size()) {
1140 std::cerr << m_className << "::GetMedium: Index out of range.\n";
1141 return nullptr;
1142 }
1143 return m_media[i];
1144}

◆ GetVoltageRange()

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

Calculate the voltage range [V].

Implements Garfield::Component.

Definition at line 1072 of file ComponentNeBem3dMap.cc.

1072 {
1073 if (!m_ready) return false;
1074 vmin = m_pMin;
1075 vmax = m_pMax;
1076 return true;
1077}

◆ LoadElectricField()

bool Garfield::ComponentNeBem3dMap::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 703 of file ComponentNeBem3dMap.cc.

706 {
707 m_ready = false;
708 m_hasPotential = m_hasEfield = false;
709 if (!m_hasMesh) {
710 std::cerr << m_className << "::LoadElectricField:\n"
711 << " Mesh is not set. Call SetMesh first.\n";
712 return false;
713 }
714
715 // Set up the grid.
716 m_efields.resize(m_nX);
717 m_regions.resize(m_nX);
718 for (unsigned int i = 0; i < m_nX; ++i) {
719 m_efields[i].resize(m_nY);
720 m_regions[i].resize(m_nY);
721 for (unsigned int j = 0; j < m_nY; ++j) {
722 m_efields[i][j].resize(m_nZ);
723 m_regions[i][j].resize(m_nZ);
724 for (unsigned int k = 0; k < m_nZ; ++k) {
725 m_efields[i][j][k].fx = 0.;
726 m_efields[i][j][k].fy = 0.;
727 m_efields[i][j][k].fz = 0.;
728 m_efields[i][j][k].v = 0.;
729 m_regions[i][j][k] = 0;
730 }
731 }
732 }
733
734 m_pMin = m_pMax = 0.;
735 if (withPotential) {
736 m_pMin = 1.;
737 m_pMax = -1.;
738 }
739 return LoadData(filename, format, withPotential, withRegion, scaleX, scaleE,
740 scaleP, 'e');
741}

◆ LoadMagneticField()

bool Garfield::ComponentNeBem3dMap::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 743 of file ComponentNeBem3dMap.cc.

746 {
747 m_hasBfield = false;
748 if (!m_hasMesh) {
749 std::cerr << m_className << "::LoadMagneticField:\n"
750 << " Mesh is not set. Call SetMesh first.\n";
751 return false;
752 }
753
754 // Set up the grid.
755 m_bfields.resize(m_nX);
756 for (unsigned int i = 0; i < m_nX; ++i) {
757 m_bfields[i].resize(m_nY);
758 for (unsigned int j = 0; j < m_nY; ++j) {
759 m_bfields[i][j].resize(m_nZ);
760 for (unsigned int k = 0; k < m_nZ; ++k) {
761 m_bfields[i][j][k].fx = 0.;
762 m_bfields[i][j][k].fy = 0.;
763 m_bfields[i][j][k].fz = 0.;
764 m_bfields[i][j][k].v = 0.;
765 }
766 }
767 }
768
769 return LoadData(filename, format, false, false, scaleX, scaleB, 1., 'b');
770}

◆ LoadMapInfo()

bool Garfield::ComponentNeBem3dMap::LoadMapInfo ( const std::string &  MapInfoFile,
std::string &  MapVersion,
int &  OptMap,
int &  OptStaggerMap,
unsigned int &  NbOfXCells,
unsigned int &  NbOfYCells,
unsigned int &  NbOfZCells,
double &  Xmin,
double &  Xmax,
double &  Ymin,
double &  Ymax,
double &  Zmin,
double &  Zmax,
double &  XStagger,
double &  YStagger,
double &  ZStagger,
std::string &  MapDataFile 
)

Map related information.

Read map information from file.

Definition at line 416 of file ComponentNeBem3dMap.cc.

421 {
422 std::ifstream infile;
423 infile.open(MapInfoFile.c_str(), std::ios::in);
424 if (!infile) {
425 std::cerr << m_className << "::LoadMapInfo:\n"
426 << " Could not open file " << MapInfoFile << ".\n";
427 return false;
428 }
429
430 std::string line;
431 unsigned int nLines = 0;
432
433 // read version string
434 if (!infile.fail()) {
435 // Read one line.
436 std::getline(infile, line);
437 ++nLines;
438
439 std::istringstream data;
440 data.str(line);
441 data >> MapVersion;
442
443 if (data.fail()) {
444 std::cerr << m_className << "::LoadMapInfo:\n"
445 << " Error reading line " << nLines << ".\n"
446 << " Cannot retrieve MapVersion.\n";
447 return false;
448 }
449 } // version string
450
451 // read OptMap
452 if (!infile.fail()) {
453 // Read one line.
454 std::getline(infile, line);
455 ++nLines;
456
457 std::istringstream data;
458 data.str(line);
459 data >> OptMap;
460
461 if (data.fail()) {
462 std::cerr << m_className << "::LoadMapInfo:\n"
463 << " Error reading line " << nLines << ".\n"
464 << " Cannot retrieve OptMap.\n";
465 return false;
466 }
467 } // OptMap
468
469 // read OptStaggerMap
470 if (!infile.fail()) {
471 // Read one line.
472 std::getline(infile, line);
473 ++nLines;
474
475 std::istringstream data;
476 data.str(line);
477 data >> OptStaggerMap;
478
479 if (data.fail()) {
480 std::cerr << m_className << "::LoadMapInfo:\n"
481 << " Error reading line " << nLines << ".\n"
482 << " Cannot retrieve OptStaggerMap.\n";
483 return false;
484 }
485 } // OptStaggerMap
486
487 // read NbOfXCells
488 if (!infile.fail()) {
489 // Read one line.
490 std::getline(infile, line);
491 ++nLines;
492
493 std::istringstream data;
494 data.str(line);
495 data >> NbOfXCells;
496
497 if (data.fail()) {
498 std::cerr << m_className << "::LoadMapInfo:\n"
499 << " Error reading line " << nLines << ".\n"
500 << " Cannot retrieve NbOfXCells.\n";
501 return false;
502 }
503 } // NbOfXCells
504
505 // read NbOfYCells
506 if (!infile.fail()) {
507 // Read one line.
508 std::getline(infile, line);
509 ++nLines;
510
511 std::istringstream data;
512 data.str(line);
513 data >> NbOfYCells;
514
515 if (data.fail()) {
516 std::cerr << m_className << "::LoadMapInfo:\n"
517 << " Error reading line " << nLines << ".\n"
518 << " Cannot retrieve NbOfYCells.\n";
519 return false;
520 }
521 } // NbOfYCells
522
523 // read NbOfZCells
524 if (!infile.fail()) {
525 // Read one line.
526 std::getline(infile, line);
527 ++nLines;
528
529 std::istringstream data;
530 data.str(line);
531 data >> NbOfZCells;
532
533 if (data.fail()) {
534 std::cerr << m_className << "::LoadMapInfo:\n"
535 << " Error reading line " << nLines << ".\n"
536 << " Cannot retrieve NbOfZCells.\n";
537 return false;
538 }
539 } // NbOfZCells
540
541 // read Xmin, Xmax
542 if (!infile.fail()) {
543 // Read one line.
544 std::getline(infile, line);
545 ++nLines;
546
547 std::istringstream data;
548 data.str(line);
549 data >> Xmin >> Xmax;
550
551 if (data.fail()) {
552 std::cerr << m_className << "::LoadMapInfo:\n"
553 << " Error reading line " << nLines << ".\n"
554 << " Cannot retrieve Xmin, Xmax.\n";
555 return false;
556 }
557 } // Xmin, Xmax
558
559 // read Ymin, Ymax
560 if (!infile.fail()) {
561 // Read one line.
562 std::getline(infile, line);
563 ++nLines;
564
565 std::istringstream data;
566 data.str(line);
567 data >> Ymin >> Ymax;
568
569 if (data.fail()) {
570 std::cerr << m_className << "::LoadMapInfo:\n"
571 << " Error reading line " << nLines << ".\n"
572 << " Cannot retrieve Ymin, Ymax.\n";
573 return false;
574 }
575 } // Ymin, Ymax
576
577 // read Zmin, Zmax
578 if (!infile.fail()) {
579 // Read one line.
580 std::getline(infile, line);
581 ++nLines;
582
583 std::istringstream data;
584 data.str(line);
585 data >> Zmin >> Zmax;
586
587 if (data.fail()) {
588 std::cerr << m_className << "::LoadMapInfo:\n"
589 << " Error reading line " << nLines << ".\n"
590 << " Cannot retrieve Zmin, Zmax.\n";
591 return false;
592 }
593 } // Zmin, Zmax
594
595 // read XStagger
596 if (!infile.fail()) {
597 // Read one line.
598 std::getline(infile, line);
599 ++nLines;
600
601 std::istringstream data;
602 data.str(line);
603 data >> XStagger;
604
605 if (data.fail()) {
606 std::cerr << m_className << "::LoadMapInfo:\n"
607 << " Error reading line " << nLines << ".\n"
608 << " Cannot retrieve XStagger.\n";
609 return false;
610 }
611 } // XStagger
612
613 // read YStagger
614 if (!infile.fail()) {
615 // Read one line.
616 std::getline(infile, line);
617 ++nLines;
618
619 std::istringstream data;
620 data.str(line);
621 data >> YStagger;
622
623 if (data.fail()) {
624 std::cerr << m_className << "::LoadMapInfo:\n"
625 << " Error reading line " << nLines << ".\n"
626 << " Cannot retrieve YStagger.\n";
627 return false;
628 }
629 } // YStagger
630
631 // read ZStagger
632 if (!infile.fail()) {
633 // Read one line.
634 std::getline(infile, line);
635 ++nLines;
636
637 std::istringstream data;
638 data.str(line);
639 data >> ZStagger;
640
641 if (data.fail()) {
642 std::cerr << m_className << "::LoadMapInfo:\n"
643 << " Error reading line " << nLines << ".\n"
644 << " Cannot retrieve ZStagger.\n";
645 return false;
646 }
647 } // ZStagger
648
649 // read MapDataFile
650 if (!infile.fail()) {
651 // Read one line.
652 std::getline(infile, line);
653 ++nLines;
654
655 std::istringstream data;
656 data.str(line);
657 data >> MapDataFile;
658
659 if (data.fail()) {
660 std::cerr << m_className << "::LoadMapInfo:\n"
661 << " Error reading line " << nLines << ".\n"
662 << " Cannot retrieve MapDataFile.\n";
663 return false;
664 }
665 } // MapDataFile
666
667 return true;
668} // end of LoadMapInfo
OptStaggerMap
neBEMGLOBAL int OptStaggerMap
Definition: neBEM.h:379
MapVersion
neBEMGLOBAL char MapVersion[10]
Definition: neBEM.h:380
OptMap
neBEMGLOBAL int OptMap
Definition: neBEM.h:378

◆ MagneticField()

void Garfield::ComponentNeBem3dMap::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,zcoordinates [cm].
bx,by,bzcomponents of the magnetic field [Tesla].
statusstatus flag.

Reimplemented from Garfield::Component.

Definition at line 371 of file ComponentNeBem3dMap.cc.

373 {
374 if (!m_hasBfield) {
375 return Component::MagneticField(x, y, z, bx, by, bz, status);
376 }
377
378 // Get the mesh element.
379 unsigned int i = 0, j = 0, k = 0;
380 bool xMirrored = false, yMirrored = false, zMirrored = false;
381 if (!GetElement(x, y, z, i, j, k, xMirrored, yMirrored, zMirrored)) {
382 status = -11;
383 return;
384 }
385 status = 0;
386 // Get the field.
387 const Element& element = m_bfields[i][j][k];
388 bx = element.fx;
389 by = element.fy;
390 bz = element.fz;
391 if (xMirrored) bx = -bx;
392 if (yMirrored) by = -by;
393 if (zMirrored) bz = -bz;
394}
Garfield::Component::MagneticField
virtual void MagneticField(const double x, const double y, const double z, double &bx, double &by, double &bz, int &status)
Definition: Component.cc:81

◆ PrintRegions()

void Garfield::ComponentNeBem3dMap::PrintRegions ( ) const

Print all regions.

Definition at line 1107 of file ComponentNeBem3dMap.cc.

1107 {
1108 // Do not proceed if not properly initialised.
1109 if (!m_ready) {
1110 std::cerr << m_className << "::PrintRegions:\n"
1111 << " Field map not yet initialised.\n";
1112 return;
1113 }
1114
1115 if (m_media.empty()) {
1116 std::cerr << m_className << "::PrintRegions: No regions defined.\n";
1117 return;
1118 }
1119
1120 std::cout << m_className << "::PrintRegions:\n";
1121 std::cout << " Index Medium\n";
1122 const unsigned int nMedia = m_media.size();
1123 for (unsigned int i = 0; i < nMedia; ++i) {
1124 const std::string name = m_media[i] ? m_media[i]->GetName() : "none";
1125 std::cout << " " << i << " " << name << "\n";
1126 }
1127}

◆ SetMedium()

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

Set the medium in region i.

Definition at line 1129 of file ComponentNeBem3dMap.cc.

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

◆ SetMesh()

void Garfield::ComponentNeBem3dMap::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,nznumber of bins along x, y, z.
xmin,xmaxrange along $x$.
ymin,ymaxrange along $y$.
zmin,zmaxrange along $z$.

Definition at line 670 of file ComponentNeBem3dMap.cc.

674 {
675 Reset();
676 if (nx == 0 || ny == 0 || nz == 0) {
677 std::cerr << m_className << "::SetMesh:\n"
678 << " Number of mesh elements must be positive.\n";
679 return;
680 }
681 if (xmin >= xmax) {
682 std::cerr << m_className << "::SetMesh: Invalid x range.\n";
683 return;
684 } else if (ymin >= ymax) {
685 std::cerr << m_className << "::SetMesh: Invalid y range.\n";
686 return;
687 } else if (zmin >= zmax) {
688 std::cerr << m_className << "::SetMesh: Invalid z range.\n";
689 return;
690 }
691 m_nX = nx; // Note that these are the number of nodes
692 m_nY = ny; // Number of elements is one less than the number of nodes
693 m_nZ = nz;
694 m_xMin = xmin;
695 m_yMin = ymin;
696 m_zMin = zmin;
697 m_xMax = xmax;
698 m_yMax = ymax;
699 m_zMax = zmax;
700 m_hasMesh = true;
701}

◆ SetWeightingFieldOffset()

void Garfield::ComponentNeBem3dMap::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 363 of file ComponentNeBem3dMap.cc.

365 {
366 m_wField_xOffset = x;
367 m_wField_yOffset = y;
368 m_wField_zOffset = z;
369}

◆ WeightingField()

void Garfield::ComponentNeBem3dMap::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 336 of file ComponentNeBem3dMap.cc.

339 {
340 int status = 0;
341 Medium* med = nullptr;
342 double v = 0.;
343 const double x1 = x - m_wField_xOffset;
344 const double y1 = y - m_wField_yOffset;
345 const double z1 = z - m_wField_zOffset;
346 ElectricField(x1, y1, z1, wx, wy, wz, v, med, status);
347}

◆ WeightingPotential()

double Garfield::ComponentNeBem3dMap::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 349 of file ComponentNeBem3dMap.cc.

351 {
352 int status = 0;
353 Medium* med = nullptr;
354 double v = 0.;
355 const double x1 = x - m_wField_xOffset;
356 const double y1 = y - m_wField_yOffset;
357 const double z1 = z - m_wField_zOffset;
358 double wx = 0., wy = 0., wz = 0.;
359 ElectricField(x1, y1, z1, wx, wy, wz, v, med, status);
360 return v;
361}
The documentation for this class was generated from the following files: