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::ComponentAnsys121 Class Reference

Component for importing and interpolating two-dimensional ANSYS field maps. More...

#include <ComponentAnsys121.hh>

+ Inheritance diagram for Garfield::ComponentAnsys121:

Public Member Functions

 ComponentAnsys121 ()
 Constructor.
 
 ~ComponentAnsys121 ()
 Destructor.
 
bool Initialise (const std::string &elist="ELIST.lis", const std::string &nlist="NLIST.lis", const std::string &mplist="MPLIST.lis", const std::string &prnsol="PRNSOL.lis", const std::string &unit="cm")
 
bool SetWeightingPotential (const std::string &prnsol, const std::string &label)
 Import weighting potentials.
 
bool SetWeightingField (const std::string &prnsol, const std::string &label)
 
void SetRangeZ (const double zmin, const double zmax)
 Set the limits of the active region along z.
 
- Public Member Functions inherited from Garfield::ComponentFieldMap
 ComponentFieldMap ()=delete
 Default constructor.
 
 ComponentFieldMap (const std::string &name)
 Constructor.
 
virtual ~ComponentFieldMap ()
 Destructor.
 
bool Check ()
 Check element aspect ratio.
 
void PrintRange ()
 Show x, y, z, V and angular ranges.
 
void PrintMaterials ()
 List all currently defined materials.
 
void DriftMedium (const size_t imat)
 Flag a field map material as a drift medium.
 
void NotDriftMedium (const size_t imat)
 Flag a field map materials as a non-drift medium.
 
size_t GetNumberOfMaterials () const
 Return the number of materials in the field map.
 
double GetPermittivity (const size_t imat) const
 Return the relative permittivity of a field map material.
 
double GetConductivity (const size_t imat) const
 Return the conductivity of a field map material.
 
void SetMedium (const size_t imat, Medium *medium)
 Associate a field map material with a Medium object.
 
Medium * GetMedium (const size_t imat) const
 Return the Medium associated to a field map material.
 
void SetGas (Medium *medium)
 
virtual size_t GetNumberOfElements () const
 Return the number of mesh elements.
 
bool GetElement (const size_t i, double &vol, double &dmin, double &dmax) const
 Return the volume and aspect ratio of a mesh element.
 
virtual bool GetElement (const size_t i, size_t &mat, bool &drift, std::vector< size_t > &nodes) const
 Return the material and node indices of a mesh element.
 
virtual size_t GetNumberOfNodes () const
 
virtual bool GetNode (const size_t i, double &x, double &y, double &z) const
 
double GetPotential (const size_t i) const
 
void EnableCheckMapIndices (const bool on=true)
 
void EnableDeleteBackgroundElements (const bool on=true)
 Option to eliminate mesh elements in conductors (default: on).
 
void EnableTetrahedralTreeForElementSearch (const bool on=true)
 
void EnableConvergenceWarnings (const bool on=true)
 
Medium * GetMedium (const double x, const double y, const double z) override
 Get the medium at a given location (x, y, z).
 
void ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, Medium *&m, int &status) override
 
void ElectricField (const double x, const double y, const double z, double &ex, double &ey, double &ez, double &v, Medium *&m, int &status) override
 Calculate the drift field [V/cm] and potential [V] at (x, y, z).
 
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
 
double DelayedWeightingPotential (double x, double y, double z, const double t, const std::string &label) override
 
bool IsInBoundingBox (const double x, const double y, const double z) const
 
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.
 
bool GetVoltageRange (double &vmin, double &vmax) override
 Calculate the voltage range [V].
 
void CopyWeightingPotential (const std::string &label, const std::string &labelSource, const double x, const double y, const double z, const double alpha, const double beta, const double gamma)
 
std::array< double, 3 > ElectricField (const double x, const double y, const double z)
 Calculate the drift field [V/cm] at (x, y, z).
 
- Public Member Functions inherited from Garfield::Component
 Component ()=delete
 Default constructor.
 
 Component (const std::string &name)
 Constructor.
 
virtual ~Component ()
 Destructor.
 
virtual void SetGeometry (Geometry *geo)
 Define the geometry.
 
virtual void Clear ()
 Reset.
 
std::array< double, 3 > ElectricField (const double x, const double y, const double z)
 Calculate the drift field [V/cm] at (x, y, z).
 
virtual double ElectricPotential (const double x, const double y, const double z)
 Calculate the (drift) electrostatic potential [V] at (x, y, z).
 
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 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?
 
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 HasMagneticField () const
 Does the component have a non-zero magnetic field?
 
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 Types inherited from Garfield::ComponentFieldMap
enum class  ElementType { Unknown = 0 , Serendipity = 5 , CurvedTetrahedron = 13 }
 
- Protected Member Functions inherited from Garfield::ComponentFieldMap
void Reset () override
 Reset the component.
 
void Prepare ()
 
virtual void SetRange ()
 
void UpdatePeriodicity () override
 Verify periodicities.
 
void UpdatePeriodicity2d ()
 
void UpdatePeriodicityCommon ()
 
bool SetDefaultDriftMedium ()
 Find lowest epsilon, check for eps = 0, set default drift media flags.
 
int Field (const double x, const double y, const double z, double &fx, double &fy, double &fz, int &iel, const std::vector< double > &potentials) const
 Compute the electric/weighting field.
 
double Potential (const double x, const double y, const double z, const std::vector< double > &potentials) const
 Compute the electrostatic/weighting potential.
 
int FindElement5 (const double x, const double y, double &t1, double &t2, double &t3, double &t4, double jac[4][4], double &det) const
 Find the element for a point in curved quadratic quadrilaterals.
 
int FindElement13 (const double x, const double y, const double z, double &t1, double &t2, double &t3, double &t4, double jac[4][4], double &det) const
 Find the element for a point in curved quadratic tetrahedra.
 
int FindElementCube (const double x, const double y, const double z, double &t1, double &t2, double &t3, TMatrixD *&jac, std::vector< TMatrixD * > &dN) const
 Find the element for a point in a cube.
 
void MapCoordinates (double &xpos, double &ypos, double &zpos, bool &xmirrored, bool &ymirrored, bool &zmirrored, double &rcoordinate, double &rotation) const
 Move (xpos, ypos, zpos) to field map coordinates.
 
void UnmapFields (double &ex, double &ey, double &ez, const double xpos, const double ypos, const double zpos, const bool xmirrored, const bool ymirrored, const bool zmirrored, const double rcoordinate, const double rotation) const
 Move (ex, ey, ez) to global coordinates.
 
virtual double GetElementVolume (const size_t i) const
 
virtual void GetAspectRatio (const size_t i, double &dmin, double &dmax) const
 
void PrintWarning (const std::string &header)
 
void PrintNotReady (const std::string &header) const
 
void PrintCouldNotOpen (const std::string &header, const std::string &filename) const
 
void PrintElement (const std::string &header, const double x, const double y, const double z, const double t1, const double t2, const double t3, const double t4, const size_t i, const std::vector< double > &potential) const
 
void TimeInterpolation (const double t, double &f0, double &f1, int &i0, int &i1)
 Interpolation of potential between two time slices.
 
- Static Protected Member Functions inherited from Garfield::ComponentFieldMap
static double ScalingFactor (std::string unit)
 
static double Potential3 (const std::array< double, 6 > &v, const std::array< double, 3 > &t)
 Interpolate the potential in a triangle.
 
static void Field3 (const std::array< double, 6 > &v, const std::array< double, 3 > &t, double jac[4][4], const double det, double &ex, double &ey)
 Interpolate the field in a triangle.
 
static double Potential5 (const std::array< double, 8 > &v, const std::array< double, 2 > &t)
 Interpolate the potential in a curved quadrilateral.
 
static void Field5 (const std::array< double, 8 > &v, const std::array< double, 2 > &t, double jac[4][4], const double det, double &ex, double &ey)
 Interpolate the field in a curved quadrilateral.
 
static double Potential13 (const std::array< double, 10 > &v, const std::array< double, 4 > &t)
 Interpolate the potential in a curved quadratic tetrahedron.
 
static void Field13 (const std::array< double, 10 > &v, const std::array< double, 4 > &t, double jac[4][4], const double det, double &ex, double &ey, double &ez)
 Interpolate the field in a curved quadratic tetrahedron.
 
static int ReadInteger (char *token, int def, bool &error)
 
static double ReadDouble (char *token, double def, bool &error)
 
- Protected Attributes inherited from Garfield::ComponentFieldMap
bool m_is3d = true
 
ElementType m_elementType = ElementType::CurvedTetrahedron
 
std::vector< Element > m_elements
 
std::vector< int > m_elementIndices
 
std::vector< bool > m_degenerate
 
std::vector< std::array< double, 3 > > m_bbMin
 
std::vector< std::array< double, 3 > > m_bbMax
 
std::vector< std::array< std::array< double, 3 >, 4 > > m_w12
 
std::vector< Node > m_nodes
 
std::vector< double > m_pot
 
std::map< std::string, std::vector< double > > m_wpot
 
std::map< std::string, std::vector< std::vector< double > > > m_dwpot
 
std::vector< Material > m_materials
 
std::map< std::string, WeightingFieldCopy > m_wfieldCopies
 
std::vector< double > m_wdtimes
 
bool m_hasBoundingBox = false
 
std::array< double, 3 > m_minBoundingBox = {{0., 0., 0.}}
 
std::array< double, 3 > m_maxBoundingBox = {{0., 0., 0.}}
 
std::array< double, 3 > m_mapmin = {{0., 0., 0.}}
 
std::array< double, 3 > m_mapmax = {{0., 0., 0.}}
 
std::array< double, 3 > m_mapamin = {{0., 0., 0.}}
 
std::array< double, 3 > m_mapamax = {{0., 0., 0.}}
 
std::array< double, 3 > m_mapna = {{0., 0., 0.}}
 
std::array< double, 3 > m_cells = {{0., 0., 0.}}
 
double m_mapvmin = 0.
 
double m_mapvmax = 0.
 
std::array< bool, 3 > m_setang
 
bool m_deleteBackground = true
 
bool m_warning = false
 
unsigned int m_nWarnings = 0
 
bool m_printConvergenceWarnings = true
 
- 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 importing and interpolating two-dimensional ANSYS field maps.

Definition at line 10 of file ComponentAnsys121.hh.

Constructor & Destructor Documentation

◆ ComponentAnsys121()

Garfield::ComponentAnsys121::ComponentAnsys121 ( )

Constructor.

Definition at line 10 of file ComponentAnsys121.cc.

10 : ComponentFieldMap("Ansys121") {
11 m_is3d = false;
12 m_elementType = ElementType::Serendipity;
13 // Default bounding box
14 m_minBoundingBox[2] = -50;
15 m_maxBoundingBox[2] = 50;
16}
Garfield::ComponentFieldMap::m_maxBoundingBox
std::array< double, 3 > m_maxBoundingBox
Definition ComponentFieldMap.hh:206
Garfield::ComponentFieldMap::m_minBoundingBox
std::array< double, 3 > m_minBoundingBox
Definition ComponentFieldMap.hh:205
Garfield::ComponentFieldMap::ComponentFieldMap
ComponentFieldMap()=delete
Default constructor.

◆ ~ComponentAnsys121()

Garfield::ComponentAnsys121::~ComponentAnsys121 ( )
inline

Destructor.

Definition at line 15 of file ComponentAnsys121.hh.

15{}

Member Function Documentation

◆ Initialise()

bool Garfield::ComponentAnsys121::Initialise ( const std::string & elist = "ELIST.lis",
const std::string & nlist = "NLIST.lis",
const std::string & mplist = "MPLIST.lis",
const std::string & prnsol = "PRNSOL.lis",
const std::string & unit = "cm" )

Import a field map.

Parameters
elistname of the file containing the list of elements
nlistname of the file containing the list of nodes
mplistname of the file containing the list of materials
prnsolname of the file containing the nodal solutions
unitlength unit

Definition at line 18 of file ComponentAnsys121.cc.

22 {
23 Reset();
24 // Keep track of the success.
25 bool ok = true;
26
27 // Buffer for reading
28 constexpr int size = 100;
29 char line[size];
30
31 // Open the material list.
32 std::ifstream fmplist(mplist);
33 if (!fmplist) {
34 PrintCouldNotOpen("Initialise", mplist);
35 return false;
36 }
37
38 // Read the material list.
39 int il = 0;
40 unsigned int icurrmat = 0;
41 bool readerror = false;
42 while (fmplist.getline(line, size, '\n')) {
43 il++;
44 // Skip page feed.
45 if (strcmp(line, "1") == 0) {
46 for (size_t k = 0; k < 5; ++k) fmplist.getline(line, size, '\n');
47 il += 5;
48 continue;
49 }
50 // Split the line in tokens.
51 char* token = strtok(line, " ");
52 // Skip blank lines and headers.
53 if (!token || strcmp(token, " ") == 0 || strcmp(token, "\n") == 0 ||
54 strcmp(token, "TEMPERATURE") == 0 || strcmp(token, "PROPERTY=") == 0 ||
55 int(token[0]) == 10 || int(token[0]) == 13) {
56 continue;
57 }
58 // Read number of materials and initialise the list.
59 if (strcmp(token, "LIST") == 0) {
60 token = strtok(nullptr, " ");
61 token = strtok(nullptr, " ");
62 token = strtok(nullptr, " ");
63 token = strtok(nullptr, " ");
64 const int nMaterials = ReadInteger(token, -1, readerror);
65 if (readerror || nMaterials < 0) {
66 std::cerr << m_className << "::Initialise:\n"
67 << " Error reading file " << mplist << " (line " << il
68 << ").\n";
69 fmplist.close();
70 return false;
71 }
72 m_materials.resize(nMaterials);
73 for (auto& material : m_materials) {
74 material.ohm = -1;
75 material.eps = -1;
76 material.medium = nullptr;
77 }
78 if (m_debug) {
79 std::cout << m_className << "::Initialise: " << nMaterials
80 << " materials.\n";
81 }
82 } else if (strcmp(token, "MATERIAL") == 0) {
83 // Version 12 format: read material number
84 token = strtok(nullptr, " ");
85 token = strtok(nullptr, " ");
86 const int imat = ReadInteger(token, -1, readerror);
87 if (readerror || imat < 0) {
88 std::cerr << m_className << "::Initialise:\n"
89 << " Error reading file " << mplist << " (line " << il
90 << ").\n";
91 fmplist.close();
92 return false;
93 }
94 icurrmat = imat;
95 } else if (strcmp(token, "TEMP") == 0) {
96 // Version 12 format: read property tag and value
97 token = strtok(nullptr, " ");
98 int itype = 0;
99 if (strncmp(token, "PERX", 4) == 0) {
100 itype = 1;
101 } else if (strncmp(token, "RSVX", 4) == 0) {
102 itype = 2;
103 } else {
104 std::cerr << m_className << "::Initialise:\n"
105 << " Unknown material property flag " << token << "\n"
106 << " in material properties file " << mplist << " (line "
107 << il << ").\n";
108 ok = false;
109 break;
110 }
111 fmplist.getline(line, size, '\n');
112 il++;
113 token = nullptr;
114 token = strtok(line, " ");
115 if (icurrmat < 1 || icurrmat > m_materials.size()) {
116 std::cerr << m_className << "::Initialise:\n"
117 << " Found out-of-range current material index "
118 << icurrmat << "\n"
119 << " in material properties file " << mplist << ".\n";
120 ok = false;
121 break;
122 }
123 if (itype == 1) {
124 m_materials[icurrmat - 1].eps = ReadDouble(token, -1, readerror);
125 } else if (itype == 2) {
126 m_materials[icurrmat - 1].ohm = ReadDouble(token, -1, readerror);
127 }
128 if (readerror) {
129 std::cerr << m_className << "::Initialise:\n"
130 << " Error reading file " << mplist << " (line " << il
131 << ").\n";
132 fmplist.close();
133 return false;
134 }
135 } else if (strcmp(token, "PROPERTY") == 0) {
136 // Version 11 format
137 token = strtok(nullptr, " ");
138 token = strtok(nullptr, " ");
139 int itype = 0;
140 if (strcmp(token, "PERX") == 0) {
141 itype = 1;
142 } else if (strcmp(token, "RSVX") == 0) {
143 itype = 2;
144 } else {
145 std::cerr << m_className << "::Initialise:\n"
146 << " Unknown material property flag " << token << "\n"
147 << " in material properties file " << mplist << " (line "
148 << il << ").\n";
149 ok = false;
150 }
151 token = strtok(nullptr, " ");
152 token = strtok(nullptr, " ");
153 int imat = ReadInteger(token, -1, readerror);
154 if (readerror) {
155 std::cerr << m_className << "::Initialise:\n"
156 << " Error reading file " << mplist << " (line " << il
157 << ").\n";
158 fmplist.close();
159 return false;
160 } else if (imat < 1 || imat > (int)m_materials.size()) {
161 std::cerr << m_className << "::Initialise:\n";
162 std::cerr << " Found out-of-range current material index " << imat
163 << "\n";
164 std::cerr << " in material properties file " << mplist << ".\n";
165 ok = false;
166 break;
167 } else {
168 fmplist.getline(line, size, '\n');
169 il++;
170 fmplist.getline(line, size, '\n');
171 il++;
172 token = strtok(line, " ");
173 token = strtok(nullptr, " ");
174 if (itype == 1) {
175 m_materials[imat - 1].eps = ReadDouble(token, -1, readerror);
176 } else if (itype == 2) {
177 m_materials[imat - 1].ohm = ReadDouble(token, -1, readerror);
178 }
179 if (readerror) {
180 std::cerr << m_className << "::Initialise:\n"
181 << " Error reading file " << mplist << " (line " << il
182 << ").\n";
183 fmplist.close();
184 return false;
185 }
186 }
187 }
188 }
189 // Close the file
190 fmplist.close();
191 if (!ok) return false;
192
193 // Find lowest epsilon, check for eps = 0, set default drift medium.
194 if (!SetDefaultDriftMedium()) return false;
195
196 // Tell how many lines read
197 std::cout << m_className << "::Initialise:\n"
198 << " Read properties of " << m_materials.size()
199 << " materials from file " << mplist << ".\n";
200 if (m_debug) PrintMaterials();
201
202 // Open the element list
203 std::ifstream felist(elist);
204 if (!felist) {
205 PrintCouldNotOpen("Initialise", elist);
206 return false;
207 }
208 // Read the element list
209 int ndegenerate = 0;
210 int nbackground = 0;
211 il = 0;
212 int highestnode = 0;
213 while (felist.getline(line, size, '\n')) {
214 il++;
215 // Skip page feed in batch page title.
216 if (strstr(line, "VERSION") != nullptr) {
217 for (size_t k = 0; k < 2; ++k) felist.getline(line, size, '\n');
218 il += 2;
219 continue;
220 }
221 // Split the line in tokens.
222 char* token = strtok(line, " ");
223 // Skip blank lines and headers.
224 if (!token || strcmp(token, " ") == 0 || strcmp(token, "\n") == 0 ||
225 int(token[0]) == 10 || int(token[0]) == 13 ||
226 strcmp(token, "LIST") == 0 || strcmp(token, "ELEM") == 0 ||
227 strcmp(token, "ANSYS") == 0 || strcmp(token, "***") == 0 ||
228 strcmp(token, "VERSION") == 0) {
229 continue;
230 }
231 // Read the element.
232 int ielem = ReadInteger(token, -1, readerror);
233 token = strtok(nullptr, " ");
234 int imat = ReadInteger(token, -1, readerror);
235 token = strtok(nullptr, " ");
236 token = strtok(nullptr, " ");
237 token = strtok(nullptr, " ");
238 token = strtok(nullptr, " ");
239 std::vector<int> inode;
240 for (size_t k = 0; k < 8; ++k) {
241 token = strtok(nullptr, " ");
242 const int in = ReadInteger(token, -1, readerror);
243 if (!readerror) inode.push_back(in);
244 }
245
246 if (inode.size() != 8) {
247 std::cerr << m_className << "::Initialise:\n"
248 << " Error reading file " << elist << " (line " << il
249 << ").\n"
250 << " Read " << inode.size() << " node indices for element"
251 << ielem << " (expected 8).\n";
252 felist.close();
253 return false;
254 }
255 // Check synchronisation.
256 if (ielem - 1 != (int)m_elements.size() + nbackground) {
257 std::cerr << m_className << "::Initialise:\n"
258 << " Synchronisation lost on file " << elist << " (line "
259 << il << ").\n"
260 << " Element: " << ielem << " (expected "
261 << m_elements.size() << ").\n";
262 ok = false;
263 break;
264 }
265 // Check the material number and ensure that epsilon is non-negative
266 if (imat < 1 || imat > (int)m_materials.size()) {
267 std::cerr << m_className << "::Initialise:\n"
268 << " Out-of-range material number on file " << elist
269 << " (line " << il << ").\n"
270 << " Element: " << ielem << ", material: " << imat << ".\n";
271 ok = false;
272 break;
273 }
274 if (m_materials[imat - 1].eps < 0) {
275 std::cerr << m_className << "::Initialise:\n"
276 << " Element " << ielem << " in " << elist << "\n"
277 << " uses material " << imat << " which does not have\n"
278 << " a positive permittivity in " << mplist << ".\n";
279 ok = false;
280 break;
281 }
282 // Check the node numbers.
283 for (size_t k = 0; k < 8; ++k) {
284 if (inode[k] < 1) {
285 std::cerr << m_className << "::Initialise:\n"
286 << " Found a node number < 1 in " << elist << " (line "
287 << il << ").\n"
288 << " Element: " << ielem << ", material: " << imat << "\n";
289 ok = false;
290 break;
291 }
292 if (inode[k] > highestnode) highestnode = inode[k];
293 }
294 // Skip quadrilaterals which are background.
295 if (m_deleteBackground && m_materials[imat - 1].ohm == 0) {
296 nbackground++;
297 continue;
298 }
299 // Store the element, degeneracy
300 bool degenerate = false;
301 Element element;
302 if (inode[2] == inode[3] && inode[3] == inode[6]) {
303 ndegenerate++;
304 degenerate = true;
305 }
306 // Store the material reference
307 element.matmap = imat - 1;
308 // Node references
309 if (degenerate) {
310 element.emap[0] = inode[0] - 1;
311 element.emap[1] = inode[1] - 1;
312 element.emap[2] = inode[2] - 1;
313 element.emap[3] = inode[4] - 1;
314 element.emap[4] = inode[7] - 1;
315 element.emap[5] = inode[5] - 1;
316 element.emap[6] = inode[3] - 1;
317 element.emap[7] = inode[6] - 1;
318 } else {
319 for (size_t k = 0; k < 8; ++k) element.emap[k] = inode[k] - 1;
320 }
321 m_elements.push_back(std::move(element));
322 m_degenerate.push_back(degenerate);
323 }
324 // Close the file
325 felist.close();
326 if (!ok) return false;
327
328 if (m_elements.empty()) {
329 std::cerr << m_className << "::Initialise:\n"
330 << " Found no valid elements in file " << elist << ".\n";
331 return false;
332 }
333
334 // Tell how many lines read
335 std::cout << " Read " << m_elements.size() << " elements from file "
336 << elist << ".\n"
337 << " Highest node number: " << highestnode << "\n"
338 << " Degenerate elements: " << ndegenerate << "\n"
339 << " Background elements skipped: " << nbackground << ".\n";
340 // Check the value of the unit.
341 double funit = ScalingFactor(unit);
342 if (funit <= 0.) {
343 std::cerr << m_className << "::Initialise:\n"
344 << " Unknown length unit " << unit << ". Will use cm.\n";
345 funit = 1.0;
346 }
347 if (m_debug) {
348 std::cout << m_className << "::Initialise: Unit scaling factor = "
349 << funit << ".\n";
350 }
351
352 // Open the node list.
353 std::ifstream fnlist(nlist);
354 if (!fnlist) {
355 PrintCouldNotOpen("Initialise", nlist);
356 return false;
357 }
358 // Read the node list.
359 il = 0;
360 while (fnlist.getline(line, size, '\n')) {
361 il++;
362 // Skip page feed in batch page title.
363 if (strstr(line, "VERSION") != nullptr) {
364 for (size_t k = 0; k < 2; ++k) fnlist.getline(line, size, '\n');
365 il += 2;
366 continue;
367 }
368 // Split the line in tokens.
369 char* token = strtok(line, " ");
370 // Skip blank lines and headers.
371 if (!token || strcmp(token, " ") == 0 || strcmp(token, "\n") == 0 ||
372 int(token[0]) == 10 || int(token[0]) == 13 ||
373 strcmp(token, "LIST") == 0 || strcmp(token, "NODE") == 0 ||
374 strcmp(token, "ANSYS") == 0 || strcmp(token, "***") == 0 ||
375 strcmp(token, "FILE") == 0 || strcmp(token, "Electric") == 0 ||
376 strcmp(token, "VERSION") == 0) {
377 continue;
378 }
379 // Read the element.
380 int inode = ReadInteger(token, -1, readerror);
381 token = strtok(nullptr, " ");
382 double xnode = ReadDouble(token, -1, readerror);
383 token = strtok(nullptr, " ");
384 double ynode = ReadDouble(token, -1, readerror);
385 token = strtok(nullptr, " ");
386 double znode = ReadDouble(token, -1, readerror);
387 // Check syntax.
388 if (readerror) {
389 std::cerr << m_className << "::Initialise:\n"
390 << " Error reading file " << nlist << " (line " << il
391 << ").\n";
392 fnlist.close();
393 return false;
394 }
395 // Check synchronisation.
396 if (inode - 1 != (int)m_nodes.size()) {
397 std::cerr << m_className << "::Initialise:\n"
398 << " Synchronisation lost on file " << nlist << " (line "
399 << il << ").\n"
400 << " Node: " << inode << " (expected " << m_nodes.size()
401 << "), (x,y,z) = (" << xnode << ", " << ynode << ", " << znode
402 << ")\n";
403 ok = false;
404 break;
405 }
406 Node node;
407 // Store the point coordinates
408 node.x = xnode * funit;
409 node.y = ynode * funit;
410 node.z = znode * funit;
411 m_nodes.push_back(std::move(node));
412 }
413 // Close the file
414 fnlist.close();
415 if (!ok) return false;
416
417 // Tell how many lines read
418 std::cout << " Read " << m_nodes.size() << " nodes from file "
419 << nlist << ".\n";
420 // Check number of nodes
421 if ((int)m_nodes.size() != highestnode) {
422 std::cerr << m_className << "::Initialise:\n"
423 << " Number of nodes read (" << m_nodes.size()
424 << ") on " << nlist << "\n"
425 << " does not match element list (" << highestnode << ").\n";
426 return false;
427 }
428 if (!LoadPotentials(prnsol, m_pot)) return false;
429 // Set the ready flag.
430 m_ready = true;
431 Prepare();
432 return true;
433}
Garfield::ComponentFieldMap::PrintMaterials
void PrintMaterials()
List all currently defined materials.
Definition ComponentFieldMap.cc:511
Garfield::ComponentFieldMap::SetDefaultDriftMedium
bool SetDefaultDriftMedium()
Find lowest epsilon, check for eps = 0, set default drift media flags.
Definition ComponentFieldMap.cc:755
Garfield::ComponentFieldMap::ReadDouble
static double ReadDouble(char *token, double def, bool &error)
Definition ComponentFieldMap.cc:2660
Garfield::ComponentFieldMap::ScalingFactor
static double ScalingFactor(std::string unit)
Definition ComponentFieldMap.cc:2637
Garfield::ComponentFieldMap::ReadInteger
static int ReadInteger(char *token, int def, bool &error)
Definition ComponentFieldMap.cc:2651
Garfield::ComponentFieldMap::m_materials
std::vector< Material > m_materials
Definition ComponentFieldMap.hh:188
Garfield::ComponentFieldMap::PrintCouldNotOpen
void PrintCouldNotOpen(const std::string &header, const std::string &filename) const
Definition ComponentFieldMap.cc:2785
Garfield::ComponentFieldMap::m_elements
std::vector< Element > m_elements
Definition ComponentFieldMap.hh:154
Garfield::ComponentFieldMap::Reset
void Reset() override
Reset the component.
Definition ComponentFieldMap.cc:2099
Garfield::Component::m_debug
bool m_debug
Switch on/off debugging messages.
Definition Component.hh:371
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

◆ SetRangeZ()

void Garfield::ComponentAnsys121::SetRangeZ ( const double zmin,
const double zmax )

Set the limits of the active region along z.

Definition at line 541 of file ComponentAnsys121.cc.

541 {
542 if (fabs(zmax - zmin) <= 0.) {
543 std::cerr << m_className << "::SetRangeZ: Zero range is not permitted.\n";
544 return;
545 }
546 m_minBoundingBox[2] = m_mapmin[2] = std::min(zmin, zmax);
547 m_maxBoundingBox[2] = m_mapmax[2] = std::max(zmin, zmax);
548}
Garfield::ComponentFieldMap::m_mapmin
std::array< double, 3 > m_mapmin
Definition ComponentFieldMap.hh:209
Garfield::ComponentFieldMap::m_mapmax
std::array< double, 3 > m_mapmax
Definition ComponentFieldMap.hh:210
Heed::fabs
DoubleAc fabs(const DoubleAc &f)
Definition DoubleAc.h:615

◆ SetWeightingField()

bool Garfield::ComponentAnsys121::SetWeightingField ( const std::string & prnsol,
const std::string & label )

Definition at line 519 of file ComponentAnsys121.cc.

520 {
521 if (!m_ready) {
522 PrintNotReady("SetWeightingField");
523 std::cerr << " Weighting field cannot be added.\n";
524 return false;
525 }
526
527 std::cout << m_className << "::SetWeightingField:\n"
528 << " Loading field map for electrode " << label << ".\n";
529 // Check if a weighting field with the same label already exists.
530 if (m_wpot.count(label) > 0) {
531 std::cout << " Replacing existing weighting field.\n";
532 m_wpot[label].clear();
533 }
534
535 std::vector<double> pot(m_nodes.size(), 0.);
536 if (!LoadPotentials(prnsol, pot)) return false;
537 m_wpot[label] = std::move(pot);
538 return true;
539}
Garfield::ComponentFieldMap::m_wpot
std::map< std::string, std::vector< double > > m_wpot
Definition ComponentFieldMap.hh:174
Garfield::ComponentFieldMap::PrintNotReady
void PrintNotReady(const std::string &header) const
Definition ComponentFieldMap.cc:2780

Referenced by SetWeightingPotential().

◆ SetWeightingPotential()

bool Garfield::ComponentAnsys121::SetWeightingPotential ( const std::string & prnsol,
const std::string & label )
inline

Import weighting potentials.

Definition at line 30 of file ComponentAnsys121.hh.

31 {
32 return SetWeightingField(prnsol, label);
33 }
Garfield::ComponentAnsys121::SetWeightingField
bool SetWeightingField(const std::string &prnsol, const std::string &label)
Definition ComponentAnsys121.cc:519
The documentation for this class was generated from the following files: