Garfield++ 5.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::ComponentVoxel Class Reference

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

#include <ComponentVoxel.hh>

+ Inheritance diagram for Garfield::ComponentVoxel:

Public Member Functions

 ComponentVoxel ()
 Constructor.
 
 ~ComponentVoxel ()
 Destructor.
 
void EnableInterpolation (const bool on=true)
 Interpolate between field values at the element centres.
 
void SetMesh (const unsigned int nx, const unsigned int ny, const unsigned int nz, const double xmin, const double xmax, const double ymin, const double ymax, const double zmin, const double zmax)
 
bool LoadElectricField (const std::string &filename, const std::string &format, const bool withPotential, const bool withRegion, const double scaleX=1., const double scaleE=1., const double scaleP=1.)
 
bool LoadWeightingField (const std::string &filename, const std::string &format, const bool withPotential, const double scaleX=1., const double scaleE=1., const double scaleP=1.)
 Import (prompt) weighting field from file.
 
void SetWeightingFieldOffset (const double x, const double y, const double z)
 
bool LoadWeightingField (const std::string &filename, const std::string &format, const double time, const bool withPotential, const double scaleX=1., const double scaleE=1., const double scaleP=1.)
 Import delayed weighting field from file.
 
bool LoadMagneticField (const std::string &filename, const std::string &format, const double scaleX=1., const double scaleB=1.)
 Import magnetic field values from a file.
 
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.
 
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 Clear () override
 Reset.
 
void ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, double &v, Medium *&m, int &status) override
 Calculate the drift field [V/cm] and potential [V] at (x, y, z).
 
void ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, Medium *&m, int &status) override
 
void WeightingField (const double x, const double y, const double z, double &wx, double &wy, double &wz, const std::string &label) override
 
double WeightingPotential (const double x, const double y, const double z, const std::string &label) override
 
void DelayedWeightingField (const double x, const double y, const double z, const double t, double &wx, double &wy, double &wz, const std::string &label) override
 
double DelayedWeightingPotential (const double x, const double y, const double z, const double t, 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
 
bool HasMagneticField () const override
 Does the component have a non-zero magnetic field?
 
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 GetElementaryCell (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) override
 Get the coordinates of the elementary cell.
 
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.
 
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?
 
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 $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 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

Component for interpolating field maps stored in a regular mesh.

Definition at line 10 of file ComponentVoxel.hh.

Constructor & Destructor Documentation

◆ ComponentVoxel()

Garfield::ComponentVoxel::ComponentVoxel ( )

Constructor.

Definition at line 14 of file ComponentVoxel.cc.

14: Component("Voxel") {}
Garfield::Component::Component
Component()=delete
Default constructor.

◆ ~ComponentVoxel()

Garfield::ComponentVoxel::~ComponentVoxel ( )
inline

Destructor.

Definition at line 15 of file ComponentVoxel.hh.

15{}

Member Function Documentation

◆ Clear()

void Garfield::ComponentVoxel::Clear ( )
inlineoverridevirtual

Reset.

Reimplemented from Garfield::Component.

Definition at line 85 of file ComponentVoxel.hh.

85{ Reset(); }

◆ DelayedWeightingField()

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

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

Parameters
x,y,zcoordinates [cm].
ttime [ns].
wx,wy,wzcomponents of the weighting field [1/cm].
labelname of the electrode

Reimplemented from Garfield::Component.

Definition at line 82 of file ComponentVoxel.cc.

84 {
85
86 wx = wy = wz = 0.;
87 if (m_wdtimes.empty()) return;
88 // Assume no weighting field for times outside the range of available maps.
89 if (t < m_wdtimes.front() || t > m_wdtimes.back()) return;
90
91 const double xx = x - m_wField_xOffset;
92 const double yy = y - m_wField_yOffset;
93 const double zz = z - m_wField_zOffset;
94
95 const auto it1 = std::upper_bound(m_wdtimes.cbegin(), m_wdtimes.cend(), t);
96 const auto it0 = std::prev(it1);
97
98 const double dt = t - *it0;
99 double wp = 0.;
100 int region = 0;
101 const unsigned int i0 = it0 - m_wdtimes.cbegin();
102 double wx0 = 0., wy0 = 0., wz0 = 0.;
103 if (!GetField(xx, yy, zz, m_wdfields[i0], wx0, wy0, wz0, wp, region)) {
104 return;
105 }
106 if (dt < Small || it1 == m_wdtimes.cend()) {
107 wx = wx0;
108 wy = wy0;
109 wz = wz0;
110 return;
111 }
112 const unsigned int i1 = it1 - m_wdtimes.cbegin();
113 double wx1 = 0., wy1 = 0., wz1 = 0.;
114 if (!GetField(xx, yy, zz, m_wdfields[i1], wx1, wy1, wz1, wp, region)) {
115 return;
116 }
117 const double f1 = dt / (*it1 - *it0);
118 const double f0 = 1. - f1;
119 wx = f0 * wx0 + f1 * wx1;
120 wy = f0 * wy0 + f1 * wy1;
121 wz = f0 * wz0 + f1 * wz1;
122}

◆ DelayedWeightingPotential()

double Garfield::ComponentVoxel::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,zcoordinates [cm].
ttime [ns].
labelname of the electrode

Reimplemented from Garfield::Component.

Definition at line 124 of file ComponentVoxel.cc.

126 {
127
128 if (m_wdtimes.empty()) return 0.;
129 // Outside the range of the available maps?
130 if (t < m_wdtimes.front() || t > m_wdtimes.back()) return 0.;
131
132 const double xx = x - m_wField_xOffset;
133 const double yy = y - m_wField_yOffset;
134 const double zz = z - m_wField_zOffset;
135
136 const auto it1 = std::upper_bound(m_wdtimes.cbegin(), m_wdtimes.cend(), t);
137 const auto it0 = std::prev(it1);
138
139 const double dt = t - *it0;
140 int region = 0;
141 const unsigned int i0 = it0 - m_wdtimes.cbegin();
142 double wp0 = 0., wx0 = 0., wy0 = 0., wz0 = 0.;
143 if (!GetField(xx, yy, zz, m_wdfields[i0], wx0, wy0, wz0, wp0, region)) {
144 return 0.;
145 }
146 if (dt < Small || it1 == m_wdtimes.cend()) return 0.;
147
148 const unsigned int i1 = it1 - m_wdtimes.cbegin();
149 double wp1 = 0., wx1 = 0., wy1 = 0., wz1 = 0.;
150 if (!GetField(xx, yy, zz, m_wdfields[i1], wx1, wy1, wz1, wp1, region)) {
151 return 0.;
152 }
153 const double f1 = dt / (*it1 - *it0);
154 const double f0 = 1. - f1;
155 return f0 * wp0 + f1 * wp1;
156}

◆ 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.

43 {
44 double ex = 0., ey = 0., ez = 0.;
45 Medium* medium = nullptr;
46 int status = 0;
47 ElectricField(x, y, z, ex, ey, ez, medium, status);
48 std::array<double, 3> efield = {ex, ey, ez};
49 return efield;
50}
Garfield::ComponentVoxel::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 ComponentVoxel.cc:16

◆ ElectricField() [2/3]

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

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

Implements Garfield::Component.

Definition at line 16 of file ComponentVoxel.cc.

18 {
19 m = nullptr;
20 status = 0;
21
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 status = 0;
31 int region = -1;
32 if (!GetField(x, y, z, m_efields, ex, ey, ez, p, region)) {
33 status = -6;
34 return;
35 }
36
37 if (region < 0 || region > (int)m_media.size()) {
38 m = nullptr;
39 status = -5;
40 return;
41 }
42 m = m_media[region];
43 if (!m) status = -5;
44}
Garfield::Component::m_className
std::string m_className
Class name.
Definition Component.hh:359
Garfield::Component::m_ready
bool m_ready
Ready for use?
Definition Component.hh:368

Referenced by ElectricField().

◆ ElectricField() [3/3]

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

Calculate the drift field at given point.

Parameters
x,y,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 46 of file ComponentVoxel.cc.

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

◆ EnableInterpolation()

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

Interpolate between field values at the element centres.

Definition at line 18 of file ComponentVoxel.hh.

18{ m_interpolate = on; }

◆ GetBoundingBox()

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

Get the bounding box coordinates.

Reimplemented from Garfield::Component.

Definition at line 599 of file ComponentVoxel.cc.

600 {
601 if (!m_ready) return false;
602 if (m_periodic[0] || m_mirrorPeriodic[0]) {
603 xmin = -INFINITY;
604 xmax = +INFINITY;
605 } else {
606 xmin = m_xMin;
607 xmax = m_xMax;
608 }
609
610 if (m_periodic[1] || m_mirrorPeriodic[1]) {
611 ymin = -INFINITY;
612 ymax = +INFINITY;
613 } else {
614 ymin = m_yMin;
615 ymax = m_yMax;
616 }
617
618 if (m_periodic[2] || m_mirrorPeriodic[2]) {
619 zmin = -INFINITY;
620 zmax = +INFINITY;
621 } else {
622 zmin = m_zMin;
623 zmax = m_zMax;
624 }
625 return true;
626}
Garfield::Component::m_mirrorPeriodic
std::array< bool, 3 > m_mirrorPeriodic
Mirror periodicity in x, y, z.
Definition Component.hh:376
Garfield::Component::m_periodic
std::array< bool, 3 > m_periodic
Simple periodicity in x, y, z.
Definition Component.hh:374

◆ GetElectricFieldRange()

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

Definition at line 648 of file ComponentVoxel.cc.

650 {
651 if (!m_ready) {
652 std::cerr << m_className << "::GetElectricFieldRange:\n"
653 << " Field map is not ready for interpolation.\n";
654 return false;
655 }
656
657 exmin = exmax = m_efields[0][0][0].fx;
658 eymin = eymax = m_efields[0][0][0].fy;
659 ezmin = ezmax = m_efields[0][0][0].fz;
660 for (unsigned int i = 0; i < m_nX; ++i) {
661 for (unsigned int j = 0; j < m_nY; ++j) {
662 for (unsigned int k = 0; k < m_nZ; ++k) {
663 const Element& element = m_efields[i][j][k];
664 if (element.fx < exmin) exmin = element.fx;
665 if (element.fx > exmax) exmax = element.fx;
666 if (element.fy < eymin) eymin = element.fy;
667 if (element.fy > eymax) eymax = element.fy;
668 if (element.fz < ezmin) ezmin = element.fz;
669 if (element.fz > ezmax) ezmax = element.fz;
670 }
671 }
672 }
673 return true;
674}

◆ GetElement() [1/2]

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

Return the indices of the element at a given point.

Definition at line 853 of file ComponentVoxel.cc.

857 {
858 if (!m_hasMesh) {
859 std::cerr << m_className << "::GetElement: Mesh is not set.\n";
860 return false;
861 }
862
863 // Reduce the point to the basic cell (in case of periodicity) and
864 // check if it is inside the mesh.
865 const double x =
866 Reduce(xi, m_xMin, m_xMax, m_periodic[0], m_mirrorPeriodic[0], xMirrored);
867 if (x < m_xMin || x > m_xMax) return false;
868 const double y =
869 Reduce(yi, m_yMin, m_yMax, m_periodic[1], m_mirrorPeriodic[1], yMirrored);
870 if (y < m_yMin || y > m_yMax) return false;
871 const double z =
872 Reduce(zi, m_zMin, m_zMax, m_periodic[2], m_mirrorPeriodic[2], zMirrored);
873 if (z < m_zMin || z > m_zMax) return false;
874
875 // Get the indices.
876 i = (unsigned int)((x - m_xMin) / m_dx);
877 j = (unsigned int)((y - m_yMin) / m_dy);
878 k = (unsigned int)((z - m_zMin) / m_dz);
879 if (i >= m_nX) i = m_nX - 1;
880 if (j >= m_nY) j = m_nY - 1;
881 if (k >= m_nZ) k = m_nZ - 1;
882 return true;
883}

Referenced by GetMedium().

◆ GetElement() [2/2]

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

Return the field for an element with given index.

Definition at line 885 of file ComponentVoxel.cc.

887 {
888 v = ex = ey = ez = 0.;
889 if (!m_ready) {
890 if (!m_hasMesh) {
891 std::cerr << m_className << "::GetElement: Mesh not set.\n";
892 return false;
893 }
894 std::cerr << m_className << "::GetElement: Field map not set.\n";
895 return false;
896 }
897 if (i >= m_nX || j >= m_nY || k >= m_nZ) {
898 std::cerr << m_className << "::GetElement: Index out of range.\n";
899 return false;
900 }
901 const Element& element = m_efields[i][j][k];
902 v = element.v;
903 ex = element.fx;
904 ey = element.fy;
905 ez = element.fz;
906 return true;
907}

◆ GetElementaryCell()

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

Get the coordinates of the elementary cell.

Reimplemented from Garfield::Component.

Definition at line 628 of file ComponentVoxel.cc.

630 {
631 if (!m_ready) return false;
632 xmin = m_xMin;
633 xmax = m_xMax;
634 ymin = m_yMin;
635 ymax = m_yMax;
636 zmin = m_zMin;
637 zmax = m_zMax;
638 return true;
639}

◆ GetMedium() [1/2]

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

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

Reimplemented from Garfield::Component.

Definition at line 184 of file ComponentVoxel.cc.

185 {
186 // Make sure the field map has been loaded.
187 if (!m_ready) {
188 std::cerr << m_className << "::GetMedium:\n"
189 << " Field map is not available for interpolation.\n";
190 return nullptr;
191 }
192
193 unsigned int i, j, k;
194 bool xMirrored, yMirrored, zMirrored;
195 if (!GetElement(x, y, z, i, j, k, xMirrored, yMirrored, zMirrored)) {
196 return nullptr;
197 }
198 const int region = m_regions[i][j][k];
199 if (region < 0 || region > (int)m_media.size()) return nullptr;
200 return m_media[region];
201}
Garfield::ComponentVoxel::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 ComponentVoxel.cc:853

◆ GetMedium() [2/2]

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

Get the medium in region i.

Definition at line 707 of file ComponentVoxel.cc.

707 {
708 if (i >= m_media.size()) {
709 std::cerr << m_className << "::GetMedium: Index out of range.\n";
710 return nullptr;
711 }
712 return m_media[i];
713}

◆ GetVoltageRange()

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

Calculate the voltage range [V].

Implements Garfield::Component.

Definition at line 641 of file ComponentVoxel.cc.

641 {
642 if (!m_ready) return false;
643 vmin = m_pMin;
644 vmax = m_pMax;
645 return true;
646}

◆ HasMagneticField()

bool Garfield::ComponentVoxel::HasMagneticField ( ) const
overridevirtual

Does the component have a non-zero magnetic field?

Reimplemented from Garfield::Component.

Definition at line 180 of file ComponentVoxel.cc.

180 {
181 return m_hasBfield ? true : Component::HasMagneticField();
182}
Garfield::Component::HasMagneticField
virtual bool HasMagneticField() const
Does the component have a non-zero magnetic field?
Definition Component.cc:155

◆ LoadElectricField()

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

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

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

followed by

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

Format types are:

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

Definition at line 239 of file ComponentVoxel.cc.

243 {
244 m_ready = false;
245 m_efields.clear();
246 m_hasPotential = m_hasEfield = false;
247 if (!m_hasMesh) {
248 std::cerr << m_className << "::LoadElectricField:\n"
249 << " Mesh is not set. Call SetMesh first.\n";
250 return false;
251 }
252
253 // Set up the grid.
254 Initialise(m_efields);
255 InitialiseRegions();
256
257 m_pMin = m_pMax = 0.;
258 if (withP) {
259 m_pMin = 1.;
260 m_pMax = -1.;
261 }
262 if (!LoadData(fname, fmt, withP, withR, scaleX, scaleE, scaleP, m_efields)) {
263 return false;
264 }
265 m_hasEfield = true;
266 m_ready = true;
267 if (withP) m_hasPotential = true;
268 return true;
269}

◆ LoadMagneticField()

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

Import magnetic field values from a file.

Definition at line 327 of file ComponentVoxel.cc.

330 {
331 m_hasBfield = false;
332 if (!m_hasMesh) {
333 std::cerr << m_className << "::LoadMagneticField:\n"
334 << " Mesh is not set. Call SetMesh first.\n";
335 return false;
336 }
337
338 // Set up the grid.
339 Initialise(m_bfields);
340 InitialiseRegions();
341
342 // Read the file.
343 if (!LoadData(fname, fmt, false, false, scaleX, scaleB, 1., m_bfields)) {
344 return false;
345 }
346 m_hasBfield = true;
347 return true;
348}

◆ LoadWeightingField() [1/2]

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

Import (prompt) weighting field from file.

Definition at line 271 of file ComponentVoxel.cc.

276 {
277 m_hasWfield = false;
278 if (!m_hasMesh) {
279 std::cerr << m_className << "::LoadWeightingField:\n"
280 << " Mesh is not set. Call SetMesh first.\n";
281 return false;
282 }
283
284 // Set up the grid.
285 Initialise(m_wfields);
286 if (m_regions.empty()) InitialiseRegions();
287
288 // Read the file.
289 if (!LoadData(fname, fmt, withP, false, scaleX, scaleE, scaleP, m_wfields)) {
290 return false;
291 }
292 m_hasWfield = true;
293 return true;
294}

◆ LoadWeightingField() [2/2]

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

Import delayed weighting field from file.

Definition at line 295 of file ComponentVoxel.cc.

299 {
300
301 if (!m_hasMesh) {
302 std::cerr << m_className << "::LoadWeightingField:\n"
303 << " Mesh is not set. Call SetMesh first.\n";
304 return false;
305 }
306
307 std::vector<std::vector<std::vector<Element> > > wfield;
308 Initialise(wfield);
309 if (m_regions.empty()) InitialiseRegions();
310
311 // Read the file.
312 if (!LoadData(fname, fmt, withP, false, scaleX, scaleE, scaleP, wfield)) {
313 return false;
314 }
315 if (m_wdtimes.empty() || t > m_wdtimes.back()) {
316 m_wdtimes.push_back(t);
317 m_wdfields.push_back(std::move(wfield));
318 } else {
319 const auto it = std::upper_bound(m_wdtimes.begin(), m_wdtimes.end(), t);
320 const auto n = std::distance(m_wdtimes.begin(), it);
321 m_wdtimes.insert(it, t);
322 m_wdfields.insert(m_wdfields.begin() + n, std::move(wfield));
323 }
324 return true;
325}

◆ MagneticField()

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

Calculate the magnetic field at a given point.

Parameters
x,y,zcoordinates [cm].
bx,by,bzcomponents of the magnetic field [Tesla].
statusstatus flag.

Reimplemented from Garfield::Component.

Definition at line 165 of file ComponentVoxel.cc.

167 {
168 status = 0;
169 if (!m_hasBfield) {
170 return Component::MagneticField(x, y, z, bx, by, bz, status);
171 }
172
173 int region = -1;
174 double p = 0.;
175 if (!GetField(x, y, z, m_bfields, bx, by, bz, p, region)) {
176 status = -6;
177 }
178}
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:102

◆ PrintRegions()

void Garfield::ComponentVoxel::PrintRegions ( ) const

Print all regions.

Definition at line 676 of file ComponentVoxel.cc.

676 {
677 // Do not proceed if not properly initialised.
678 if (!m_ready) {
679 std::cerr << m_className << "::PrintRegions:\n"
680 << " Field map not yet initialised.\n";
681 return;
682 }
683
684 if (m_media.empty()) {
685 std::cerr << m_className << "::PrintRegions: No regions defined.\n";
686 return;
687 }
688
689 std::cout << m_className << "::PrintRegions:\n";
690 std::cout << " Index Medium\n";
691 const unsigned int nMedia = m_media.size();
692 for (unsigned int i = 0; i < nMedia; ++i) {
693 const std::string name = m_media[i] ? m_media[i]->GetName() : "none";
694 std::cout << " " << i << " " << name << "\n";
695 }
696}

◆ SetMedium()

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

Set the medium in region i.

Definition at line 698 of file ComponentVoxel.cc.

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

◆ SetMesh()

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

Define the grid.

Parameters
nx,ny,nznumber of bins along x, y, z.
xmin,xmaxrange along $x$.
ymin,ymaxrange along $y$.
zmin,zmaxrange along $z$.

Definition at line 203 of file ComponentVoxel.cc.

207 {
208 Reset();
209 if (nx == 0 || ny == 0 || nz == 0) {
210 std::cerr << m_className << "::SetMesh:\n"
211 << " Number of mesh elements must be positive.\n";
212 return;
213 }
214 if (xmin >= xmax) {
215 std::cerr << m_className << "::SetMesh: Invalid x range.\n";
216 return;
217 } else if (ymin >= ymax) {
218 std::cerr << m_className << "::SetMesh: Invalid y range.\n";
219 return;
220 } else if (zmin >= zmax) {
221 std::cerr << m_className << "::SetMesh: Invalid z range.\n";
222 return;
223 }
224 m_nX = nx;
225 m_nY = ny;
226 m_nZ = nz;
227 m_xMin = xmin;
228 m_yMin = ymin;
229 m_zMin = zmin;
230 m_xMax = xmax;
231 m_yMax = ymax;
232 m_zMax = zmax;
233 m_dx = (m_xMax - m_xMin) / m_nX;
234 m_dy = (m_yMax - m_yMin) / m_nY;
235 m_dz = (m_zMax - m_zMin) / m_nZ;
236 m_hasMesh = true;
237}

◆ SetWeightingFieldOffset()

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

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

Definition at line 158 of file ComponentVoxel.cc.

159 {
160 m_wField_xOffset = x;
161 m_wField_yOffset = y;
162 m_wField_zOffset = z;
163}

◆ WeightingField()

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

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

Parameters
x,y,zcoordinates [cm].
wx,wy,wzcomponents of the weighting field [1/cm].
labelname of the electrode

Reimplemented from Garfield::Component.

Definition at line 53 of file ComponentVoxel.cc.

55 {
56
57 wx = wy = wz = 0.;
58 if (!m_hasWfield) return;
59 const double xx = x - m_wField_xOffset;
60 const double yy = y - m_wField_yOffset;
61 const double zz = z - m_wField_zOffset;
62 double wp = 0.;
63 int region = 0;
64 GetField(xx, yy, zz, m_wfields, wx, wy, wz, wp, region);
65}

◆ WeightingPotential()

double Garfield::ComponentVoxel::WeightingPotential ( const double x,
const double y,
const double z,
const std::string & label )
overridevirtual

Calculate the weighting potential at a given point.

Parameters
x,y,zcoordinates [cm].
labelname of the electrode.
Returns
weighting potential [dimensionless].

Reimplemented from Garfield::Component.

Definition at line 67 of file ComponentVoxel.cc.

69 {
70
71 if (!m_hasWfield) return 0.;
72 const double xx = x - m_wField_xOffset;
73 const double yy = y - m_wField_yOffset;
74 const double zz = z - m_wField_zOffset;
75 double wx = 0., wy = 0., wz = 0.;
76 double wp = 0.;
77 int region = 0;
78 if (!GetField(xx, yy, zz, m_wfields, wx, wy, wz, wp, region)) return 0.;
79 return wp;
80}
The documentation for this class was generated from the following files: