Garfield::SolidExtrusion Class Reference

Extrusion. More...

#include <SolidExtrusion.hh>

Inheritance diagram for Garfield::SolidExtrusion:

Public Member Functions
	SolidExtrusion (const double lz, const std::vector< double > &xp, const std::vector< double > &yp)
	Constructor from half-length and profile.
	SolidExtrusion (const double lz, const std::vector< double > &xp, const std::vector< double > &yp, const double cx, const double cy, const double cz, const double dx, const double dy, const double dz)
	Constructor from half-length, profile, offset and orientation.
	~SolidExtrusion ()
	Destructor.
bool	IsInside (const double x, const double y, const double z, const bool tesselated) const override
bool	GetBoundingBox (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) const override
	Return the bounding box of the solid.
bool	IsExtrusion () const override
	Return true if the solid is an extrusion.
double	GetHalfLengthZ () const override
	Return the half-length along z.
bool	GetProfile (std::vector< double > &xp, std::vector< double > &yp) const override
	Get the vertices defining an extrusion.
void	SetHalfLengthZ (const double lz)
	Set the half-length of the extrusion.
void	SetProfile (const std::vector< double > &xp, const std::vector< double > &yp)
	Set the coordinates of the extrusion profile.
void	SetTopLid (const bool closed)
	Request the extrusion to be closed with a lid at +z.
void	SetBottomLid (const bool closed)
	Request the extrusion to be closed with a lid at -z.
bool	SolidPanels (std::vector< Panel > &panels) override
	Retrieve the surface panels of the solid.
void	SetDiscretisationLevel (const double dis) override
	Set the discretisation level (for all panels).
double	GetDiscretisationLevel (const Panel &panel) override
	Retrieve the discretisation level of a panel.
void	Cut (const double x0, const double y0, const double z0, const double xn, const double yn, const double zn, std::vector< Panel > &panels) override
Public Member Functions inherited from Garfield::Solid
	Solid ()=delete
	Default constructor.
	Solid (const double cx, const double cy, const double cz, const std::string &name)
	Constructor.
virtual	~Solid ()
	Destructor.
virtual bool	IsInside (const double x, const double y, const double z, const bool tesselated=false) const =0
virtual bool	GetBoundingBox (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) const =0
	Return the bounding box of the solid.
virtual bool	IsBox () const
	Return true if the solid is a box.
virtual bool	IsTube () const
	Return true if the solid is a tube.
virtual bool	IsSphere () const
	Return true if the solid is a sphere.
virtual bool	IsHole () const
	Return true if the solid is a hole.
virtual bool	IsRidge () const
	Return true if the solid is a ridge.
virtual bool	IsExtrusion () const
	Return true if the solid is an extrusion.
virtual bool	IsWire () const
	Return true if the solid is a wire.
void	SetLabel (const std::string &label)
	Set a label.
std::string	GetLabel () const
	Return the label.
bool	GetCentre (double &x, double &y, double &z) const
	Retrieve the centre point of the solid.
bool	GetDirection (double &dx, double &dy, double &dz) const
	Retrieve the direction vector.
bool	GetOrientation (double &ctheta, double &stheta, double &cphi, double &sphi) const
	Retrieve the orientation (azimuthal and polar angles) of the solid.
virtual double	GetHalfLengthX () const
	Return the half-length along x.
virtual double	GetHalfLengthY () const
	Return the half-length along y.
virtual double	GetHalfLengthZ () const
	Return the half-length along z.
virtual double	GetInnerRadius () const
	Return the inner radius.
virtual double	GetOuterRadius () const
	Return the outer radius.
virtual double	GetRadius () const
	Return the radius.
virtual double	GetLowerRadius () const
	Return the lower radius (of a hole).
virtual double	GetUpperRadius () const
	Return the upper radius (of a hole).
virtual double	GetRidgeOffset () const
	Return the x-offset of a ridge.
virtual double	GetRidgeHeight () const
	Return the height of a ridge.
virtual bool	GetProfile (std::vector< double > &xv, std::vector< double > &yv) const
	Get the vertices defining an extrusion.
unsigned int	GetId () const
	Get the ID of the solid.
virtual bool	SolidPanels (std::vector< Panel > &panels)=0
	Retrieve the surface panels of the solid.
virtual void	SetDiscretisationLevel (const double dis)=0
	Set the discretisation level (for all panels).
virtual double	GetDiscretisationLevel (const Panel &panel)=0
	Retrieve the discretisation level of a panel.
virtual void	Cut (const double x0, const double y0, const double z0, const double xn, const double yn, const double zn, std::vector< Panel > &panels)=0
void	SetBoundaryPotential (const double v)
	Apply Dirichlet boundary conditions (fixed voltage).
void	SetBoundaryChargeDensity (const double q)
	Apply fixed-charge boundary conditions.
void	SetBoundaryFloat ()
	Make the potential at the surface of the solid floating.
void	SetBoundaryDielectric ()
	Make the surfaces of the solid dielectric-dielectric interfaces.
void	SetBoundaryParallelField ()
void	SetBoundaryPerpendicularField ()
BoundaryCondition	GetBoundaryConditionType () const
	Retrieve the type of boundary condition.
double	GetBoundaryPotential () const
	Retrieve the potential.
double	GetBoundaryChargeDensity () const
	Retrieve the surface charge density.
void	EnableDebugging (const bool on=true)
	Switch debugging messages on/off.
void	SetColour (const int col)
	Set the colour of the solid.
int	GetColour () const
	Get the colour of the solid.

Additional Inherited Members
Public Types inherited from Garfield::Solid
enum	BoundaryCondition {   Unknown = 0 , Voltage , Charge , Float ,   Dielectric , DielectricCharge , ParallelField , PerpendicularField }
Static Public Member Functions inherited from Garfield::Solid
static bool	Intersect (const double x1, const double y1, const double z1, const double x2, const double y2, const double z2, const double x0, const double y0, const double z0, const double a, const double b, const double c, double &xc, double &yc, double &zc)
Protected Member Functions inherited from Garfield::Solid
void	ToLocal (const double x, const double y, const double z, double &u, double &v, double &w) const
void	ToGlobal (const double u, const double v, const double w, double &x, double &y, double &z) const
void	VectorToLocal (const double x, const double y, const double z, double &u, double &v, double &w)
	Transform a vector from global to local coordinates.
void	SetDirection (const double dx, const double dy, const double dz)
Protected Attributes inherited from Garfield::Solid
double	m_cX = 0.
	Centre of the solid.
double	m_cY = 0.
double	m_cZ = 0.
double	m_dX = 0.
	Direction vector.
double	m_dY = 0.
double	m_dZ = 1.
double	m_cPhi = 1.
	Azimuthal angle.
double	m_sPhi = 0.
double	m_cTheta = 1.
	Polar angle.
double	m_sTheta = 0.
std::string	m_className = "Solid"
	Class name.
std::string	m_label = ""
	Label.
bool	m_debug = false
	Debug flag.
BoundaryCondition	m_bctype = Unknown
	Type of boundary condition.
double	m_volt = 0.
	Potential at the surface.
double	m_charge = 0.
	Surface charge density.
double	m_eps = 0.
	Dielectric constant.
int	m_colour = -1
	Colour.

Detailed Description

Extrusion.

Definition at line 10 of file SolidExtrusion.hh.

Constructor & Destructor Documentation

SolidExtrusion() [1/2]

Garfield::SolidExtrusion::SolidExtrusion	(	const double	lz,
		const std::vector< double > &	xp,
		const std::vector< double > &	yp
	)

Constructor from half-length and profile.

Definition at line 10 of file SolidExtrusion.cc.

    : Solid(0, 0, 0, "SolidExtrusion"), m_lZ(lz) {
  SetProfile(xp, yp);
}

SolidExtrusion() [2/2]

Garfield::SolidExtrusion::SolidExtrusion	(	const double	lz,
		const std::vector< double > &	xp,
		const std::vector< double > &	yp,
		const double	cx,
		const double	cy,
		const double	cz,
		const double	dx,
		const double	dy,
		const double	dz
	)

Constructor from half-length, profile, offset and orientation.

Definition at line 17 of file SolidExtrusion.cc.

    : SolidExtrusion(lz, xp, yp) {
  m_cX = cx;
  m_cY = cy;
  m_cZ = cz;
  SetDirection(dx, dy, dz);
}

~SolidExtrusion()

Garfield::SolidExtrusion::~SolidExtrusion ( )

inline

Destructor.

Definition at line 21 of file SolidExtrusion.hh.

{}

Member Function Documentation

Cut()

void Garfield::SolidExtrusion::Cut ( const double  x0, const double  y0, const double  z0, const double  xn, const double  yn, const double  zn, std::vector< Panel > &  panels  )

overridevirtual

Implements Garfield::Solid.

Definition at line 235 of file SolidExtrusion.cc.

                                                   {
 
  //-----------------------------------------------------------------------
  //   PLAEXC - Cuts extrusion with a plane.
  //-----------------------------------------------------------------------
 
  std::vector<double> xv;
  std::vector<double> yv;
  std::vector<double> zv;
  const unsigned int np = m_xp.size(); 
  // Go through the lines of the top lid, first point.
  double x1, y1, z1;
  ToGlobal(m_xp.back(), m_yp.back(), m_lZ, x1, y1, z1);
  // Loop over the points.
  for (unsigned int i = 0; i < np; ++i) { 
    double x2, y2, z2;
    ToGlobal(m_xp[i], m_yp[i], m_lZ, x2, y2, z2);
    // Cut with the plane.
    double xc, yc, zc;
    if (Intersect(x1, y1, z1, x2, y2, z2, 
                  x0, y0, z0, xn, yn, zn, xc, yc, zc)) {
      xv.push_back(xc);
      yv.push_back(yc);
      zv.push_back(zc);
    }
    // Shift the coordinates.
    x1 = x2;
    y1 = y2;
    z1 = z2;
  }
 
  if (m_lZ > 0.) {
    // Go through the lines of the bottom lid, first point.
    ToGlobal(m_xp.back(), m_yp.back(), -m_lZ, x1, y1, z1);
    // Loop over the points.
    for (unsigned int i = 0; i < np; ++i) {
      double x2, y2, z2;
      ToGlobal(m_xp[i], m_yp[i], -m_lZ, x2, y2, z2);
      double xc, yc, zc;
      if (Intersect(x1, y1, z1, x2, y2, z2,
                    x0, y0, z0, xn, yn, zn, xc, yc, zc)) {
        xv.push_back(xc);
        yv.push_back(yc);
        zv.push_back(zc);
      }
      // Shift the coordinates.
      x1 = x2;
      y1 = y2;
      z1 = z2;
    }
    // Go through the ribs.
    for (unsigned int i = 0; i < np; ++i) {
      // Bottom and top of the line along the axis of the extrusion.
      ToGlobal(m_xp[i], m_yp[i], +m_lZ, x1, y1, z1);
      double x2, y2, z2;
      ToGlobal(m_xp[i], m_yp[i], -m_lZ, x2, y2, z2);
      double xc, yc, zc;
      if (Intersect(x1, y1, z1, x2, y2, z2, 
                    x0, y0, z0, xn, yn, zn, xc, yc, zc)) {
        xv.push_back(xc);
        yv.push_back(yc);
        zv.push_back(zc);
      }
    }
  }
  // Get rid of butterflies.
  Polygon::EliminateButterflies(xv, yv, zv);
  if (xv.size() >= 3) {
    Panel panel;
    panel.a = xn;
    panel.b = yn;
    panel.c = zn;
    panel.xv = xv;
    panel.yv = yv;
    panel.zv = zv;
    panel.colour = m_colour;
    panel.volume = GetId();
    panels.push_back(std::move(panel));
  }
}

GetBoundingBox()

bool Garfield::SolidExtrusion::GetBoundingBox ( double &  xmin, double &  ymin, double &  zmin, double &  xmax, double &  ymax, double &  zmax  ) const

overridevirtual

Return the bounding box of the solid.

Implements Garfield::Solid.

Definition at line 44 of file SolidExtrusion.cc.

                                                                              {
 
  if (m_xp.empty()) return false;
  const double x0 = *std::min_element(m_xp.begin(), m_xp.end());
  const double x1 = *std::max_element(m_xp.begin(), m_xp.end());
  const double y0 = *std::min_element(m_yp.begin(), m_yp.end());
  const double y1 = *std::max_element(m_yp.begin(), m_yp.end());
  // Take the margins wide.
  const double r = std::max({fabs(x0), fabs(y0), fabs(x1), fabs(y1)});
  const double d = sqrt(r * r + m_lZ * m_lZ); 
  xmin = m_cX - d;
  xmax = m_cX + d;
  ymin = m_cY - d;
  ymax = m_cY + d;
  zmin = m_cZ - d;
  zmax = m_cZ + d;
  return true;
}

GetDiscretisationLevel()

double Garfield::SolidExtrusion::GetDiscretisationLevel ( const Panel &  panel )

overridevirtual

Retrieve the discretisation level of a panel.

Implements Garfield::Solid.

Definition at line 221 of file SolidExtrusion.cc.

                                                                {
 
  // Transform the normal vector to local coordinates.
  double u = 0., v = 0., w = 0.;
  VectorToLocal(panel.a, panel.b, panel.c, u, v, w);
  // Identify the vector.
  if (w > std::max(fabs(u), fabs(v))) {
    return m_dis[0];
  } else if (w < -std::max(fabs(u), fabs(v))) {
    return m_dis[1];
  }
  return m_dis[2];
}

GetHalfLengthZ()

double Garfield::SolidExtrusion::GetHalfLengthZ ( ) const

inlineoverridevirtual

Return the half-length along z.

Reimplemented from Garfield::Solid.

Definition at line 29 of file SolidExtrusion.hh.

{ return m_lZ; }

GetProfile()

bool Garfield::SolidExtrusion::GetProfile ( std::vector< double > &  xv, std::vector< double > &  yv  ) const

inlineoverridevirtual

Get the vertices defining an extrusion.

Reimplemented from Garfield::Solid.

Definition at line 30 of file SolidExtrusion.hh.

                                                        {
    xp = m_xp;
    yp = m_yp;
    return !m_xp.empty();
  }

IsExtrusion()

bool Garfield::SolidExtrusion::IsExtrusion ( ) const

inlineoverridevirtual

Return true if the solid is an extrusion.

Reimplemented from Garfield::Solid.

Definition at line 27 of file SolidExtrusion.hh.

{ return true; }

IsInside()

bool Garfield::SolidExtrusion::IsInside ( const double  x, const double  y, const double  z, const bool  tesselated  ) const

overridevirtual

Check whether a given point is inside the solid. If requested, use the tesselated approximation of the solid (if applicable).

Implements Garfield::Solid.

Definition at line 31 of file SolidExtrusion.cc.

                                                  {
 
  if (m_xp.empty()) return false;
  // Transform the point to local coordinates.
  double u = x, v = y, w = z;
  ToLocal(x, y, z, u, v, w);
  if (fabs(w) > m_lZ) return false;
  bool inside = false, edge = false;
  Polygon::Inside(m_xp, m_yp, u, v, inside, edge);
  return inside;
}

SetBottomLid()

void Garfield::SolidExtrusion::SetBottomLid ( const bool  closed )

inline

Request the extrusion to be closed with a lid at -z.

Definition at line 44 of file SolidExtrusion.hh.

{ m_botlid = closed; }

SetDiscretisationLevel()

void Garfield::SolidExtrusion::SetDiscretisationLevel ( const double  dis )

inlineoverridevirtual

Set the discretisation level (for all panels).

Implements Garfield::Solid.

Definition at line 47 of file SolidExtrusion.hh.

                                                         {
    m_dis.fill(dis);
  }

SetHalfLengthZ()

void Garfield::SolidExtrusion::SetHalfLengthZ

(

const double

lz

)

Set the half-length of the extrusion.

Definition at line 64 of file SolidExtrusion.cc.

                                                   {
  if (lz > 0.) {
    m_lZ = lz;
  } else {
    std::cerr << "SolidExtrusion::SetHalfLengthZ: Half-length must be > 0.\n";
  }
}

SetProfile()

void Garfield::SolidExtrusion::SetProfile	(	const std::vector< double > &	xp,
		const std::vector< double > &	yp
	)

Set the coordinates of the extrusion profile.

Definition at line 72 of file SolidExtrusion.cc.

                                                             {
 
  if (xp.size() != yp.size()) {
    std::cerr << "SolidExtrusion::SetProfile:\n"
              << "    Mismatch between number of x and y coordinates.\n";
    return;
  }
  const auto np = xp.size();
  if (np < 3) {
    std::cerr << "SolidExtrusion::SetProfile: Too few points; rejected.\n";
    return;
  }
  if (!Polygon::NonTrivial(xp, yp)) {
    std::cerr << "SolidExtrusion::SetProfile: Not a valid polygon.\n";
    return;
  }
  const auto it = std::max_element(xp.begin(), xp.end());
  const unsigned int i0 = std::distance(xp.begin(), it);
  const unsigned int i1 = i0 < np - 1 ? i0 + 1 : 0;
  const unsigned int i2 = i1 < np - 1 ? i1 + 1 : 0; 
  const double det = (xp[i1] - xp[i0]) * (yp[i2] - yp[i0]) -
                     (xp[i2] - xp[i0]) * (yp[i1] - yp[i0]);
  if (det < 0.) {
    m_clockwise = true;
  } else if (det > 0.) {
    m_clockwise = false;
  } else {
    std::cerr << "SolidExtrusion::SetProfile:\n"
              << "    Unable to determine profile orientation;" 
              << "    assuming it is clockwise.\n";
    m_clockwise = true;
  }
  m_xp = xp;
  m_yp = yp;
}

Referenced by SolidExtrusion().

SetTopLid()

void Garfield::SolidExtrusion::SetTopLid ( const bool  closed )

inline

Request the extrusion to be closed with a lid at +z.

Definition at line 42 of file SolidExtrusion.hh.

{ m_toplid = closed; }

SolidPanels()

bool Garfield::SolidExtrusion::SolidPanels ( std::vector< Panel > &  panels )

overridevirtual

Retrieve the surface panels of the solid.

Implements Garfield::Solid.

Definition at line 109 of file SolidExtrusion.cc.

                                                         {
  // -----------------------------------------------------------------------
  //   PLAEXP - Generates a table of polygons for an extrusion.
  // -----------------------------------------------------------------------
  const auto id = GetId();
  const auto nPanels = panels.size();
  if (m_xp.empty()) {
    std::cerr << "SolidExtrusion::SolidPanels: Profile is not defined.\n";
    return false;
  }
  // Direction vector.
  const double fnorm = sqrt(m_dX * m_dX + m_dY * m_dY + m_dZ * m_dZ);
  if (fnorm <= 0) {
    std::cerr << "SolidExtrusion::SolidPanels:\n"
              << "    Zero norm direction vector; no panels generated.\n";
    return false;
  }
  const double a = m_dX / fnorm;
  const double b = m_dY / fnorm;
  const double c = m_dZ / fnorm;
  // Number of points
  const unsigned int np = m_xp.size();
  // Create the top lid.
  if (m_toplid) {
    Panel panel;
    panel.a = a;
    panel.b = b;
    panel.c = c;
    for (unsigned int i = 0; i < np; ++i) {
      // Rotate into place.
      double x, y, z;
      ToGlobal(m_xp[i], m_yp[i], m_lZ, x, y, z);
      panel.xv.push_back(x);
      panel.yv.push_back(y);
      panel.zv.push_back(z);
    }
    panel.colour = m_colour;
    panel.volume = id;
    panels.push_back(std::move(panel));
  }
  // Create the bottom lid.
  if (m_botlid) {
    Panel panel;
    panel.a = -a;
    panel.b = -b;
    panel.c = -c;
    for (unsigned int i = 0; i < np; ++i) {
      // Rotate into place.
      double x, y, z;
      ToGlobal(m_xp[i], m_yp[i], -m_lZ, x, y, z);
      panel.xv.push_back(x);
      panel.yv.push_back(y);
      panel.zv.push_back(z);
    }
    panel.colour = m_colour;
    panel.volume = id;
    panels.push_back(std::move(panel));
  }
  // Create the side panels.
  if (m_lZ > 0) {
    double x0, y0, z0;
    ToGlobal(m_xp.back(), m_yp.back(), -m_lZ, x0, y0, z0);
    double x1, y1, z1;
    ToGlobal(m_xp.back(), m_yp.back(), +m_lZ, x1, y1, z1);
    // Go around the extrusion.
    for (unsigned int i = 0; i < np; ++i) {
      // Bottom and top of the line along the axis of the extrusion.
      double x2, y2, z2;
      ToGlobal(m_xp[i], m_yp[i], +m_lZ, x2, y2, z2);
      double x3, y3, z3;
      ToGlobal(m_xp[i], m_yp[i], -m_lZ, x3, y3, z3);
      // Compute the normal vector.
      const unsigned int k = i == 0 ? np - 1 : i - 1;
      double xn = m_yp[k] - m_yp[i];
      double yn = m_xp[i] - m_xp[k];
      const double fn = sqrt(xn * xn + yn * yn);
      if (fn <= 0) {
        std::cerr << "SolidExtrusion::SolidPanels: Zero norm edge (warning).\n";
        continue;
      }
      if (m_clockwise) {
        xn = xn / fn;
        yn = yn / fn;
      } else {
        xn = -xn / fn;
        yn = -yn / fn;
      }
      Panel panel;
      panel.a = m_cPhi * m_cTheta * xn - m_sPhi * yn;
      panel.b = m_sPhi * m_cTheta * xn + m_cPhi * yn;
      panel.c = -m_sTheta * xn;
      panel.xv = {x0, x1, x2, x3};
      panel.yv = {y0, y1, y2, y3};
      panel.zv = {z0, z1, z2, z3};
      panel.colour = m_colour;
      panel.volume = id;
      panels.push_back(std::move(panel));
      // Shift the points.
      x0 = x3;
      y0 = y3;
      z0 = z3;
      x1 = x2;
      y1 = y2;
      z1 = z2;
    }
  }
  // Done, check panel count.
  std::cout << "SolidExtrusion::SolidPanels: " << panels.size() - nPanels
            << " panels.\n";
  return true;
}

---

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

• SolidExtrusion.hh
• SolidExtrusion.cc