Cylindrical tube. More...

#include <SolidTube.hh>

Inheritance diagram for Garfield::SolidTube:

Public Member Functions
	SolidTube (const double cx, const double cy, const double cz, const double r, const double lz)
	Constructor from centre, outer radius, and half-length.

	SolidTube (const double cx, const double cy, const double cz, const double r, const double lz, const double dx, const double dy, const double dz)
	Constructor from centre, outer radius, half-length and orientation.

	~SolidTube ()
	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	IsTube () const override
	Return true if the solid is a tube.

void	SetHalfLength (const double lz)

void	SetRadius (const double r)

double	GetHalfLengthZ () const override
	Return the half-length along z.

double	GetRadius () const override
	Return the radius.

void	SetSectors (const unsigned int n)

void	SetRotation (const double angle)

void	SetAverageRadius (const bool average)

void	SetTopLid (const bool closed)
	Request the cylinder to be closed with a (polygonal) lid at +z.

void	SetBottomLid (const bool closed)
	Request the cylinder to be closed with a (polygonal) lid at -z.

unsigned int	GetSectors () const
	Return the number of sectors.

double	GetRotation () const
	Return the current rotation angle.

bool	GetAverage () const
	Return the status of the "average-radius" flag.

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

Cylindrical tube.

Definition at line 12 of file SolidTube.hh.

Constructor & Destructor Documentation

◆ SolidTube() [1/2]

Garfield::SolidTube::SolidTube	(	const double	cx,
		const double	cy,
		const double	cz,
		const double	r,
		const double	lz
	)

Constructor from centre, outer radius, and half-length.

Definition at line 10 of file SolidTube.cc.

    : Solid(cx, cy, cz, "SolidTube"),
      m_rMax(rt),
      m_lZ(lz) {
  UpdatePolygon();
}

◆ SolidTube() [2/2]

Garfield::SolidTube::SolidTube	(	const double	cx,
		const double	cy,
		const double	cz,
		const double	r,
		const double	lz,
		const double	dx,
		const double	dy,
		const double	dz
	)

Constructor from centre, outer radius, half-length and orientation.

Definition at line 18 of file SolidTube.cc.

    : SolidTube(cx, cy, cz, rt, lz) {
  SetDirection(dx, dy, dz);
}

◆ ~SolidTube()

Garfield::SolidTube::~SolidTube ( )

inline

Destructor.

Definition at line 21 of file SolidTube.hh.

21{}

Member Function Documentation

◆ Cut()

void Garfield::SolidTube::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 242 of file SolidTube.cc.

                                              {
 
  // -----------------------------------------------------------------------
  //    PLACYC - Cuts cylinder with a plane.
  // -----------------------------------------------------------------------
  std::vector<double> xv;
  std::vector<double> yv;
  std::vector<double> zv;
  double r = m_rp;
  const unsigned int nPoints = 4 * (m_n - 1);
  const double dphi = HalfPi / (m_n - 1.);
  // Go through the lines of the top and bottom lids.
  for (const auto zLid : {-m_lZ, +m_lZ}) {
    double x1, y1, z1;
    ToGlobal(r * cos(m_rot), r * sin(m_rot), zLid, x1, y1, z1);
    // Loop over the points.
    for (unsigned int i = 2; i <= nPoints + 1; ++i) {
      const double phi = m_rot + (i - 1.) * dphi;
      double x2, y2, z2;
      ToGlobal(r * cos(phi), r * sin(phi), zLid, 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;
    }
  }
  // Go through the ribs.
  for (unsigned int i = 2; i <= nPoints + 1; ++i) {
    // Bottom and top of the line along the axis of the cylinder.
    const double phi = m_rot + (i - 1.) * dphi;
    const double u = r * cos(phi);
    const double v = r * sin(phi);
    double x1, y1, z1;
    ToGlobal(u, v, +m_lZ, x1, y1, z1);
    double x2, y2, z2;
    ToGlobal(u, v, -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);
    }
  }
  // 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));
  }
}

◆ GetAverage()

bool Garfield::SolidTube::GetAverage ( ) const

inline

Return the status of the "average-radius" flag.

Definition at line 60 of file SolidTube.hh.

60{ return m_average; }

◆ GetBoundingBox()

bool Garfield::SolidTube::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 69 of file SolidTube.cc.

                                                                               {
  if (m_cTheta == 1. && m_cPhi == 1.) {
    xmin = m_cX - m_rMax;
    xmax = m_cX + m_rMax;
    ymin = m_cY - m_rMax;
    ymax = m_cY + m_rMax;
    zmin = m_cZ - m_lZ;
    zmax = m_cZ + m_lZ;
    return true;
  }
 
  const double dd = sqrt(m_rMax * m_rMax + m_lZ * m_lZ);
  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::SolidTube::GetDiscretisationLevel ( const Panel & panel )

overridevirtual

Retrieve the discretisation level of a panel.

Implements Garfield::Solid.

Definition at line 228 of file SolidTube.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(std::abs(u), std::abs(v))) {
    return m_dis[0];
  } else if (w < -std::max(std::abs(u), std::abs(v))) {
    return m_dis[1];
  }
  return m_dis[2];
} 

◆ GetHalfLengthZ()

double Garfield::SolidTube::GetHalfLengthZ ( ) const

inlineoverridevirtual

Return the half-length along z.

Reimplemented from Garfield::Solid.

Definition at line 32 of file SolidTube.hh.

32{ return m_lZ; }

◆ GetRadius()

double Garfield::SolidTube::GetRadius ( ) const

inlineoverridevirtual

Return the radius.

Reimplemented from Garfield::Solid.

Definition at line 33 of file SolidTube.hh.

33{ return m_rMax; }

◆ GetRotation()

double Garfield::SolidTube::GetRotation ( ) const

inline

Return the current rotation angle.

Definition at line 58 of file SolidTube.hh.

58{ return m_rot; }

◆ GetSectors()

unsigned int Garfield::SolidTube::GetSectors ( ) const

inline

Return the number of sectors.

Definition at line 56 of file SolidTube.hh.

56{ return m_n; }

◆ IsInside()

bool Garfield::SolidTube::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 50 of file SolidTube.cc.

                                                      {
  // 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;
 
  const double rho = sqrt(u * u + v * v);
  if (!tesselated) return (rho <= m_rMax);
 
  if (rho > m_rp) return false;
  if (rho < m_ri) return true;
  bool inside = false;
  bool edge = false;
  Polygon::Inside(m_xp, m_yp, u, v, inside, edge);
  return inside;
}

◆ IsTube()

bool Garfield::SolidTube::IsTube ( ) const

inlineoverridevirtual

Return true if the solid is a tube.

Reimplemented from Garfield::Solid.

Definition at line 27 of file SolidTube.hh.

27{ return true; }

◆ SetAverageRadius()

void Garfield::SolidTube::SetAverageRadius ( const bool average )

inline

By default, the polygon used for approximating the cylinder when calculating surface panels is inscribed in a circle of the specified radius. If the "average-radius" flag is activated, then the radius will be interpreted as the mean radius of the polygon that approximates the cylinder.

Definition at line 49 of file SolidTube.hh.

49{ m_average = average; }

◆ SetBottomLid()

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

inline

Request the cylinder to be closed with a (polygonal) lid at -z.

Definition at line 53 of file SolidTube.hh.

53{ m_botlid = closed; }

◆ SetDiscretisationLevel()

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

inlineoverridevirtual

Set the discretisation level (for all panels).

Implements Garfield::Solid.

Definition at line 63 of file SolidTube.hh.

63{ m_dis.fill(dis); }

◆ SetHalfLength()

void Garfield::SolidTube::SetHalfLength ( const double lz )

Definition at line 100 of file SolidTube.cc.

                                             {
  if (lz <= 0.) {
    std::cerr << "SolidTube::SetHalfLength: Half-length must be > 0.\n";
    return;
  }
  m_lZ = lz;
  UpdatePolygon();
}

◆ SetRadius()

void Garfield::SolidTube::SetRadius ( const double r )

Definition at line 91 of file SolidTube.cc.

                                        {
  if (r <= 0.) {
    std::cerr << "SolidTube::SetRadius: Radius must be > 0.\n";
    return;
  }
  m_rMax = r;
  UpdatePolygon();
}

◆ SetRotation()

void Garfield::SolidTube::SetRotation ( const double angle )

inline

Specify a rotation angle (radian) of the cylinder. Such a rotation is meaningful only if the number of sectors (when approximating the circle with a polygon) has been chosen small.

Definition at line 43 of file SolidTube.hh.

43{ m_rot = angle; }

◆ SetSectors()

void Garfield::SolidTube::SetSectors ( const unsigned int n )

When calculating the surface panels, the cylinder is approximated as a polygon with a finite number of panels. The number of corners of the polygon equals $4(n - 1)$ . Thus, $n = 2$ will produce a square, $n = 3$ an octagon etc.

Definition at line 109 of file SolidTube.cc.

                                               {
  if (n < 1) {
    std::cerr << "SolidTube::SetSectors: Number must be > 0.\n";
    return;
  }
  m_n = n;
  UpdatePolygon();
}

◆ SetTopLid()

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

inline

Request the cylinder to be closed with a (polygonal) lid at +z.

Definition at line 51 of file SolidTube.hh.

51{ m_toplid = closed; }

◆ SolidPanels()

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

overridevirtual

Retrieve the surface panels of the solid.

Implements Garfield::Solid.

Definition at line 118 of file SolidTube.cc.

                                                    {
 
  const auto id = GetId();
  const auto 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 << "SolidTube::SolidPanels:\n"
              << "    Zero norm direction vector; no panels generated.\n";
    return false;
  }
 
  double r = m_rp;
  const unsigned int nPoints = 4 * (m_n - 1);
  // Create the top lid.
  if (m_toplid) {
    std::vector<double> xv;
    std::vector<double> yv;
    std::vector<double> zv;
    for (unsigned int i = 1; i <= nPoints; i++) {
      const double alpha = m_rot + HalfPi * (i - 1.) / (m_n - 1.);
      // Rotate into place.
      double x, y, z;
      ToGlobal(r * cos(alpha), r * sin(alpha), m_lZ, x, y, z);
      xv.push_back(x);
      yv.push_back(y);
      zv.push_back(z);
    }
    Panel panel;
    panel.a = m_cPhi * m_sTheta;
    panel.b = m_sPhi * m_sTheta;
    panel.c = m_cTheta;
    panel.xv = xv;
    panel.yv = yv;
    panel.zv = zv;
    panel.colour = m_colour;
    panel.volume = id;
    panels.push_back(std::move(panel));
  }
  // Create the bottom lid.
  if (m_botlid) {
    std::vector<double> xv;
    std::vector<double> yv;
    std::vector<double> zv;
    for (unsigned int i = 1; i <= nPoints; i++) {
      const double alpha = m_rot + HalfPi * (i - 1.) / (m_n - 1.);
      // Rotate into place.
      double x, y, z;
      ToGlobal(r * cos(alpha), r * sin(alpha), -m_lZ, x, y, z);
      xv.push_back(x);
      yv.push_back(y);
      zv.push_back(z);
    }
    Panel panel;
    panel.a = -m_cPhi * m_sTheta;
    panel.b = -m_sPhi * m_sTheta;
    panel.c = -m_cTheta;
    panel.xv = xv;
    panel.yv = yv;
    panel.zv = zv;
    panel.colour = m_colour;
    panel.volume = id;
    panels.push_back(std::move(panel));
  }
  // Create the side panels.
  double u = r * cos(m_rot);
  double v = r * sin(m_rot);
  // Rotate into place.
  double xv0, yv0, zv0;
  ToGlobal(u, v, -m_lZ, xv0, yv0, zv0);
  double xv1, yv1, zv1;
  ToGlobal(u, v, +m_lZ, xv1, yv1, zv1);
  // Go around the cylinder.
  for (unsigned int i = 2; i <= nPoints + 1; i++) {
    // Bottom and top of the line along the axis of the cylinder.
    double alpha = m_rot + HalfPi * (i - 1.) / (m_n - 1.);
    u = r * cos(alpha);
    v = r * sin(alpha);
    // Rotate into place.
    double xv2, yv2, zv2;
    ToGlobal(u, v, +m_lZ, xv2, yv2, zv2);
    double xv3, yv3, zv3;
    ToGlobal(u, v, -m_lZ, xv3, yv3, zv3);
    // Store the plane.
    Panel panel;
    alpha = m_rot + HalfPi * (i - 1.5) / (m_n - 1.);
    const double cAlpha = cos(alpha);
    const double sAlpha = sin(alpha);
    panel.a = m_cPhi * m_cTheta * cAlpha - m_sPhi * sAlpha;
    panel.b = m_sPhi * m_cTheta * cAlpha + m_cPhi * sAlpha;
    panel.c = -m_sTheta * cAlpha;
    panel.xv = {xv0, xv1, xv2, xv3};
    panel.yv = {yv0, yv1, yv2, yv3};
    panel.zv = {zv0, zv1, zv2, zv3};
    panel.colour = m_colour;
    panel.volume = id;
    panels.push_back(std::move(panel));
    // Shift the points.
    xv0 = xv3;
    yv0 = yv3;
    zv0 = zv3;
    xv1 = xv2;
    yv1 = yv2;
    zv1 = zv2;
  }
  std::cout << "SolidTube::SolidPanels: " << panels.size() - nPanels
            << " panels.\n";
  return true;
}

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SolidTube() [1/2]

◆ SolidTube() [2/2]

◆ ~SolidTube()

Member Function Documentation

◆ Cut()

◆ GetAverage()

◆ GetBoundingBox()

◆ GetDiscretisationLevel()

◆ GetHalfLengthZ()

◆ GetRadius()

◆ GetRotation()

◆ GetSectors()

◆ IsInside()

◆ IsTube()

◆ SetAverageRadius()

◆ SetBottomLid()

◆ SetDiscretisationLevel()

◆ SetHalfLength()

◆ SetRadius()

◆ SetRotation()

◆ SetSectors()

◆ SetTopLid()

◆ SolidPanels()