Garfield++ v1r0
A toolkit for the detailed simulation of particle detectors based on ionisation measurement in gases and semiconductors
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Garfield::ComponentBase Class Referenceabstract

#include <ComponentBase.hh>

+ Inheritance diagram for Garfield::ComponentBase:

Public Member Functions

 ComponentBase ()
 
virtual ~ComponentBase ()
 
virtual void SetGeometry (GeometryBase *geo)
 
virtual void Clear ()
 
virtual Medium * GetMedium (const double &x, const double &y, const double &z)
 
virtual void ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, Medium *&m, int &status)=0
 
virtual void ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, double &v, Medium *&m, int &status)=0
 
virtual bool GetVoltageRange (double &vmin, double &vmax)=0
 
virtual void WeightingField (const double x, const double y, const double z, double &wx, double &wy, double &wz, const std::string label)
 
virtual double WeightingPotential (const double x, const double y, const double z, const std::string label)
 
virtual void MagneticField (const double x, const double y, const double z, double &bx, double &by, double &bz, int &status)
 
void SetMagneticField (const double bx, const double by, const double bz)
 
virtual bool IsReady ()
 
virtual bool GetBoundingBox (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax)
 
virtual bool IsWireCrossed (const double x0, const double y0, const double z0, const double x1, const double y1, const double z1, double &xc, double &yc, double &zc)
 
virtual bool IsInTrapRadius (double x0, double y0, double z0, double &xw, double &yw, double &rw)
 
void EnablePeriodicityX ()
 
void DisablePeriodicityX ()
 
void EnablePeriodicityY ()
 
void DisablePeriodicityY ()
 
void EnablePeriodicityZ ()
 
void DisablePeriodicityZ ()
 
void EnableMirrorPeriodicityX ()
 
void DisableMirrorPeriodicityX ()
 
void EnableMirrorPeriodicityY ()
 
void DisableMirrorPeriodicityY ()
 
void EnableMirrorPeriodicityZ ()
 
void DisableMirrorPeriodicityZ ()
 
void EnableAxialPeriodicityX ()
 
void DisableAxialPeriodicityX ()
 
void EnableAxialPeriodicityY ()
 
void DisableAxialPeriodicityY ()
 
void EnableAxialPeriodicityZ ()
 
void DisableAxialPeriodicityZ ()
 
void EnableRotationSymmetryX ()
 
void DisableRotationSymmetryX ()
 
void EnableRotationSymmetryY ()
 
void DisableRotationSymmetryY ()
 
void EnableRotationSymmetryZ ()
 
void DisableRotationSymmetryZ ()
 
void EnableDebugging ()
 
void DisableDebugging ()
 

Protected Member Functions

virtual void Reset ()=0
 
virtual void UpdatePeriodicity ()=0
 

Protected Attributes

std::string m_className
 
GeometryBase * theGeometry
 
bool ready
 
bool xPeriodic
 
bool yPeriodic
 
bool zPeriodic
 
bool xMirrorPeriodic
 
bool yMirrorPeriodic
 
bool zMirrorPeriodic
 
bool xAxiallyPeriodic
 
bool yAxiallyPeriodic
 
bool zAxiallyPeriodic
 
bool xRotationSymmetry
 
bool yRotationSymmetry
 
bool zRotationSymmetry
 
double bx0
 
double by0
 
double bz0
 
bool debug
 

Detailed Description

Definition at line 13 of file ComponentBase.hh.

Constructor & Destructor Documentation

◆ ComponentBase()

Garfield::ComponentBase::ComponentBase ( )

Definition at line 6 of file ComponentBase.cc.

7 : m_className("ComponentBase"),
8 theGeometry(0),
9 ready(false),
10 xPeriodic(false),
11 yPeriodic(false),
12 zPeriodic(false),
13 xMirrorPeriodic(false),
14 yMirrorPeriodic(false),
15 zMirrorPeriodic(false),
16 xAxiallyPeriodic(false),
17 yAxiallyPeriodic(false),
18 zAxiallyPeriodic(false),
19 xRotationSymmetry(false),
20 yRotationSymmetry(false),
21 zRotationSymmetry(false),
22 bx0(0.),
23 by0(0.),
24 bz0(0.),
25 debug(false) {}
Garfield::ComponentBase::theGeometry
GeometryBase * theGeometry
Definition: ComponentBase.hh:187

◆ ~ComponentBase()

virtual Garfield::ComponentBase::~ComponentBase ( )
inlinevirtual

Definition at line 19 of file ComponentBase.hh.

19{}

Member Function Documentation

◆ Clear()

void Garfield::ComponentBase::Clear ( )
virtual

Definition at line 46 of file ComponentBase.cc.

46 {
47
48 theGeometry = 0;
49 Reset();
50}
Garfield::ComponentBase::Reset
virtual void Reset()=0

◆ DisableAxialPeriodicityX()

void Garfield::ComponentBase::DisableAxialPeriodicityX ( )
inline

Definition at line 134 of file ComponentBase.hh.

134 {
135 xAxiallyPeriodic = false;
136 UpdatePeriodicity();
137 }
Garfield::ComponentBase::UpdatePeriodicity
virtual void UpdatePeriodicity()=0

◆ DisableAxialPeriodicityY()

void Garfield::ComponentBase::DisableAxialPeriodicityY ( )
inline

Definition at line 142 of file ComponentBase.hh.

142 {
143 yAxiallyPeriodic = false;
144 UpdatePeriodicity();
145 }

◆ DisableAxialPeriodicityZ()

void Garfield::ComponentBase::DisableAxialPeriodicityZ ( )
inline

Definition at line 150 of file ComponentBase.hh.

150 {
151 zAxiallyPeriodic = false;
152 UpdatePeriodicity();
153 }

◆ DisableDebugging()

void Garfield::ComponentBase::DisableDebugging ( )
inline

Definition at line 182 of file ComponentBase.hh.

182{ debug = false; }

◆ DisableMirrorPeriodicityX()

void Garfield::ComponentBase::DisableMirrorPeriodicityX ( )
inline

Definition at line 109 of file ComponentBase.hh.

109 {
110 xMirrorPeriodic = false;
111 UpdatePeriodicity();
112 }

◆ DisableMirrorPeriodicityY()

void Garfield::ComponentBase::DisableMirrorPeriodicityY ( )
inline

Definition at line 117 of file ComponentBase.hh.

117 {
118 yMirrorPeriodic = false;
119 UpdatePeriodicity();
120 }

◆ DisableMirrorPeriodicityZ()

void Garfield::ComponentBase::DisableMirrorPeriodicityZ ( )
inline

Definition at line 125 of file ComponentBase.hh.

125 {
126 zMirrorPeriodic = false;
127 UpdatePeriodicity();
128 }

◆ DisablePeriodicityX()

void Garfield::ComponentBase::DisablePeriodicityX ( )
inline

Definition at line 84 of file ComponentBase.hh.

84 {
85 xPeriodic = false;
86 UpdatePeriodicity();
87 }

◆ DisablePeriodicityY()

void Garfield::ComponentBase::DisablePeriodicityY ( )
inline

Definition at line 92 of file ComponentBase.hh.

92 {
93 yPeriodic = false;
94 UpdatePeriodicity();
95 }

◆ DisablePeriodicityZ()

void Garfield::ComponentBase::DisablePeriodicityZ ( )
inline

Definition at line 100 of file ComponentBase.hh.

100 {
101 zPeriodic = false;
102 UpdatePeriodicity();
103 }

◆ DisableRotationSymmetryX()

void Garfield::ComponentBase::DisableRotationSymmetryX ( )
inline

Definition at line 159 of file ComponentBase.hh.

159 {
160 xRotationSymmetry = false;
161 UpdatePeriodicity();
162 }

◆ DisableRotationSymmetryY()

void Garfield::ComponentBase::DisableRotationSymmetryY ( )
inline

Definition at line 167 of file ComponentBase.hh.

167 {
168 yRotationSymmetry = false;
169 UpdatePeriodicity();
170 }

◆ DisableRotationSymmetryZ()

void Garfield::ComponentBase::DisableRotationSymmetryZ ( )
inline

Definition at line 175 of file ComponentBase.hh.

175 {
176 zRotationSymmetry = false;
177 UpdatePeriodicity();
178 }

◆ ElectricField() [1/2]

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

Implemented in Garfield::ComponentAnalyticField, Garfield::ComponentAnsys121, Garfield::ComponentAnsys123, Garfield::ComponentConstant, Garfield::ComponentCST, Garfield::ComponentElmer, Garfield::ComponentNeBem2d, Garfield::ComponentTcad2d, Garfield::ComponentTcad3d, Garfield::ComponentUser, Garfield::ComponentUserMapBase, Garfield::ComponentVoxel, and Garfield::ComponentFieldMap.

◆ ElectricField() [2/2]

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

Implemented in Garfield::ComponentAnalyticField, Garfield::ComponentAnsys121, Garfield::ComponentAnsys123, Garfield::ComponentConstant, Garfield::ComponentCST, Garfield::ComponentElmer, Garfield::ComponentNeBem2d, Garfield::ComponentTcad2d, Garfield::ComponentTcad3d, Garfield::ComponentUser, Garfield::ComponentUserMapBase, Garfield::ComponentVoxel, and Garfield::ComponentFieldMap.

Referenced by Garfield::ComponentUserMapBase::ElectricField(), Garfield::ViewField::EvaluatePotential(), and Garfield::ViewField::EvaluatePotentialProfile().

◆ EnableAxialPeriodicityX()

void Garfield::ComponentBase::EnableAxialPeriodicityX ( )
inline

Definition at line 130 of file ComponentBase.hh.

130 {
131 xAxiallyPeriodic = true;
132 UpdatePeriodicity();
133 }

◆ EnableAxialPeriodicityY()

void Garfield::ComponentBase::EnableAxialPeriodicityY ( )
inline

Definition at line 138 of file ComponentBase.hh.

138 {
139 yAxiallyPeriodic = true;
140 UpdatePeriodicity();
141 }

◆ EnableAxialPeriodicityZ()

void Garfield::ComponentBase::EnableAxialPeriodicityZ ( )
inline

Definition at line 146 of file ComponentBase.hh.

146 {
147 zAxiallyPeriodic = true;
148 UpdatePeriodicity();
149 }

◆ EnableDebugging()

void Garfield::ComponentBase::EnableDebugging ( )
inline

Definition at line 181 of file ComponentBase.hh.

181{ debug = true; }

◆ EnableMirrorPeriodicityX()

void Garfield::ComponentBase::EnableMirrorPeriodicityX ( )
inline

Definition at line 105 of file ComponentBase.hh.

105 {
106 xMirrorPeriodic = true;
107 UpdatePeriodicity();
108 }

◆ EnableMirrorPeriodicityY()

void Garfield::ComponentBase::EnableMirrorPeriodicityY ( )
inline

Definition at line 113 of file ComponentBase.hh.

113 {
114 yMirrorPeriodic = true;
115 UpdatePeriodicity();
116 }

◆ EnableMirrorPeriodicityZ()

void Garfield::ComponentBase::EnableMirrorPeriodicityZ ( )
inline

Definition at line 121 of file ComponentBase.hh.

121 {
122 zMirrorPeriodic = true;
123 UpdatePeriodicity();
124 }

◆ EnablePeriodicityX()

void Garfield::ComponentBase::EnablePeriodicityX ( )
inline

Definition at line 80 of file ComponentBase.hh.

80 {
81 xPeriodic = true;
82 UpdatePeriodicity();
83 }

◆ EnablePeriodicityY()

void Garfield::ComponentBase::EnablePeriodicityY ( )
inline

Definition at line 88 of file ComponentBase.hh.

88 {
89 yPeriodic = true;
90 UpdatePeriodicity();
91 }

◆ EnablePeriodicityZ()

void Garfield::ComponentBase::EnablePeriodicityZ ( )
inline

Definition at line 96 of file ComponentBase.hh.

96 {
97 zPeriodic = true;
98 UpdatePeriodicity();
99 }

◆ EnableRotationSymmetryX()

void Garfield::ComponentBase::EnableRotationSymmetryX ( )
inline

Definition at line 155 of file ComponentBase.hh.

155 {
156 xRotationSymmetry = true;
157 UpdatePeriodicity();
158 }

◆ EnableRotationSymmetryY()

void Garfield::ComponentBase::EnableRotationSymmetryY ( )
inline

Definition at line 163 of file ComponentBase.hh.

163 {
164 yRotationSymmetry = true;
165 UpdatePeriodicity();
166 }

◆ EnableRotationSymmetryZ()

void Garfield::ComponentBase::EnableRotationSymmetryZ ( )
inline

Definition at line 171 of file ComponentBase.hh.

171 {
172 zRotationSymmetry = true;
173 UpdatePeriodicity();
174 }

◆ GetBoundingBox()

bool Garfield::ComponentBase::GetBoundingBox ( double &  xmin,
double &  ymin,
double &  zmin,
double &  xmax,
double &  ymax,
double &  zmax 
)
virtual

Reimplemented in Garfield::ComponentAnalyticField, Garfield::ComponentFieldMap, Garfield::ComponentTcad2d, Garfield::ComponentTcad3d, and Garfield::ComponentVoxel.

Definition at line 99 of file ComponentBase.cc.

100 {
101
102 if (theGeometry == 0) return false;
103 return (theGeometry->GetBoundingBox(xmin, ymin, zmin, xmax, ymax, zmax));
104}
Garfield::GeometryBase::GetBoundingBox
virtual bool GetBoundingBox(double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax)=0

Referenced by Garfield::ComponentConstant::GetVoltageRange(), and Garfield::ViewField::SetComponent().

◆ GetMedium()

Medium * Garfield::ComponentBase::GetMedium ( const double &  x,
const double &  y,
const double &  z 
)
virtual

Reimplemented in Garfield::ComponentAnsys121, Garfield::ComponentAnsys123, Garfield::ComponentCST, Garfield::ComponentElmer, Garfield::ComponentTcad2d, Garfield::ComponentTcad3d, Garfield::ComponentUserMapBase, Garfield::ComponentVoxel, and Garfield::ComponentFieldMap.

Definition at line 39 of file ComponentBase.cc.

40 {
41
42 if (theGeometry == NULL) return NULL;
43 return theGeometry->GetMedium(x, y, z);
44}
Garfield::GeometryBase::GetMedium
virtual Medium * GetMedium(const double x, const double y, const double z) const =0

Referenced by Garfield::ComponentNeBem2d::ElectricField(), Garfield::ComponentAnalyticField::ElectricField(), Garfield::ComponentConstant::ElectricField(), Garfield::ComponentUser::ElectricField(), Garfield::ComponentUserMapBase::GetMedium(), Garfield::ComponentConstant::WeightingField(), and Garfield::ComponentConstant::WeightingPotential().

◆ GetVoltageRange()

virtual bool Garfield::ComponentBase::GetVoltageRange ( double &  vmin,
double &  vmax 
)
pure virtual

Implemented in Garfield::ComponentAnalyticField, Garfield::ComponentConstant, Garfield::ComponentFieldMap, Garfield::ComponentNeBem2d, Garfield::ComponentTcad2d, Garfield::ComponentTcad3d, Garfield::ComponentUser, Garfield::ComponentUserMapBase, and Garfield::ComponentVoxel.

Referenced by Garfield::ViewField::SetComponent().

◆ IsInTrapRadius()

bool Garfield::ComponentBase::IsInTrapRadius ( double  x0,
double  y0,
double  z0,
double &  xw,
double &  yw,
double &  rw 
)
virtual

Reimplemented in Garfield::ComponentAnalyticField.

Definition at line 119 of file ComponentBase.cc.

120 {
121
122 xw = x0;
123 yw = y0;
124 rw = 0.;
125 return false;
126
127 if (debug) {
128 std::cout << m_className << "::IsInTrapRadius:\n";
129 std::cout << " (" << x0 << ", " << y0 << ", " << z0 << ") \n";
130 std::cout << " not trapped by a wire.\n";
131 }
132}

◆ IsReady()

virtual bool Garfield::ComponentBase::IsReady ( )
inlinevirtual

Definition at line 67 of file ComponentBase.hh.

67{ return ready; }

◆ IsWireCrossed()

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

Reimplemented in Garfield::ComponentAnalyticField.

Definition at line 106 of file ComponentBase.cc.

110 {
111
112 xc = x0;
113 yc = y0;
114 zc = z0;
115 return false;
116
117}

◆ MagneticField()

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

Definition at line 77 of file ComponentBase.cc.

79 {
80 bx = bx0;
81 by = by0;
82 bz = bz0;
83 if (debug) {
84 std::cout << m_className << "::MagneticField:\n";
85 std::cout << " Magnetic field at (" << x << ", " << y << ", " << z
86 << ") is (" << bx << ", " << by << ", " << bz << ")\n";
87 }
88 status = 0;
89}

◆ Reset()

virtual void Garfield::ComponentBase::Reset ( )
protectedpure virtual

Implemented in Garfield::ComponentFieldMap, and Garfield::ComponentUserMapBase.

Referenced by Clear().

◆ SetGeometry()

void Garfield::ComponentBase::SetGeometry ( GeometryBase *  geo)
virtual

Definition at line 27 of file ComponentBase.cc.

27 {
28
29 // Make sure the geometry is defined
30 if (geo == 0) {
31 std::cerr << "ComponentBase::SetGeometry:\n";
32 std::cerr << " Geometry pointer is null.\n";
33 return;
34 }
35
36 theGeometry = geo;
37}

Referenced by GarfieldPhysics::CreateGeometry().

◆ SetMagneticField()

void Garfield::ComponentBase::SetMagneticField ( const double  bx,
const double  by,
const double  bz 
)

Definition at line 91 of file ComponentBase.cc.

92 {
93
94 bx0 = bx;
95 by0 = by;
96 bz0 = bz;
97}

◆ UpdatePeriodicity()

virtual void Garfield::ComponentBase::UpdatePeriodicity ( )
protectedpure virtual

Implemented in Garfield::ComponentAnsys121, Garfield::ComponentAnsys123, Garfield::ComponentCST, Garfield::ComponentElmer, Garfield::ComponentUserMapBase, and Garfield::ComponentFieldMap.

Referenced by DisableAxialPeriodicityX(), DisableAxialPeriodicityY(), DisableAxialPeriodicityZ(), DisableMirrorPeriodicityX(), DisableMirrorPeriodicityY(), DisableMirrorPeriodicityZ(), DisablePeriodicityX(), DisablePeriodicityY(), DisablePeriodicityZ(), DisableRotationSymmetryX(), DisableRotationSymmetryY(), DisableRotationSymmetryZ(), EnableAxialPeriodicityX(), EnableAxialPeriodicityY(), EnableAxialPeriodicityZ(), EnableMirrorPeriodicityX(), EnableMirrorPeriodicityY(), EnableMirrorPeriodicityZ(), EnablePeriodicityX(), EnablePeriodicityY(), EnablePeriodicityZ(), EnableRotationSymmetryX(), EnableRotationSymmetryY(), and EnableRotationSymmetryZ().

◆ WeightingField()

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

Reimplemented in Garfield::ComponentAnalyticField, Garfield::ComponentAnsys121, Garfield::ComponentAnsys123, Garfield::ComponentConstant, Garfield::ComponentCST, Garfield::ComponentElmer, Garfield::ComponentUser, Garfield::ComponentUserMapBase, and Garfield::ComponentFieldMap.

Definition at line 52 of file ComponentBase.cc.

54 {
55 if (debug) {
56 std::cerr << m_className << "::WeightingField:\n";
57 std::cerr << " This function is not implemented.\n";
58 std::cerr << " Weighting field at (" << x << ", " << y << ", " << z
59 << ") for electrode " << label << " cannot be calculated.\n";
60 }
61 wx = wy = wz = 0.;
62}

Referenced by Garfield::ViewField::EvaluateWeightingField(), and Garfield::ComponentUserMapBase::WeightingField().

◆ WeightingPotential()

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

Reimplemented in Garfield::ComponentAnalyticField, Garfield::ComponentAnsys121, Garfield::ComponentAnsys123, Garfield::ComponentConstant, Garfield::ComponentCST, Garfield::ComponentElmer, Garfield::ComponentUser, Garfield::ComponentUserMapBase, and Garfield::ComponentFieldMap.

Definition at line 64 of file ComponentBase.cc.

66 {
67
68 if (debug) {
69 std::cerr << m_className << "::WeightingPotential:\n";
70 std::cerr << " This function is not implemented.\n";
71 std::cerr << " Weighting potential at (" << x << ", " << y << ", " << z
72 << ") for electrode " << label << " cannot be calculated.\n";
73 }
74 return 0.;
75}

Referenced by Garfield::ViewField::EvaluateWeightingField(), and Garfield::ComponentUserMapBase::WeightingPotential().

Member Data Documentation

◆ bx0

double Garfield::ComponentBase::bx0
protected

Definition at line 202 of file ComponentBase.hh.

Referenced by MagneticField(), and SetMagneticField().

◆ by0

double Garfield::ComponentBase::by0
protected

Definition at line 202 of file ComponentBase.hh.

Referenced by MagneticField(), and SetMagneticField().

◆ bz0

double Garfield::ComponentBase::bz0
protected

Definition at line 202 of file ComponentBase.hh.

Referenced by MagneticField(), and SetMagneticField().

◆ debug

bool Garfield::ComponentBase::debug
protected

Definition at line 205 of file ComponentBase.hh.

Referenced by Garfield::ComponentNeBem2d::AddPanel(), Garfield::ComponentNeBem2d::AddWire(), Garfield::ComponentCST::Coordinate2Index(), Garfield::ComponentFieldMap::Coordinates12(), Garfield::ComponentFieldMap::Coordinates13(), Garfield::ComponentFieldMap::Coordinates3(), Garfield::ComponentFieldMap::Coordinates4(), Garfield::ComponentFieldMap::Coordinates5(), Garfield::ComponentFieldMap::CoordinatesCube(), DisableDebugging(), Garfield::ComponentAnsys121::ElectricField(), Garfield::ComponentAnsys123::ElectricField(), Garfield::ComponentElmer::ElectricField(), Garfield::ComponentTcad2d::ElectricField(), Garfield::ComponentTcad3d::ElectricField(), Garfield::ComponentUserMapBase::ElectricField(), Garfield::ComponentConstant::ElectricField(), Garfield::ComponentUser::ElectricField(), EnableDebugging(), Garfield::ComponentFieldMap::FindElement13(), Garfield::ComponentFieldMap::FindElement5(), Garfield::ComponentFieldMap::FindElementCube(), Garfield::ComponentAnsys121::GetMedium(), Garfield::ComponentAnsys123::GetMedium(), Garfield::ComponentCST::GetMedium(), Garfield::ComponentElmer::GetMedium(), Garfield::ComponentUserMapBase::GetMedium(), Garfield::ComponentTcad2d::GetMobility(), Garfield::ComponentTcad3d::Initialise(), Garfield::ComponentCST::Initialise(), Garfield::ComponentAnsys121::Initialise(), Garfield::ComponentAnsys123::Initialise(), Garfield::ComponentElmer::Initialise(), IsInTrapRadius(), Garfield::ComponentAnalyticField::IsInTrapRadius(), Garfield::ComponentFieldMap::JacobianCube(), MagneticField(), Garfield::ComponentFieldMap::SetMedium(), Garfield::ComponentFieldMap::SetRange(), Garfield::ComponentCST::SetWeightingField(), Garfield::ComponentUserMapBase::UpdatePeriodicity(), Garfield::ComponentFieldMap::UpdatePeriodicityCommon(), Garfield::ComponentAnsys121::WeightingField(), Garfield::ComponentAnsys123::WeightingField(), WeightingField(), Garfield::ComponentConstant::WeightingField(), Garfield::ComponentElmer::WeightingField(), Garfield::ComponentUserMapBase::WeightingField(), Garfield::ComponentAnsys121::WeightingPotential(), Garfield::ComponentAnsys123::WeightingPotential(), WeightingPotential(), Garfield::ComponentCST::WeightingPotential(), Garfield::ComponentElmer::WeightingPotential(), and Garfield::ComponentUserMapBase::WeightingPotential().

◆ m_className

std::string Garfield::ComponentBase::m_className
protected

Definition at line 185 of file ComponentBase.hh.

Referenced by Garfield::ComponentNeBem2d::AddPanel(), Garfield::ComponentAnalyticField::AddPlaneX(), Garfield::ComponentAnalyticField::AddPlaneY(), Garfield::ComponentAnalyticField::AddReadout(), Garfield::ComponentAnalyticField::AddStripOnPlaneX(), Garfield::ComponentAnalyticField::AddStripOnPlaneY(), Garfield::ComponentAnalyticField::AddTube(), Garfield::ComponentAnalyticField::AddWire(), Garfield::ComponentNeBem2d::AddWire(), Garfield::ComponentFieldMap::CalculateElementBoundingBoxes(), Garfield::ComponentAnalyticField::ComponentAnalyticField(), Garfield::ComponentAnsys121::ComponentAnsys121(), Garfield::ComponentAnsys123::ComponentAnsys123(), Garfield::ComponentConstant::ComponentConstant(), Garfield::ComponentCST::ComponentCST(), Garfield::ComponentElmer::ComponentElmer(), Garfield::ComponentFieldMap::ComponentFieldMap(), Garfield::ComponentNeBem2d::ComponentNeBem2d(), Garfield::ComponentTcad2d::ComponentTcad2d(), Garfield::ComponentTcad3d::ComponentTcad3d(), Garfield::ComponentUser::ComponentUser(), Garfield::ComponentUserMapBase::ComponentUserMapBase(), Garfield::ComponentVoxel::ComponentVoxel(), Garfield::ComponentCST::Coordinate2Index(), Garfield::ComponentFieldMap::Coordinates12(), Garfield::ComponentFieldMap::Coordinates13(), Garfield::ComponentFieldMap::Coordinates3(), Garfield::ComponentFieldMap::Coordinates4(), Garfield::ComponentFieldMap::Coordinates5(), Garfield::ComponentFieldMap::CoordinatesCube(), Garfield::ComponentFieldMap::DriftMedium(), Garfield::ComponentAnsys121::ElectricField(), Garfield::ComponentAnsys123::ElectricField(), Garfield::ComponentElmer::ElectricField(), Garfield::ComponentNeBem2d::ElectricField(), Garfield::ComponentTcad2d::ElectricField(), Garfield::ComponentTcad3d::ElectricField(), Garfield::ComponentUserMapBase::ElectricField(), Garfield::ComponentVoxel::ElectricField(), Garfield::ComponentConstant::ElectricField(), Garfield::ComponentUser::ElectricField(), Garfield::ComponentFieldMap::FindElement13(), Garfield::ComponentFieldMap::FindElement5(), Garfield::ComponentFieldMap::FindElementCube(), Garfield::ComponentFieldMap::GetConductivity(), Garfield::ComponentVoxel::GetElectricFieldRange(), Garfield::ComponentVoxel::GetElement(), Garfield::ComponentFieldMap::GetElement(), Garfield::ComponentTcad2d::GetElement(), Garfield::ComponentTcad3d::GetElement(), Garfield::ComponentAnsys121::GetMedium(), Garfield::ComponentAnsys123::GetMedium(), Garfield::ComponentCST::GetMedium(), Garfield::ComponentElmer::GetMedium(), Garfield::ComponentTcad2d::GetMedium(), Garfield::ComponentTcad3d::GetMedium(), Garfield::ComponentUserMapBase::GetMedium(), Garfield::ComponentVoxel::GetMedium(), Garfield::ComponentFieldMap::GetMedium(), Garfield::ComponentTcad2d::GetMobility(), Garfield::ComponentTcad2d::GetNode(), Garfield::ComponentTcad3d::GetNode(), Garfield::ComponentFieldMap::GetPermittivity(), Garfield::ComponentAnalyticField::GetPlaneX(), Garfield::ComponentAnalyticField::GetPlaneY(), Garfield::ComponentTcad2d::GetRegion(), Garfield::ComponentTcad3d::GetRegion(), Garfield::ComponentAnalyticField::GetVoltageRange(), Garfield::ComponentConstant::GetVoltageRange(), Garfield::ComponentAnalyticField::GetWire(), Garfield::ComponentTcad2d::Initialise(), Garfield::ComponentTcad3d::Initialise(), Garfield::ComponentCST::Initialise(), Garfield::ComponentAnsys121::Initialise(), Garfield::ComponentAnsys123::Initialise(), Garfield::ComponentElmer::Initialise(), IsInTrapRadius(), Garfield::ComponentAnalyticField::IsInTrapRadius(), Garfield::ComponentAnalyticField::IsWireCrossed(), Garfield::ComponentFieldMap::Jacobian13(), Garfield::ComponentFieldMap::Jacobian3(), Garfield::ComponentFieldMap::Jacobian5(), Garfield::ComponentFieldMap::JacobianCube(), Garfield::ComponentVoxel::LoadData(), MagneticField(), Garfield::ComponentFieldMap::NotDriftMedium(), Garfield::ComponentAnalyticField::PrintCharges(), Garfield::ComponentFieldMap::PrintMaterials(), Garfield::ComponentFieldMap::PrintRange(), Garfield::ComponentTcad2d::PrintRegions(), Garfield::ComponentTcad3d::PrintRegions(), Garfield::ComponentVoxel::PrintRegions(), Garfield::ComponentTcad2d::SetDriftRegion(), Garfield::ComponentTcad3d::SetDriftRegion(), Garfield::ComponentConstant::SetElectricField(), Garfield::ComponentUser::SetElectricField(), Garfield::ComponentNeBem2d::SetMaxNumberOfIterations(), Garfield::ComponentVoxel::SetMedium(), Garfield::ComponentFieldMap::SetMedium(), Garfield::ComponentTcad2d::SetMedium(), Garfield::ComponentTcad3d::SetMedium(), Garfield::ComponentVoxel::SetMesh(), Garfield::ComponentNeBem2d::SetMinimumElementSize(), Garfield::ComponentNeBem2d::SetNumberOfCollocationPoints(), Garfield::ComponentNeBem2d::SetNumberOfDivisions(), Garfield::ComponentAnalyticField::SetPeriodicityX(), Garfield::ComponentAnalyticField::SetPeriodicityY(), Garfield::ComponentUser::SetPotential(), Garfield::ComponentFieldMap::SetRange(), Garfield::ComponentAnsys121::SetRangeZ(), Garfield::ComponentCST::SetRangeZ(), Garfield::ComponentTcad2d::SetRangeZ(), Garfield::ComponentAnsys121::SetWeightingField(), Garfield::ComponentAnsys123::SetWeightingField(), Garfield::ComponentElmer::SetWeightingField(), Garfield::ComponentCST::SetWeightingField(), Garfield::ComponentUser::SetWeightingField(), Garfield::ComponentConstant::SetWeightingPotential(), Garfield::ComponentUser::SetWeightingPotential(), Garfield::ComponentCST::ShiftComponent(), Garfield::ComponentTcad2d::UnsetDriftRegion(), Garfield::ComponentTcad3d::UnsetDriftRegion(), Garfield::ComponentUserMapBase::UpdatePeriodicity(), Garfield::ComponentFieldMap::UpdatePeriodicity2d(), Garfield::ComponentFieldMap::UpdatePeriodicityCommon(), Garfield::ComponentAnalyticField::WeightingField(), Garfield::ComponentAnsys121::WeightingField(), Garfield::ComponentAnsys123::WeightingField(), WeightingField(), Garfield::ComponentConstant::WeightingField(), Garfield::ComponentCST::WeightingField(), Garfield::ComponentElmer::WeightingField(), Garfield::ComponentUserMapBase::WeightingField(), Garfield::ComponentAnalyticField::WeightingPotential(), Garfield::ComponentAnsys121::WeightingPotential(), Garfield::ComponentAnsys123::WeightingPotential(), WeightingPotential(), Garfield::ComponentCST::WeightingPotential(), Garfield::ComponentElmer::WeightingPotential(), and Garfield::ComponentUserMapBase::WeightingPotential().

◆ ready

bool Garfield::ComponentBase::ready
protected

Definition at line 190 of file ComponentBase.hh.

Referenced by Garfield::ComponentNeBem2d::AddPanel(), Garfield::ComponentNeBem2d::AddWire(), Garfield::ComponentFieldMap::CalculateElementBoundingBoxes(), Garfield::ComponentAnsys121::ComponentAnsys121(), Garfield::ComponentAnsys123::ComponentAnsys123(), Garfield::ComponentCST::ComponentCST(), Garfield::ComponentElmer::ComponentElmer(), Garfield::ComponentFieldMap::DriftMedium(), Garfield::ComponentAnsys121::ElectricField(), Garfield::ComponentAnsys123::ElectricField(), Garfield::ComponentElmer::ElectricField(), Garfield::ComponentNeBem2d::ElectricField(), Garfield::ComponentTcad2d::ElectricField(), Garfield::ComponentTcad3d::ElectricField(), Garfield::ComponentVoxel::ElectricField(), Garfield::ComponentFieldMap::GetBoundingBox(), Garfield::ComponentTcad2d::GetBoundingBox(), Garfield::ComponentTcad3d::GetBoundingBox(), Garfield::ComponentVoxel::GetBoundingBox(), Garfield::ComponentVoxel::GetElectricFieldRange(), Garfield::ComponentVoxel::GetElement(), Garfield::ComponentAnsys121::GetMedium(), Garfield::ComponentAnsys123::GetMedium(), Garfield::ComponentElmer::GetMedium(), Garfield::ComponentTcad2d::GetMedium(), Garfield::ComponentTcad3d::GetMedium(), Garfield::ComponentVoxel::GetMedium(), Garfield::ComponentTcad2d::GetMobility(), Garfield::ComponentTcad2d::GetVoltageRange(), Garfield::ComponentTcad3d::GetVoltageRange(), Garfield::ComponentVoxel::GetVoltageRange(), Garfield::ComponentTcad2d::Initialise(), Garfield::ComponentTcad3d::Initialise(), Garfield::ComponentCST::Initialise(), Garfield::ComponentAnsys121::Initialise(), Garfield::ComponentAnsys123::Initialise(), Garfield::ComponentElmer::Initialise(), IsReady(), Garfield::ComponentVoxel::LoadData(), Garfield::ComponentFieldMap::NotDriftMedium(), Garfield::ComponentFieldMap::PrintMaterials(), Garfield::ComponentTcad2d::PrintRegions(), Garfield::ComponentTcad3d::PrintRegions(), Garfield::ComponentVoxel::PrintRegions(), Garfield::ComponentConstant::SetElectricField(), Garfield::ComponentUser::SetElectricField(), Garfield::ComponentVoxel::SetMesh(), Garfield::ComponentNeBem2d::SetMinimumElementSize(), Garfield::ComponentNeBem2d::SetNumberOfCollocationPoints(), Garfield::ComponentNeBem2d::SetNumberOfDivisions(), Garfield::ComponentFieldMap::SetRange(), Garfield::ComponentAnsys121::SetWeightingField(), Garfield::ComponentAnsys123::SetWeightingField(), Garfield::ComponentElmer::SetWeightingField(), Garfield::ComponentCST::SetWeightingField(), Garfield::ComponentFieldMap::UpdatePeriodicity2d(), Garfield::ComponentFieldMap::UpdatePeriodicityCommon(), Garfield::ComponentAnsys121::WeightingField(), Garfield::ComponentAnsys123::WeightingField(), Garfield::ComponentCST::WeightingField(), Garfield::ComponentElmer::WeightingField(), Garfield::ComponentAnsys121::WeightingPotential(), Garfield::ComponentAnsys123::WeightingPotential(), Garfield::ComponentCST::WeightingPotential(), and Garfield::ComponentElmer::WeightingPotential().

◆ theGeometry

GeometryBase* Garfield::ComponentBase::theGeometry
protected

Definition at line 187 of file ComponentBase.hh.

Referenced by Clear(), Garfield::ComponentAnalyticField::GetBoundingBox(), GetBoundingBox(), GetMedium(), Garfield::ComponentConstant::GetVoltageRange(), and SetGeometry().

◆ xAxiallyPeriodic

bool Garfield::ComponentBase::xAxiallyPeriodic
protected

Definition at line 197 of file ComponentBase.hh.

Referenced by DisableAxialPeriodicityX(), EnableAxialPeriodicityX(), Garfield::ComponentFieldMap::MapCoordinates(), Garfield::ComponentFieldMap::PrintRange(), Garfield::ComponentFieldMap::UnmapFields(), Garfield::ComponentFieldMap::UpdatePeriodicity2d(), and Garfield::ComponentFieldMap::UpdatePeriodicityCommon().

◆ xMirrorPeriodic

bool Garfield::ComponentBase::xMirrorPeriodic
protected

Definition at line 195 of file ComponentBase.hh.

Referenced by DisableMirrorPeriodicityX(), Garfield::ComponentTcad2d::ElectricField(), Garfield::ComponentTcad3d::ElectricField(), EnableMirrorPeriodicityX(), Garfield::ComponentTcad2d::GetBoundingBox(), Garfield::ComponentTcad3d::GetBoundingBox(), Garfield::ComponentVoxel::GetBoundingBox(), Garfield::ComponentVoxel::GetElement(), Garfield::ComponentTcad2d::GetMedium(), Garfield::ComponentTcad3d::GetMedium(), Garfield::ComponentTcad2d::GetMobility(), Garfield::ComponentFieldMap::MapCoordinates(), Garfield::ComponentFieldMap::PrintRange(), and Garfield::ComponentFieldMap::UpdatePeriodicityCommon().

◆ xPeriodic

bool Garfield::ComponentBase::xPeriodic
protected

Definition at line 193 of file ComponentBase.hh.

Referenced by DisablePeriodicityX(), Garfield::ComponentTcad2d::ElectricField(), Garfield::ComponentTcad3d::ElectricField(), EnablePeriodicityX(), Garfield::ComponentTcad2d::GetBoundingBox(), Garfield::ComponentTcad3d::GetBoundingBox(), Garfield::ComponentVoxel::GetBoundingBox(), Garfield::ComponentVoxel::GetElement(), Garfield::ComponentTcad2d::GetMedium(), Garfield::ComponentTcad3d::GetMedium(), Garfield::ComponentTcad2d::GetMobility(), Garfield::ComponentAnalyticField::GetPeriodicityX(), Garfield::ComponentFieldMap::MapCoordinates(), Garfield::ComponentFieldMap::PrintRange(), Garfield::ComponentAnalyticField::SetPeriodicityX(), and Garfield::ComponentFieldMap::UpdatePeriodicityCommon().

◆ xRotationSymmetry

bool Garfield::ComponentBase::xRotationSymmetry
protected

Definition at line 199 of file ComponentBase.hh.

Referenced by DisableRotationSymmetryX(), EnableRotationSymmetryX(), Garfield::ComponentFieldMap::MapCoordinates(), Garfield::ComponentFieldMap::PrintRange(), Garfield::ComponentFieldMap::UnmapFields(), and Garfield::ComponentFieldMap::UpdatePeriodicityCommon().

◆ yAxiallyPeriodic

bool Garfield::ComponentBase::yAxiallyPeriodic
protected

Definition at line 197 of file ComponentBase.hh.

Referenced by DisableAxialPeriodicityY(), EnableAxialPeriodicityY(), Garfield::ComponentFieldMap::MapCoordinates(), Garfield::ComponentFieldMap::PrintRange(), Garfield::ComponentFieldMap::UnmapFields(), Garfield::ComponentFieldMap::UpdatePeriodicity2d(), and Garfield::ComponentFieldMap::UpdatePeriodicityCommon().

◆ yMirrorPeriodic

bool Garfield::ComponentBase::yMirrorPeriodic
protected

Definition at line 195 of file ComponentBase.hh.

Referenced by DisableMirrorPeriodicityY(), Garfield::ComponentTcad2d::ElectricField(), Garfield::ComponentTcad3d::ElectricField(), EnableMirrorPeriodicityY(), Garfield::ComponentTcad2d::GetBoundingBox(), Garfield::ComponentTcad3d::GetBoundingBox(), Garfield::ComponentVoxel::GetBoundingBox(), Garfield::ComponentVoxel::GetElement(), Garfield::ComponentTcad2d::GetMedium(), Garfield::ComponentTcad3d::GetMedium(), Garfield::ComponentTcad2d::GetMobility(), Garfield::ComponentFieldMap::MapCoordinates(), Garfield::ComponentFieldMap::PrintRange(), and Garfield::ComponentFieldMap::UpdatePeriodicityCommon().

◆ yPeriodic

bool Garfield::ComponentBase::yPeriodic
protected

Definition at line 193 of file ComponentBase.hh.

Referenced by DisablePeriodicityY(), Garfield::ComponentTcad2d::ElectricField(), Garfield::ComponentTcad3d::ElectricField(), EnablePeriodicityY(), Garfield::ComponentTcad2d::GetBoundingBox(), Garfield::ComponentTcad3d::GetBoundingBox(), Garfield::ComponentVoxel::GetBoundingBox(), Garfield::ComponentVoxel::GetElement(), Garfield::ComponentTcad2d::GetMedium(), Garfield::ComponentTcad3d::GetMedium(), Garfield::ComponentTcad2d::GetMobility(), Garfield::ComponentAnalyticField::GetPeriodicityY(), Garfield::ComponentFieldMap::MapCoordinates(), Garfield::ComponentFieldMap::PrintRange(), Garfield::ComponentAnalyticField::SetPeriodicityY(), and Garfield::ComponentFieldMap::UpdatePeriodicityCommon().

◆ yRotationSymmetry

bool Garfield::ComponentBase::yRotationSymmetry
protected

Definition at line 199 of file ComponentBase.hh.

Referenced by DisableRotationSymmetryY(), EnableRotationSymmetryY(), Garfield::ComponentFieldMap::MapCoordinates(), Garfield::ComponentFieldMap::PrintRange(), Garfield::ComponentFieldMap::UnmapFields(), and Garfield::ComponentFieldMap::UpdatePeriodicityCommon().

◆ zAxiallyPeriodic

bool Garfield::ComponentBase::zAxiallyPeriodic
protected

Definition at line 197 of file ComponentBase.hh.

Referenced by DisableAxialPeriodicityZ(), EnableAxialPeriodicityZ(), Garfield::ComponentFieldMap::MapCoordinates(), Garfield::ComponentFieldMap::PrintRange(), Garfield::ComponentFieldMap::UnmapFields(), and Garfield::ComponentFieldMap::UpdatePeriodicityCommon().

◆ zMirrorPeriodic

bool Garfield::ComponentBase::zMirrorPeriodic
protected

Definition at line 195 of file ComponentBase.hh.

Referenced by DisableMirrorPeriodicityZ(), Garfield::ComponentTcad3d::ElectricField(), EnableMirrorPeriodicityZ(), Garfield::ComponentTcad3d::GetBoundingBox(), Garfield::ComponentVoxel::GetBoundingBox(), Garfield::ComponentVoxel::GetElement(), Garfield::ComponentTcad3d::GetMedium(), Garfield::ComponentFieldMap::MapCoordinates(), Garfield::ComponentFieldMap::PrintRange(), Garfield::ComponentFieldMap::UpdatePeriodicity2d(), and Garfield::ComponentFieldMap::UpdatePeriodicityCommon().

◆ zPeriodic

bool Garfield::ComponentBase::zPeriodic
protected

Definition at line 193 of file ComponentBase.hh.

Referenced by DisablePeriodicityZ(), Garfield::ComponentTcad3d::ElectricField(), EnablePeriodicityZ(), Garfield::ComponentTcad3d::GetBoundingBox(), Garfield::ComponentVoxel::GetBoundingBox(), Garfield::ComponentVoxel::GetElement(), Garfield::ComponentTcad3d::GetMedium(), Garfield::ComponentFieldMap::MapCoordinates(), Garfield::ComponentFieldMap::PrintRange(), Garfield::ComponentFieldMap::UpdatePeriodicity2d(), and Garfield::ComponentFieldMap::UpdatePeriodicityCommon().

◆ zRotationSymmetry

bool Garfield::ComponentBase::zRotationSymmetry
protected

Definition at line 199 of file ComponentBase.hh.

Referenced by DisableRotationSymmetryZ(), EnableRotationSymmetryZ(), Garfield::ComponentFieldMap::MapCoordinates(), Garfield::ComponentFieldMap::PrintRange(), Garfield::ComponentFieldMap::UnmapFields(), and Garfield::ComponentFieldMap::UpdatePeriodicityCommon().

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