Garfield::SolidRidge Class Reference

Triangular prism (Toblerone bar). More...

#include <SolidRidge.hh>

Inheritance diagram for Garfield::SolidRidge:

Public Member Functions
	SolidRidge (const double cx, const double cy, const double cz, const double lx, const double ly, const double hz, const double offsetx)
	Constructor from centre, half-lengths, height and x-offset.
	SolidRidge (const double cx, const double cy, const double cz, const double lx, const double ly, const double hz, const double offsetx, const double dx, const double dy, const double dz)
	Constructor from centre, half-lengths, height, x-offset and orientation.
	~SolidRidge ()
	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	IsRidge () const override
	Return true if the solid is a ridge.
void	SetHalfLengthX (const double lx)
	Set the half-length along x.
void	SetHalfLengthY (const double ly)
	Set the half-length along y.
void	SetRidgeHeight (const double hz)
	Set the height of the ridge.
void	SetRidgeOffset (const double dx)
	Set the x-offset of the ridge.
double	GetHalfLengthX () const override
	Return the half-length along x.
double	GetHalfLengthY () const override
	Return the half-length along y.
double	GetRidgeHeight () const override
	Return the height of a ridge.
double	GetRidgeOffset () const override
	Return the x-offset of a ridge.
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

Triangular prism (Toblerone bar).

Definition at line 10 of file SolidRidge.hh.

Constructor & Destructor Documentation

SolidRidge() [1/2]

Garfield::SolidRidge::SolidRidge	(	const double	cx,
		const double	cy,
		const double	cz,
		const double	lx,
		const double	ly,
		const double	hz,
		const double	offsetx
	)

Constructor from centre, half-lengths, height and x-offset.

Definition at line 10 of file SolidRidge.cc.

    : Solid(cx, cy, cz, "SolidRidge"),
      m_lX(lx), 
      m_lY(ly),
      m_hz(hz),
      m_hx(hx) {}

SolidRidge() [2/2]

Garfield::SolidRidge::SolidRidge	(	const double	cx,
		const double	cy,
		const double	cz,
		const double	lx,
		const double	ly,
		const double	hz,
		const double	offsetx,
		const double	dx,
		const double	dy,
		const double	dz
	)

Constructor from centre, half-lengths, height, x-offset and orientation.

Definition at line 19 of file SolidRidge.cc.

    : SolidRidge(cx, cy, cz, lx, ly, hz, hx) {
  SetDirection(dx, dy, dz);
}

~SolidRidge()

Garfield::SolidRidge::~SolidRidge ( )

inline

Destructor.

Definition at line 22 of file SolidRidge.hh.

{}

Member Function Documentation

Cut()

void Garfield::SolidRidge::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 195 of file SolidRidge.cc.

                                               {
  
  //-----------------------------------------------------------------------
  //   PLATBC - Cuts ridge with a plane.
  //-----------------------------------------------------------------------
 
  std::vector<double> xv;
  std::vector<double> yv;
  std::vector<double> zv;
  // Draw all 9 lines and cut.
  // The line (xmin,ymin,0) to (xmax,ymin,0).
  double x1, y1, z1;
  ToGlobal(-m_lX, -m_lY, 0., x1, y1, z1);
  double x2, y2, z2;
  ToGlobal(+m_lX, -m_lY, 0., 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);
  }
  // ... to (xmin,ymax,0).
  ToGlobal(-m_lX, +m_lY, 0., x2, y2, z2);
  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);
  }
  // ... to (xh,ymin,zh).
  ToGlobal(m_hx, -m_lY, m_hz, x2, y2, z2);
  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);
  }
  
  // The line (xmax,ymax,0) to (xmin,ymax,0).
  ToGlobal(+m_lX, +m_lY, 0., x1, y1, z1);
  ToGlobal(-m_lX, +m_lY, 0., x2, y2, z2);
  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);
  }
 
  // ... to (xmax,ymin,0).
  ToGlobal(+m_lX, -m_lY, 0., x2, y2, z2);
  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);
  }
 
  // ... to (xh,ymax,zh).
  ToGlobal(m_hx, +m_lY, m_hz, x2, y2, z2);
  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);
  }
 
  // The line (xmin,ymax,0) to (xh,ymax,zh).
  ToGlobal(-m_lX, +m_lY, 0., x1, y1, z1);
  ToGlobal(m_hx, +m_lY, m_hz, x2, y2, z2);
  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);
  }
 
  // The line (xh,ymax,zh) to (xh,ymin,zh)
  ToGlobal(m_hx, +m_lY, m_hz, x1, y1, z1);
  ToGlobal(m_hx, -m_lY, m_hz, x2, y2, z2);
  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);
  }
 
  // The line (xh,ymin,zh) to (xmax,ymin,0)
  ToGlobal(m_hx, -m_lY, m_hz, x1, y1, z1);
  ToGlobal(+m_lX, -m_lY, 0., x2, y2, z2);
  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::SolidRidge::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 SolidRidge.cc.

                                                                                {
  if (m_cTheta == 1. && m_cPhi == 1.) {
    xmin = m_cX - m_lX;
    xmax = m_cX + m_lX;
    ymin = m_cY - m_lY;
    ymax = m_cY + m_lY;
    zmin = m_cZ;
    zmax = m_cZ + m_hz;
    return true;
  }
 
  const double dd = sqrt(m_lX * m_lX + m_lY * m_lY + m_hz * m_hz);
  xmin = m_cX - dd;
  xmax = m_cX + dd;
  ymin = m_cY - dd;
  ymax = m_cY + dd;
  zmin = m_cZ - dd;
  zmax = m_cZ + dd;
  return true;
}

GetDiscretisationLevel()

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

overridevirtual

Retrieve the discretisation level of a panel.

Implements Garfield::Solid.

Definition at line 171 of file SolidRidge.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 (v > std::max(std::abs(u), std::abs(w))) {
    return m_dis[2];
  } else if (v < -std::max(std::abs(u), std::abs(w))) {
    return m_dis[3];
  } else if (w < -std::max(std::abs(u), std::abs(v))) {
    return m_dis[4];
  } else if (u > 0) {
    return m_dis[0];
  } else if (u < 0) {
    return m_dis[1];
  }
  if (m_debug) {
    std::cout << m_className << "::GetDiscretisationLevel:\n"
              << "    Found no match for the panel; return first value.\n";
  }
  return m_dis[0];
}

GetHalfLengthX()

double Garfield::SolidRidge::GetHalfLengthX ( ) const

inlineoverridevirtual

Return the half-length along x.

Reimplemented from Garfield::Solid.

Definition at line 39 of file SolidRidge.hh.

{ return m_lX; }

GetHalfLengthY()

double Garfield::SolidRidge::GetHalfLengthY ( ) const

inlineoverridevirtual

Return the half-length along y.

Reimplemented from Garfield::Solid.

Definition at line 40 of file SolidRidge.hh.

{ return m_lY; }

GetRidgeHeight()

double Garfield::SolidRidge::GetRidgeHeight ( ) const

inlineoverridevirtual

Return the height of a ridge.

Reimplemented from Garfield::Solid.

Definition at line 41 of file SolidRidge.hh.

{ return m_hz; }

GetRidgeOffset()

double Garfield::SolidRidge::GetRidgeOffset ( ) const

inlineoverridevirtual

Return the x-offset of a ridge.

Reimplemented from Garfield::Solid.

Definition at line 42 of file SolidRidge.hh.

{ return m_hx; }

IsInside()

bool Garfield::SolidRidge::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 27 of file SolidRidge.cc.

                                              {
  // Transform the point to local coordinates.
  double u = x, v = y, w = z;
  ToLocal(x, y, z, u, v, w);
 
  bool inside = true;
  if (fabs(u) > m_lX || fabs(v) > m_lY || w < 0. || w > m_hz) {
    inside = false;
  } else if (u >= m_hx &&  m_hz * u + (m_lX - m_hx) * v > m_hz * m_lX) {
    inside = false;
  } else if (u <= m_hx && -m_hz * u + (m_lX + m_hx) * v > m_hz * m_lX) {
    inside = false; 
  }
  return inside;
}

IsRidge()

bool Garfield::SolidRidge::IsRidge ( ) const

inlineoverridevirtual

Return true if the solid is a ridge.

Reimplemented from Garfield::Solid.

Definition at line 28 of file SolidRidge.hh.

{ return true; }

SetDiscretisationLevel()

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

inlineoverridevirtual

Set the discretisation level (for all panels).

Implements Garfield::Solid.

Definition at line 45 of file SolidRidge.hh.

                                                         {
    m_dis.fill(dis);
  }

SetHalfLengthX()

void Garfield::SolidRidge::SetHalfLengthX

(

const double

lx

)

Set the half-length along x.

Definition at line 66 of file SolidRidge.cc.

                                               {
  if (lx <= 0.) {
    std::cerr << "SolidRidge::SetHalfLengthX: Half-length must be > 0.\n";
    return;
  }
  m_lX = lx;
}

SetHalfLengthY()

void Garfield::SolidRidge::SetHalfLengthY

(

const double

ly

)

Set the half-length along y.

Definition at line 74 of file SolidRidge.cc.

                                               {
  if (ly <= 0.) {
    std::cerr << "SolidRidge::SetHalfLengthY: Half-length must be > 0.\n";
    return;
  }
  m_lY = ly;
}

SetRidgeHeight()

void Garfield::SolidRidge::SetRidgeHeight

(

const double

hz

)

Set the height of the ridge.

Definition at line 82 of file SolidRidge.cc.

                                               {
  if (hz <= 0.) {
    std::cerr << "SolidRidge::SetRidgeHeight: Height must be > 0.\n";
    return;
  }
  m_hz = hz;
}

SetRidgeOffset()

void Garfield::SolidRidge::SetRidgeOffset ( const double  dx )

inline

Set the x-offset of the ridge.

Definition at line 37 of file SolidRidge.hh.

{ m_hx = dx; }

SolidPanels()

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

overridevirtual

Retrieve the surface panels of the solid.

Implements Garfield::Solid.

Definition at line 90 of file SolidRidge.cc.

                                                     {
  const auto id = GetId();
  const unsigned int nPanels = panels.size();
  // Direction vector.
  const double fnorm = sqrt(m_dX * m_dX + m_dY * m_dY + m_dZ * m_dZ);
  if (fnorm <= 0) {
    std::cerr << "SolidRidge::SolidPanels:\n"
              << "    Zero norm direction vector; no panels generated.\n";
    return false;
  }
  double xv0, yv0, zv0;
  double xv1, yv1, zv1;
  double xv2, yv2, zv2;
  double xv3, yv3, zv3;
 
  // Draw the 5 sides of the ridge, start with the floor.
  ToGlobal(-m_lX, -m_lY, 0, xv0, yv0, zv0);
  ToGlobal(-m_lX, +m_lY, 0, xv1, yv1, zv1);
  ToGlobal(+m_lX, +m_lY, 0, xv2, yv2, zv2);
  ToGlobal(+m_lX, -m_lY, 0, xv3, yv3, zv3);
 
  Panel base;
  base.a = -m_cPhi * m_sTheta;
  base.b = -m_sPhi * m_sTheta;
  base.c = -m_cTheta;
  base.xv = {xv0, xv1, xv2, xv3};
  base.yv = {yv0, yv1, yv2, yv3};
  base.zv = {zv0, zv1, zv2, zv3};
  base.colour = m_colour;
  base.volume = id;
  panels.push_back(std::move(base));
 
  // Side triangles at y=ymin and y=ymax.
  for (unsigned int i = 0; i < 2; ++i) {
    const double y = i == 0 ? -m_lY : +m_lY;
    ToGlobal(-m_lX, y, 0, xv0, yv0, zv0);
    ToGlobal(+m_lX, y, 0, xv1, yv1, zv1);
    ToGlobal(m_hx, y, m_hz, xv2, yv2, zv2);
 
    const double a = i == 0 ? +m_sPhi : -m_sPhi;
    const double b = i == 0 ? -m_cPhi : +m_cPhi;
    Panel side;
    side.a = a;
    side.b = b;
    side.c = 0.;
    side.xv = {xv0, xv1, xv2};
    side.yv = {yv0, yv1, yv2};
    side.zv = {zv0, zv1, zv2};
    side.colour = m_colour;
    side.volume = id;
    panels.push_back(std::move(side));
  }
 
  // The roof, parts at +x and -x.
  for (unsigned int i = 0; i < 2; ++i) {
    const double x = i == 0 ? +m_lX : -m_lX;
    ToGlobal(x, -m_lY, 0, xv0, yv0, zv0);
    ToGlobal(x, +m_lY, 0, xv1, yv1, zv1);
    ToGlobal(m_hx, +m_lY, m_hz, xv2, yv2, zv2);
    ToGlobal(m_hx, -m_lY, m_hz, xv3, yv3, zv3);
    const double dx = i == 0 ? m_lX - m_hx : m_lX + m_hx; 
    const double s = sqrt(m_hz * m_hz + dx * dx);
    const double xroof = i == 0 ? m_hz / s : -m_hz / s;
    const double zroof = dx / s;
 
    Panel roof;
    roof.a = m_cPhi * m_cTheta * xroof + m_cPhi * m_sTheta * zroof;
    roof.b = m_sPhi * m_cTheta * xroof + m_sPhi * m_sTheta * zroof;
    roof.c = -m_sTheta * xroof + m_cTheta * zroof;
    roof.xv = {xv0, xv1, xv2, xv3};
    roof.yv = {yv0, yv1, yv2, yv3};
    roof.zv = {zv0, zv1, zv2, zv3};
    roof.colour = m_colour;
    roof.volume = id;
    panels.push_back(std::move(roof));
  }
  std::cout << "SolidRidge::SolidPanels: " << panels.size() - nPanels
            << " panels.\n";
  return true;
}

---

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

• SolidRidge.hh
• SolidRidge.cc