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

#include <ComponentAnsys123.hh>

Inheritance diagram for Garfield::ComponentAnsys123:

Public Member Functions
	ComponentAnsys123 ()
	Constructor.

	~ComponentAnsys123 ()
	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)

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

void	EnablePeriodicityY (const bool on=true)
	Enable simple periodicity in the direction.

void	EnablePeriodicityZ (const bool on=true)
	Enable simple periodicity in the direction.

void	IsPeriodic (bool &perx, bool &pery, bool &perz)
	Return periodicity flags.

void	EnableMirrorPeriodicityX (const bool on=true)
	Enable mirror periodicity in the direction.

void	EnableMirrorPeriodicityY (const bool on=true)
	Enable mirror periodicity in the direction.

void	EnableMirrorPeriodicityZ (const bool on=true)
	Enable mirror periodicity in the direction.

void	IsMirrorPeriodic (bool &perx, bool &pery, bool &perz)
	Return mirror periodicity flags.

void	EnableAxialPeriodicityX (const bool on=true)
	Enable axial periodicity in the direction.

void	EnableAxialPeriodicityY (const bool on=true)
	Enable axial periodicity in the direction.

void	EnableAxialPeriodicityZ (const bool on=true)
	Enable axial periodicity in the direction.

void	IsAxiallyPeriodic (bool &perx, bool &pery, bool &perz)
	Return axial periodicity flags.

void	EnableRotationSymmetryX (const bool on=true)
	Enable rotation symmetry around the axis.

void	EnableRotationSymmetryY (const bool on=true)
	Enable rotation symmetry around the axis.

void	EnableRotationSymmetryZ (const bool on=true)
	Enable rotation symmetry around the 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 three-dimensional ANSYS field maps.

Definition at line 10 of file ComponentAnsys123.hh.

Constructor & Destructor Documentation

◆ ComponentAnsys123()

Garfield::ComponentAnsys123::ComponentAnsys123 ( )

Constructor.

Definition at line 10 of file ComponentAnsys123.cc.

10: ComponentFieldMap("Ansys123") {}

Garfield::ComponentFieldMap::ComponentFieldMap

ComponentFieldMap()=delete

Default constructor.

◆ ~ComponentAnsys123()

Garfield::ComponentAnsys123::~ComponentAnsys123 ( )

inline

Destructor.

Definition at line 15 of file ComponentAnsys123.hh.

15{}

Member Function Documentation

◆ Initialise()

bool Garfield::ComponentAnsys123::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

elist	name of the file containing the list of elements
nlist	name of the file containing the list of nodes
mplist	name of the file containing the list of materials
prnsol	name of the file containing the nodal solutions
unit	length unit

Definition at line 12 of file ComponentAnsys123.cc.

                                                          {
  Reset();
  // Keep track of the success.
  bool ok = true;
 
  // Buffer for reading
  constexpr int size = 100;
  char line[size];
 
  // Open the material list.
  std::ifstream fmplist(mplist);
  if (!fmplist) {
    PrintCouldNotOpen("Initialise", mplist);
    return false;
  }
 
  // Read the material list.
  long il = 0;
  unsigned int icurrmat = 0;
  bool readerror = false;
  while (fmplist.getline(line, size, '\n')) {
    il++;
    // Skip page feed.
    if (strcmp(line, "1") == 0) {
      for (size_t k = 0; k < 5; ++k) fmplist.getline(line, size, '\n');
      il += 5;
      continue;
    }
    // Split the line in tokens.
    char* token = strtok(line, " ");
    // Skip blank lines and headers.
    if (!token || strcmp(token, " ") == 0 || strcmp(token, "\n") == 0 ||
        strcmp(token, "TEMPERATURE") == 0 || strcmp(token, "PROPERTY=") == 0 ||
        int(token[0]) == 10 || int(token[0]) == 13) {
      continue;
    }
    // Read number of materials and initialise the list.
    if (strcmp(token, "LIST") == 0) {
      token = strtok(nullptr, " ");
      token = strtok(nullptr, " ");
      token = strtok(nullptr, " ");
      token = strtok(nullptr, " ");
      const int nMaterials = ReadInteger(token, -1, readerror);
      if (readerror || nMaterials < 0) {
        std::cerr << m_className << "::Initialise:\n"
                  << "    Error reading file " << mplist << " (line " << il
                  << ").\n";
        fmplist.close();
        return false;
      }
      m_materials.resize(nMaterials);
      for (auto& material : m_materials) {
        material.ohm = -1;
        material.eps = -1;
        material.medium = nullptr;
      }
      if (m_debug) {
        std::cout << m_className << "::Initialise: " << nMaterials 
                  << " materials.\n";
      }
    } else if (strcmp(token, "MATERIAL") == 0) {
      // Version 12 format: read material number
      token = strtok(nullptr, " ");
      token = strtok(nullptr, " ");
      const int imat = ReadInteger(token, -1, readerror);
      if (readerror || imat < 0) {
        std::cerr << m_className << "::Initialise:\n"
                  << "    Error reading file " << mplist << " (line " << il
                  << ").\n";
        fmplist.close();
        return false;
      }
      icurrmat = imat;
    } else if (strcmp(token, "TEMP") == 0) {
      // Version 12 format: read property tag and value
      token = strtok(nullptr, " ");
      int itype = 0;
      if (strncmp(token, "PERX", 4) == 0) {
        itype = 1;
      } else if (strncmp(token, "RSVX", 4) == 0) {
        itype = 2;
      } else {
        std::cerr << m_className << "::Initialise:\n"
                  << "    Unknown material property flag " << token << "\n"
                  << "    in material properties file " << mplist << " (line "
                  << il << ").\n";
        ok = false;
      }
      fmplist.getline(line, size, '\n');
      il++;
      token = nullptr;
      token = strtok(line, " ");
      if (icurrmat < 1 || icurrmat > m_materials.size()) {
        std::cerr << m_className << "::Initialise:\n"
                  << "    Found out-of-range current material index "
                  << icurrmat << "\n"
                  << "    in material properties file " << mplist << ".\n";
        ok = false;
        readerror = false;
      } else if (itype == 1) {
        m_materials[icurrmat - 1].eps = ReadDouble(token, -1, readerror);
      } else if (itype == 2) {
        m_materials[icurrmat - 1].ohm = ReadDouble(token, -1, readerror);
      }
      if (readerror) {
        std::cerr << m_className << "::Initialise:\n"
                  << "    Error reading file " << mplist << " (line " << il
                  << ").\n";
        fmplist.close();
        return false;
      }
    } else if (strcmp(token, "PROPERTY") == 0) {
      // Version 11 format
      token = strtok(nullptr, " ");
      token = strtok(nullptr, " ");
      int itype = 0;
      if (strcmp(token, "PERX") == 0) {
        itype = 1;
      } else if (strcmp(token, "RSVX") == 0) {
        itype = 2;
      } else {
        std::cerr << m_className << "::Initialise:\n"
                  << "    Unknown material property flag " << token << "\n"
                  << "    in material properties file " << mplist << " (line "
                  << il << ").\n";
        ok = false;
      }
      token = strtok(nullptr, " ");
      token = strtok(nullptr, " ");
      int imat = ReadInteger(token, -1, readerror);
      if (readerror) {
        std::cerr << m_className << "::Initialise:\n"
                  << "    Error reading file " << mplist << " (line " << il
                  << ").\n";
        fmplist.close();
        return false;
      } else if (imat < 1 || imat > (int)m_materials.size()) {
        std::cerr << m_className << "::Initialise:\n"
                  << "    Found out-of-range material index " << imat << "\n"
                  << "    in material properties file " << mplist << ".\n";
        ok = false;
      } else {
        fmplist.getline(line, size, '\n');
        il++;
        fmplist.getline(line, size, '\n');
        il++;
        token = nullptr;
        token = strtok(line, " ");
        token = strtok(nullptr, " ");
        if (itype == 1) {
          m_materials[imat - 1].eps = ReadDouble(token, -1, readerror);
        } else if (itype == 2) {
          m_materials[imat - 1].ohm = ReadDouble(token, -1, readerror);
        }
        if (readerror) {
          std::cerr << m_className << "::Initialise:\n"
                    << "    Error reading file " << mplist << " (line " << il
                    << ").\n";
          fmplist.close();
          return false;
        }
      }
    }
  }
  // Close the file
  fmplist.close();
 
  // Find lowest epsilon, check for eps = 0, set default drift medium.
  if (!SetDefaultDriftMedium()) ok = false;
 
  // Tell how many lines read
  std::cout << m_className << "::Initialise:\n"
            << "    Read properties of " << m_materials.size()
            << " materials from file " << mplist << ".\n";
  if (m_debug) PrintMaterials();
 
  // Open the element list
  std::ifstream felist(elist);
  if (!felist) {
    PrintCouldNotOpen("Initialise", elist);
    return false;
  }
 
  // Read the element list.
  int nbackground = 0;
  il = 0;
  int highestnode = 0;
  while (felist.getline(line, size, '\n')) {
    il++;
    // Skip page feed.
    if (strcmp(line, "1") == 0) {
      for (size_t k = 0; k < 5; ++k) felist.getline(line, size, '\n');
      il += 5;
      continue;
    }
    // Skip page feed if Ansys > v15.x
    if (strstr(line, "***") != nullptr) {
      for (size_t k = 0; k < 3; ++k) felist.getline(line, size, '\n');
      il += 3;
      continue;
    }
    // Split the line in tokens.
    char* token = strtok(line, " ");
    // Skip blank lines and headers.
    if (!token || strcmp(token, " ") == 0 || strcmp(token, "\n") == 0 ||
        int(token[0]) == 10 || int(token[0]) == 13 ||
        strcmp(token, "LIST") == 0 || strcmp(token, "ELEM") == 0) {
      continue;
    }
    // Read the element.
    int ielem = ReadInteger(token, -1, readerror);
    token = strtok(nullptr, " ");
    int imat = ReadInteger(token, -1, readerror);
    token = strtok(nullptr, " ");
    token = strtok(nullptr, " ");
    token = strtok(nullptr, " ");
    token = strtok(nullptr, " ");
    std::vector<int> inode;
    for (size_t k = 0; k < 8; ++k) {
      token = strtok(nullptr, " ");
      const int in = ReadInteger(token, -1, readerror);
      if (!readerror) inode.push_back(in);
    }
    if (!felist.getline(line, size, '\n')) {
      std::cerr << m_className << "::Initialise:\n"
                << "    Error reading element " << ielem << ".\n";
      ok = false;
      break;
    }
    ++il;
    token = strtok(line, " ");
    const int in8 = ReadInteger(token, -1, readerror);
    if (!readerror) inode.push_back(in8);
    token = strtok(nullptr, " ");
    const int in9 = ReadInteger(token, -1, readerror);
    if (!readerror) inode.push_back(in9);
 
    if (inode.size() != 10) {
      std::cerr << m_className << "::Initialise:\n"
                << "    Error reading file " << elist << " (line " 
                << il << ").\n"
                << "    Read " << inode.size() << " node indices for element " 
                << ielem << " (expected 10).\n";
      ok = false;
      break;
    } 
    // Check synchronisation.
    if (ielem - 1 != (int)m_elements.size() + nbackground) {
      std::cerr << m_className << "::Initialise:\n"
                << "    Synchronisation lost on file " << elist << " (line "
                << il << ").\n"
                << "    Element: " << ielem << " (expected " 
                << m_elements.size() << ").\n";
      ok = false;
      break;
    }
 
    // Check the material number and ensure that epsilon is non-negative
    if (imat < 1 || imat > (int)m_materials.size()) {
      std::cerr << m_className << "::Initialise:\n"
                << "    Out-of-range material number on file " << elist
                << " (line " << il << ").\n"
                << "    Element: " << ielem << ", material: " << imat << ".\n";
      ok = false;
      break;
    }
    if (m_materials[imat - 1].eps < 0) {
      std::cerr << m_className << "::Initialise:\n"
                << "    Element " << ielem << " in " << elist << "\n"
                << "    uses material " << imat << " which does not have\n"
                << "    a positive permittivity in " << mplist << ".\n";
      ok = false;
      break;
    }
 
    // Check the node numbers.
    bool degenerate = false;
    for (size_t k = 0; k < 10; ++k) {
      if (inode[k] < 1) { 
        std::cerr << m_className << "::Initialise:\n"
                  << "    Found a node number < 1 in " << elist << " (line "
                  << il << ").\n"
                  << "    Element: " << ielem << ", material: " << imat << ".\n";
        ok = false;
      }
      if (inode[k] > highestnode) highestnode = inode[k];
      for (size_t kk = k + 1; kk < 10; ++kk) {
        if (inode[k] == inode[kk]) degenerate = true;
      }
    }
    if (!ok) break;
 
    // Skip elements in conductors.
    if (m_deleteBackground && m_materials[imat - 1].ohm == 0) {
      nbackground++;
      continue;
    }
 
    // These elements must not be degenerate.
    if (degenerate) {
      std::cerr << m_className << "::Initialise:\n"
                << "    Element " << ielem << " of file " << elist
                << " is degenerate,\n"
                << "    no such elements allowed in this type of map.\n";
      ok = false;
      break;
    }
    Element element;
    // Store the material reference.
    element.matmap = imat - 1;
    // Store the node references.
    element.emap[0] = inode[0] - 1;
    element.emap[1] = inode[1] - 1;
    element.emap[2] = inode[2] - 1;
    element.emap[3] = inode[3] - 1;
    element.emap[4] = inode[4] - 1;
    element.emap[7] = inode[5] - 1;
    element.emap[5] = inode[6] - 1;
    element.emap[6] = inode[7] - 1;
    element.emap[8] = inode[8] - 1;
    element.emap[9] = inode[9] - 1;
    m_elements.push_back(std::move(element));
  }
  // Close the file
  felist.close();
  if (!ok) return false;
 
  if (m_elements.empty()) {
    std::cerr << m_className << "::Initialise:\n"
              << "    Found no valid elements in file " << elist << ".\n";
    return false;
  }
  m_degenerate.assign(m_elements.size(), false);
 
  // Tell how many lines read.
  std::cout << "    Read " << m_elements.size() << " elements from file "
            << elist << ".\n"
            << "    Highest node number: " << highestnode << "\n"
            << "    Background elements skipped: " << nbackground << "\n";
  // Check the value of the unit
  double funit = ScalingFactor(unit);
  if (funit <= 0.) {
    std::cerr << m_className << "::Initialise:\n"
              << "    Unknown length unit " << unit << ". Will use cm.\n";
    funit = 1.0;
  }
  if (m_debug) {
    std::cout << m_className << ":Initialise: Unit scaling factor = " 
              << funit << ".\n";
  }
 
  // Open the node list
  std::ifstream fnlist(nlist);
  if (!fnlist) {
    PrintCouldNotOpen("Initialise", nlist);
    return false;
  }
 
  // Read the node list.
  il = 0;
  while (fnlist.getline(line, size, '\n')) {
    il++;
    // Skip page feed
    if (strcmp(line, "1") == 0) {
      for (size_t k = 0; k < 5; ++k) fnlist.getline(line, size, '\n');
      il += 5;
      continue;
    }
    // Skip page feed if Ansys > v15.x
    if (strstr(line, "***") != nullptr) {
      for (size_t k = 0; k < 3; ++k) fnlist.getline(line, size, '\n');
      il += 3;
      continue;
    }
    // Split the line in tokens-
    char* token = strtok(line, " ");
    // Skip blank lines and headers.
    if (!token || strcmp(token, " ") == 0 || strcmp(token, "\n") == 0 ||
        int(token[0]) == 10 || int(token[0]) == 13 ||
        strcmp(token, "LIST") == 0 || strcmp(token, "NODE") == 0 ||
        strcmp(token, "SORT") == 0) {
      continue;
    }
    // Read the node.
    int inode = ReadInteger(token, -1, readerror);
    token = strtok(nullptr, " ");
    double xnode = ReadDouble(token, -1, readerror);
    token = strtok(nullptr, " ");
    double ynode = ReadDouble(token, -1, readerror);
    token = strtok(nullptr, " ");
    double znode = ReadDouble(token, -1, readerror);
    // Check syntax.
    if (readerror) {
      std::cerr << m_className << "::Initialise:\n"
                << "    Error reading file " << nlist << " (line " << il
                << ").\n";
      fnlist.close();
      return false;
    }
    // Check synchronisation.
    if (inode - 1 != (int)m_nodes.size()) {
      std::cerr << m_className << "::Initialise:\n"
                << "    Synchronisation lost on file " << nlist << " (line "
                << il << ").\n"
                << "    Node: " << inode << " (expected " << m_nodes.size()
                << "), (x,y,z) = (" << xnode << ", " << ynode << ", " << znode
                << ")\n";
      ok = false;
      break;
    }
    // Store the point coordinates
    Node node;
    node.x = xnode * funit;
    node.y = ynode * funit;
    node.z = znode * funit;
    m_nodes.push_back(std::move(node));
  }
  // Close the file.
  fnlist.close();
  if (!ok) return false;
 
  // Tell how many lines read.
  std::cout << "    Read " << m_nodes.size() << " nodes from file " 
            << nlist << ".\n";
  // Check number of nodes
  if ((int)m_nodes.size() != highestnode) {
    std::cerr << m_className << "::Initialise:\n"
              << "    Number of nodes read (" << m_nodes.size() << ") on " << nlist
              << "\n"
              << "    does not match element list (" << highestnode << ").\n";
    return false;
  }
 
  if (!LoadPotentials(prnsol, m_pot)) return false;
 
  m_ready = true;
  Prepare();
  return true;
}

◆ SetWeightingField()

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

Definition at line 544 of file ComponentAnsys123.cc.

                                                                  {
  if (!m_ready) {
    PrintNotReady("SetWeightingField");
    std::cerr << "    Weighting field cannot be added.\n";
    return false;
  }
 
  std::cout << m_className << "::SetWeightingField:\n"
            << "    Loading field map for electrode " << label << ".\n";
  // Check if a weighting field with the same label already exists.
  if (m_wpot.count(label) > 0) {
    std::cout << "    Replacing existing weighting field.\n";
    m_wpot[label].clear();
  }
 
  std::vector<double> pot(m_nodes.size(), 0.);
  if (!LoadPotentials(prnsol, pot)) return false;
  m_wpot[label] = std::move(pot);
  return true;
}

Referenced by SetWeightingPotential().

◆ SetWeightingPotential()

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

inline

Import weighting potentials.

Definition at line 31 of file ComponentAnsys123.hh.

                                                     {
    return SetWeightingField(prnsol, label);
  } 

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

Public Member Functions

Additional Inherited Members