Abstract base class for solids. More...

#include <Solid.hh>

Inheritance diagram for Garfield::Solid:

Public Types
enum	BoundaryCondition { Unknown = 0 , Voltage , Charge , Float , Dielectric , DielectricCharge , ParallelField , PerpendicularField }

Public Member Functions
	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.

Static Public Member Functions
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
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
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

Abstract base class for solids.

Definition at line 28 of file Solid.hh.

Member Enumeration Documentation

◆ BoundaryCondition

enum Garfield::Solid::BoundaryCondition

Enumerator
Unknown
Voltage
Charge
Float
Dielectric
DielectricCharge
ParallelField
PerpendicularField

Definition at line 151 of file Solid.hh.

                         {
    Unknown = 0,
    Voltage,
    Charge,
    Float,
    Dielectric,
    DielectricCharge,
    ParallelField,
    PerpendicularField
  };

Constructor & Destructor Documentation

◆ Solid() [1/2]

Garfield::Solid::Solid ( )

delete

Default constructor.

◆ Solid() [2/2]

Garfield::Solid::Solid	(	const double	cx,
		const double	cy,
		const double	cz,
		const std::string &	name
	)

inline

Constructor.

Definition at line 33 of file Solid.hh.

      : m_cX(cx), m_cY(cy), m_cZ(cz), m_className(name) {
    m_id = s_id++;
  }

◆ ~Solid()

virtual Garfield::Solid::~Solid ( )

inlinevirtual

Destructor.

Definition at line 40 of file Solid.hh.

40{}

Member Function Documentation

◆ Cut()

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

pure virtual

Implemented in Garfield::SolidBox, Garfield::SolidExtrusion, Garfield::SolidHole, Garfield::SolidRidge, Garfield::SolidSphere, Garfield::SolidTube, and Garfield::SolidWire.

Referenced by Garfield::ViewGeometry::Plot2d().

◆ EnableDebugging()

void Garfield::Solid::EnableDebugging ( const bool on = true )

inline

Switch debugging messages on/off.

Definition at line 187 of file Solid.hh.

187{ m_debug = on; }

Garfield::Solid::m_debug

bool m_debug

Debug flag.

Definition: Solid.hh:218

◆ GetBoundaryChargeDensity()

double Garfield::Solid::GetBoundaryChargeDensity ( ) const

inline

Retrieve the surface charge density.

Definition at line 184 of file Solid.hh.

184{ return m_charge; }

Garfield::Solid::m_charge

double m_charge

Surface charge density.

Definition: Solid.hh:225

◆ GetBoundaryConditionType()

BoundaryCondition Garfield::Solid::GetBoundaryConditionType ( ) const

inline

Retrieve the type of boundary condition.

Definition at line 180 of file Solid.hh.

180{ return m_bctype; }

Garfield::Solid::m_bctype

BoundaryCondition m_bctype

Type of boundary condition.

Definition: Solid.hh:221

◆ GetBoundaryPotential()

double Garfield::Solid::GetBoundaryPotential ( ) const

inline

Retrieve the potential.

Definition at line 182 of file Solid.hh.

182{ return m_volt; }

Garfield::Solid::m_volt

double m_volt

Potential at the surface.

Definition: Solid.hh:223

◆ GetBoundingBox()

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

pure virtual

Return the bounding box of the solid.

Implemented in Garfield::SolidBox, Garfield::SolidExtrusion, Garfield::SolidHole, Garfield::SolidRidge, Garfield::SolidSphere, Garfield::SolidTube, and Garfield::SolidWire.

Referenced by Garfield::GeometrySimple::AddSolid().

◆ GetCentre()

bool Garfield::Solid::GetCentre	(	double &	x,
		double &	y,
		double &	z
	)		const

inline

Retrieve the centre point of the solid.

Definition at line 71 of file Solid.hh.

                                                        {
    x = m_cX;
    y = m_cY;
    z = m_cZ;
    return true;
  }

Referenced by Garfield::ComponentNeBem3d::Initialise(), and Garfield::ViewGeometry::Plot3d().

◆ GetColour()

int Garfield::Solid::GetColour ( ) const

inline

Get the colour of the solid.

Definition at line 192 of file Solid.hh.

192{ return m_colour; }

Garfield::Solid::m_colour

int m_colour

Colour.

Definition: Solid.hh:230

Referenced by Garfield::ViewGeometry::Plot3d().

◆ GetDirection()

bool Garfield::Solid::GetDirection	(	double &	dx,
		double &	dy,
		double &	dz
	)		const

inline

Retrieve the direction vector.

Definition at line 78 of file Solid.hh.

                                                              {
    dx = m_dX;
    dy = m_dY;
    dz = m_dZ;
    return true;
  }

◆ GetDiscretisationLevel()

virtual double Garfield::Solid::GetDiscretisationLevel ( const Panel & panel )

pure virtual

Retrieve the discretisation level of a panel.

Implemented in Garfield::SolidBox, Garfield::SolidExtrusion, Garfield::SolidHole, Garfield::SolidRidge, Garfield::SolidSphere, Garfield::SolidTube, and Garfield::SolidWire.

◆ GetHalfLengthX()

virtual double Garfield::Solid::GetHalfLengthX ( ) const

inlinevirtual

Return the half-length along x.

Reimplemented in Garfield::SolidBox, Garfield::SolidHole, and Garfield::SolidRidge.

Definition at line 95 of file Solid.hh.

                                        {
    return NotImplemented("GetHalfLengthX");
  }

Referenced by Garfield::ViewGeometry::Plot3d().

◆ GetHalfLengthY()

virtual double Garfield::Solid::GetHalfLengthY ( ) const

inlinevirtual

Return the half-length along y.

Reimplemented in Garfield::SolidBox, Garfield::SolidHole, and Garfield::SolidRidge.

Definition at line 99 of file Solid.hh.

                                        {
    return NotImplemented("GetHalfLengthY");
  }

Referenced by Garfield::ViewGeometry::Plot3d().

◆ GetHalfLengthZ()

virtual double Garfield::Solid::GetHalfLengthZ ( ) const

inlinevirtual

Return the half-length along z.

Reimplemented in Garfield::SolidBox, Garfield::SolidExtrusion, Garfield::SolidHole, Garfield::SolidTube, and Garfield::SolidWire.

Definition at line 103 of file Solid.hh.

                                        {
    return NotImplemented("GetHalfLengthZ");
  }

Referenced by Garfield::ViewGeometry::Plot3d().

◆ GetId()

unsigned int Garfield::Solid::GetId ( ) const

inline

Get the ID of the solid.

Definition at line 137 of file Solid.hh.

137{ return m_id; }

Referenced by Garfield::SolidBox::Cut(), Garfield::SolidExtrusion::Cut(), Garfield::SolidHole::Cut(), Garfield::SolidRidge::Cut(), Garfield::SolidSphere::Cut(), Garfield::SolidTube::Cut(), Garfield::ComponentNeBem3d::GetVolume(), Garfield::ComponentNeBem3d::Initialise(), Garfield::SolidBox::SolidPanels(), Garfield::SolidExtrusion::SolidPanels(), Garfield::SolidHole::SolidPanels(), Garfield::SolidRidge::SolidPanels(), and Garfield::SolidTube::SolidPanels().

◆ GetInnerRadius()

virtual double Garfield::Solid::GetInnerRadius ( ) const

inlinevirtual

Return the inner radius.

Reimplemented in Garfield::SolidSphere.

Definition at line 107 of file Solid.hh.

                                        {
    return NotImplemented("GetInnerRadius");
  }

Referenced by Garfield::ViewGeometry::Plot3d().

◆ GetLabel()

std::string Garfield::Solid::GetLabel ( ) const

inline

Return the label.

Definition at line 68 of file Solid.hh.

68{ return m_label; }

Garfield::Solid::m_label

std::string m_label

Label.

Definition: Solid.hh:215

Referenced by Garfield::ComponentNeBem3d::Initialise().

◆ GetLowerRadius()

virtual double Garfield::Solid::GetLowerRadius ( ) const

inlinevirtual

Return the lower radius (of a hole).

Reimplemented in Garfield::SolidHole.

Definition at line 117 of file Solid.hh.

                                        { 
    return NotImplemented("GetLowerRadius");
  } 

Referenced by Garfield::ViewGeometry::Plot3d().

◆ GetOrientation()

bool Garfield::Solid::GetOrientation	(	double &	ctheta,
		double &	stheta,
		double &	cphi,
		double &	sphi
	)		const

inline

Retrieve the orientation (azimuthal and polar angles) of the solid.

Definition at line 85 of file Solid.hh.

                                          {
    ctheta = m_cTheta;
    stheta = m_sTheta;
    cphi = m_cPhi;
    sphi = m_sPhi;
    return true;
  }

Referenced by Garfield::ViewGeometry::Plot3d().

◆ GetOuterRadius()

virtual double Garfield::Solid::GetOuterRadius ( ) const

inlinevirtual

Return the outer radius.

Reimplemented in Garfield::SolidSphere.

Definition at line 111 of file Solid.hh.

                                        {
    return NotImplemented("GetOuterRadius");
  }

Referenced by Garfield::ViewGeometry::Plot3d().

◆ GetProfile()

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

virtual

Get the vertices defining an extrusion.

Reimplemented in Garfield::SolidExtrusion.

Definition at line 40 of file Solid.cc.

                                                   {
 
  std::cerr << m_className << "::GetProfile: function not implemented.\n";
  return false;
}

Referenced by Garfield::ViewGeometry::Plot3d().

◆ GetRadius()

virtual double Garfield::Solid::GetRadius ( ) const

inlinevirtual

Return the radius.

Reimplemented in Garfield::SolidSphere, Garfield::SolidTube, and Garfield::SolidWire.

Definition at line 115 of file Solid.hh.

115{ return NotImplemented("GetRadius"); }

Referenced by Garfield::ViewGeometry::Plot3d().

◆ GetRidgeHeight()

virtual double Garfield::Solid::GetRidgeHeight ( ) const

inlinevirtual

Return the height of a ridge.

Reimplemented in Garfield::SolidRidge.

Definition at line 129 of file Solid.hh.

                                        {
    return NotImplemented("GetRidgeHeight");
  }

Referenced by Garfield::ViewGeometry::Plot3d().

◆ GetRidgeOffset()

virtual double Garfield::Solid::GetRidgeOffset ( ) const

inlinevirtual

Return the x-offset of a ridge.

Reimplemented in Garfield::SolidRidge.

Definition at line 125 of file Solid.hh.

                                        {
    return NotImplemented("GetRidgeOffset");
  }

Referenced by Garfield::ViewGeometry::Plot3d().

◆ GetUpperRadius()

virtual double Garfield::Solid::GetUpperRadius ( ) const

inlinevirtual

Return the upper radius (of a hole).

Reimplemented in Garfield::SolidHole.

Definition at line 121 of file Solid.hh.

                                        { 
    return NotImplemented("GetUpperRadius");
  } 

Referenced by Garfield::ViewGeometry::Plot3d().

◆ Intersect()

bool Garfield::Solid::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
	)

static

Definition at line 52 of file Solid.cc.

                                                          {
  //-----------------------------------------------------------------------
  //   PLALIN - Cuts an arbitrary plane with a line.
  //   Variables : (X1,Y1,Z1) : starting point of the line
  //               (X2,Y2,Z2) : end point of the line
  //               (X0,Y0,Z0) : point on the plane
  //               (A,B,C)    : parameters of the plane
  //-----------------------------------------------------------------------
 
  xc = yc = zc = 0.;
  bool on = false;
  // Form the two products.
  const double prod1 = (x0 - x1) * a + (y0 - y1) * b + (z0 - z1) * c;
  const double prod2 = (x2 - x1) * a + (y2 - y1) * b + (z2 - z1) * c;
  // Set a tolerance for lambda.
  constexpr double eps = 1.e-5;
  // Check the products are non-zero.
  const double dx = x2 - x1;
  const double dy = y2 - y1;
  const double dz = z2 - z1;
  const double d2 = dx * dx + dy * dy + dz * dz;
  if (std::abs(prod2) > 1.e-6 * sqrt((a * a + b * b + c * c) * d2)) {
    double s = prod1 / prod2;
    if (s >= -eps && s <= 1. + eps) on = true;
    s = std::max(0., std::min(1., s));
    xc = x1 + s * dx;
    yc = y1 + s * dy;
    zc = z1 + s * dz;
  }
  return on;
}

Referenced by Garfield::SolidBox::Cut(), Garfield::SolidExtrusion::Cut(), Garfield::SolidRidge::Cut(), Garfield::SolidSphere::Cut(), and Garfield::SolidTube::Cut().

◆ IsBox()

virtual bool Garfield::Solid::IsBox ( ) const

inlinevirtual

Return true if the solid is a box.

Reimplemented in Garfield::SolidBox.

Definition at line 51 of file Solid.hh.

51{ return false; }

Referenced by Garfield::ViewGeometry::Plot3d().

◆ IsExtrusion()

virtual bool Garfield::Solid::IsExtrusion ( ) const

inlinevirtual

Return true if the solid is an extrusion.

Reimplemented in Garfield::SolidExtrusion.

Definition at line 61 of file Solid.hh.

61{ return false; }

Referenced by Garfield::ViewGeometry::Plot3d().

◆ IsHole()

virtual bool Garfield::Solid::IsHole ( ) const

inlinevirtual

Return true if the solid is a hole.

Reimplemented in Garfield::SolidHole.

Definition at line 57 of file Solid.hh.

57{ return false; }

Referenced by Garfield::ViewGeometry::Plot3d().

◆ IsInside()

virtual bool Garfield::Solid::IsInside	(	const double	x,
		const double	y,
		const double	z,
		const bool	tesselated = `false`
	)		const

pure virtual

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

Implemented in Garfield::SolidBox, Garfield::SolidExtrusion, Garfield::SolidHole, Garfield::SolidRidge, Garfield::SolidSphere, Garfield::SolidTube, and Garfield::SolidWire.

◆ IsRidge()

virtual bool Garfield::Solid::IsRidge ( ) const

inlinevirtual

Return true if the solid is a ridge.

Reimplemented in Garfield::SolidRidge.

Definition at line 59 of file Solid.hh.

59{ return false; }

Referenced by Garfield::ViewGeometry::Plot3d().

◆ IsSphere()

virtual bool Garfield::Solid::IsSphere ( ) const

inlinevirtual

Return true if the solid is a sphere.

Reimplemented in Garfield::SolidSphere.

Definition at line 55 of file Solid.hh.

55{ return false; }

Referenced by Garfield::ViewGeometry::Plot3d().

◆ IsTube()

virtual bool Garfield::Solid::IsTube ( ) const

inlinevirtual

Return true if the solid is a tube.

Reimplemented in Garfield::SolidTube.

Definition at line 53 of file Solid.hh.

53{ return false; }

Referenced by Garfield::ViewGeometry::Plot3d().

◆ IsWire()

virtual bool Garfield::Solid::IsWire ( ) const

inlinevirtual

Return true if the solid is a wire.

Reimplemented in Garfield::SolidWire.

Definition at line 63 of file Solid.hh.

63{ return false; }

Referenced by Garfield::ViewGeometry::Plot3d().

◆ SetBoundaryChargeDensity()

void Garfield::Solid::SetBoundaryChargeDensity ( const double q )

inline

Apply fixed-charge boundary conditions.

Definition at line 168 of file Solid.hh.

                                                {
    m_charge = q;
    m_bctype = Charge;
  }

◆ SetBoundaryDielectric()

void Garfield::Solid::SetBoundaryDielectric ( )

inline

Make the surfaces of the solid dielectric-dielectric interfaces.

Definition at line 175 of file Solid.hh.

175{ m_bctype = Dielectric; }

◆ SetBoundaryFloat()

void Garfield::Solid::SetBoundaryFloat ( )

inline

Make the potential at the surface of the solid floating.

Definition at line 173 of file Solid.hh.

173{ m_bctype = Float; }

◆ SetBoundaryParallelField()

void Garfield::Solid::SetBoundaryParallelField ( )

inline

Definition at line 176 of file Solid.hh.

176{ m_bctype = ParallelField; }

◆ SetBoundaryPerpendicularField()

void Garfield::Solid::SetBoundaryPerpendicularField ( )

inline

Definition at line 177 of file Solid.hh.

177{ m_bctype = PerpendicularField; }

◆ SetBoundaryPotential()

void Garfield::Solid::SetBoundaryPotential ( const double v )

inline

Apply Dirichlet boundary conditions (fixed voltage).

Definition at line 163 of file Solid.hh.

                                            {
    m_volt = v;
    m_bctype = Voltage;
  }

◆ SetColour()

void Garfield::Solid::SetColour ( const int col )

inline

Set the colour of the solid.

Definition at line 190 of file Solid.hh.

190{ m_colour = col; }

◆ SetDirection()

void Garfield::Solid::SetDirection	(	const double	dx,
		const double	dy,
		const double	dz
	)

protected

Definition at line 12 of file Solid.cc.

                                                                          {
  const double d = sqrt(dx * dx + dy * dy + dz * dz);
  if (d < Small) {
    std::cerr << m_className << ": Direction vector has zero norm.\n";
    return;
  }
  m_dX = dx / d;
  m_dY = dy / d;
  m_dZ = dz / d;
  double phi, theta;
  const double dt = sqrt(m_dX * m_dX + m_dY * m_dY);
  if (dt < Small) {
    phi = 0.;
    if (m_dZ > 0.) {
      theta = 0.;
    } else {
      theta = Pi;
    }
  } else {
    phi = atan2(m_dY, m_dX);
    theta = atan2(dt, m_dZ);
  }
  m_cTheta = cos(theta);
  m_sTheta = sin(theta);
  m_cPhi = cos(phi);
  m_sPhi = sin(phi);
}

Referenced by Garfield::SolidBox::SolidBox(), Garfield::SolidExtrusion::SolidExtrusion(), Garfield::SolidHole::SolidHole(), Garfield::SolidRidge::SolidRidge(), Garfield::SolidTube::SolidTube(), and Garfield::SolidWire::SolidWire().

◆ SetDiscretisationLevel()

virtual void Garfield::Solid::SetDiscretisationLevel ( const double dis )

pure virtual

Set the discretisation level (for all panels).

Implemented in Garfield::SolidBox, Garfield::SolidExtrusion, Garfield::SolidHole, Garfield::SolidRidge, Garfield::SolidSphere, Garfield::SolidTube, and Garfield::SolidWire.

◆ SetLabel()

void Garfield::Solid::SetLabel ( const std::string & label )

inline

Set a label.

Definition at line 66 of file Solid.hh.

66{ m_label = label; }

◆ SolidPanels()

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

pure virtual

Retrieve the surface panels of the solid.

Implemented in Garfield::SolidBox, Garfield::SolidExtrusion, Garfield::SolidHole, Garfield::SolidRidge, Garfield::SolidSphere, Garfield::SolidTube, and Garfield::SolidWire.

Referenced by Garfield::ComponentNeBem3d::Initialise().

◆ ToGlobal()

void Garfield::Solid::ToGlobal	(	const double	u,
		const double	v,
		const double	w,
		double &	x,
		double &	y,
		double &	z
	)		const

inlineprotected

Transform a point from local coordinates (u, v, w) to global coordinates (x, y, z).

Definition at line 246 of file Solid.hh.

                                            {
    x = m_cX + m_cPhi * m_cTheta * u - m_sPhi * v + m_cPhi * m_sTheta * w;
    y = m_cY + m_sPhi * m_cTheta * u + m_cPhi * v + m_sPhi * m_sTheta * w;
    z = m_cZ - m_sTheta * u + m_cTheta * w;
  }

Referenced by Garfield::SolidBox::Cut(), Garfield::SolidExtrusion::Cut(), Garfield::SolidHole::Cut(), Garfield::SolidRidge::Cut(), Garfield::SolidTube::Cut(), Garfield::SolidBox::SolidPanels(), Garfield::SolidExtrusion::SolidPanels(), Garfield::SolidHole::SolidPanels(), Garfield::SolidRidge::SolidPanels(), and Garfield::SolidTube::SolidPanels().

◆ ToLocal()

void Garfield::Solid::ToLocal	(	const double	x,
		const double	y,
		const double	z,
		double &	u,
		double &	v,
		double &	w
	)		const

inlineprotected

Transform a point from global coordinates (x, y, z) to local coordinates (u, v, w).

Definition at line 234 of file Solid.hh.

                                           {
    const double dx = x - m_cX;
    const double dy = y - m_cY;
    const double dz = z - m_cZ;
 
    u = m_cPhi * m_cTheta * dx + m_sPhi * m_cTheta * dy - m_sTheta * dz;
    v = -m_sPhi * dx + m_cPhi * dy;
    w = m_cPhi * m_sTheta * dx + m_sPhi * m_sTheta * dy + m_cTheta * dz;
  }

Referenced by Garfield::SolidHole::GetDiscretisationLevel(), Garfield::SolidBox::IsInside(), Garfield::SolidExtrusion::IsInside(), Garfield::SolidHole::IsInside(), Garfield::SolidRidge::IsInside(), Garfield::SolidTube::IsInside(), and Garfield::SolidWire::IsInside().

◆ VectorToLocal()

void Garfield::Solid::VectorToLocal	(	const double	x,
		const double	y,
		const double	z,
		double &	u,
		double &	v,
		double &	w
	)

inlineprotected

Transform a vector from global to local coordinates.

Definition at line 253 of file Solid.hh.

                                                      {
    u = m_cPhi * m_cTheta * x + m_sPhi * m_cTheta * y - m_sTheta * z;
    v = -m_sPhi * x + m_cPhi * y;
    w = m_cPhi * m_sTheta * x + m_sPhi * m_sTheta * y + m_cTheta * z;
  }

Referenced by Garfield::SolidBox::GetDiscretisationLevel(), Garfield::SolidExtrusion::GetDiscretisationLevel(), Garfield::SolidHole::GetDiscretisationLevel(), Garfield::SolidRidge::GetDiscretisationLevel(), and Garfield::SolidTube::GetDiscretisationLevel().

Member Data Documentation

◆ m_bctype

BoundaryCondition Garfield::Solid::m_bctype = Unknown

protected

Type of boundary condition.

Definition at line 221 of file Solid.hh.

Referenced by GetBoundaryConditionType(), SetBoundaryChargeDensity(), SetBoundaryDielectric(), SetBoundaryFloat(), SetBoundaryParallelField(), SetBoundaryPerpendicularField(), and SetBoundaryPotential().

◆ m_charge

double Garfield::Solid::m_charge = 0.

protected

Surface charge density.

Definition at line 225 of file Solid.hh.

Referenced by GetBoundaryChargeDensity(), and SetBoundaryChargeDensity().

◆ m_className

std::string Garfield::Solid::m_className = "Solid"

protected

Class name.

Definition at line 212 of file Solid.hh.

Referenced by Garfield::SolidBox::GetDiscretisationLevel(), Garfield::SolidHole::GetDiscretisationLevel(), Garfield::SolidRidge::GetDiscretisationLevel(), GetProfile(), and SetDirection().

◆ m_colour

int Garfield::Solid::m_colour = -1

protected

Colour.

Definition at line 230 of file Solid.hh.

Referenced by Garfield::SolidBox::Cut(), Garfield::SolidExtrusion::Cut(), Garfield::SolidHole::Cut(), Garfield::SolidRidge::Cut(), Garfield::SolidSphere::Cut(), Garfield::SolidTube::Cut(), GetColour(), SetColour(), Garfield::SolidBox::SolidPanels(), Garfield::SolidExtrusion::SolidPanels(), Garfield::SolidHole::SolidPanels(), Garfield::SolidRidge::SolidPanels(), and Garfield::SolidTube::SolidPanels().

◆ m_cPhi

double Garfield::Solid::m_cPhi = 1.

protected

Azimuthal angle.

Definition at line 207 of file Solid.hh.

Referenced by Garfield::SolidBox::GetBoundingBox(), Garfield::SolidHole::GetBoundingBox(), Garfield::SolidRidge::GetBoundingBox(), Garfield::SolidTube::GetBoundingBox(), Garfield::SolidWire::GetBoundingBox(), GetOrientation(), SetDirection(), Garfield::SolidBox::SolidPanels(), Garfield::SolidExtrusion::SolidPanels(), Garfield::SolidHole::SolidPanels(), Garfield::SolidRidge::SolidPanels(), Garfield::SolidTube::SolidPanels(), ToGlobal(), ToLocal(), and VectorToLocal().

◆ m_cTheta

double Garfield::Solid::m_cTheta = 1.

protected

Polar angle.

Definition at line 209 of file Solid.hh.

Referenced by Garfield::SolidBox::GetBoundingBox(), Garfield::SolidHole::GetBoundingBox(), Garfield::SolidRidge::GetBoundingBox(), Garfield::SolidTube::GetBoundingBox(), Garfield::SolidWire::GetBoundingBox(), GetOrientation(), SetDirection(), Garfield::SolidBox::SolidPanels(), Garfield::SolidExtrusion::SolidPanels(), Garfield::SolidHole::SolidPanels(), Garfield::SolidRidge::SolidPanels(), Garfield::SolidTube::SolidPanels(), ToGlobal(), ToLocal(), and VectorToLocal().

◆ m_cX

double Garfield::Solid::m_cX = 0.

protected

Centre of the solid.

Definition at line 202 of file Solid.hh.

Referenced by Garfield::SolidBox::GetBoundingBox(), Garfield::SolidExtrusion::GetBoundingBox(), Garfield::SolidHole::GetBoundingBox(), Garfield::SolidRidge::GetBoundingBox(), Garfield::SolidSphere::GetBoundingBox(), Garfield::SolidTube::GetBoundingBox(), Garfield::SolidWire::GetBoundingBox(), GetCentre(), Garfield::SolidSphere::IsInside(), Garfield::SolidExtrusion::SolidExtrusion(), ToGlobal(), and ToLocal().

◆ m_cY

double Garfield::Solid::m_cY = 0.

protected

Definition at line 202 of file Solid.hh.

Referenced by Garfield::SolidBox::GetBoundingBox(), Garfield::SolidExtrusion::GetBoundingBox(), Garfield::SolidHole::GetBoundingBox(), Garfield::SolidRidge::GetBoundingBox(), Garfield::SolidSphere::GetBoundingBox(), Garfield::SolidTube::GetBoundingBox(), Garfield::SolidWire::GetBoundingBox(), GetCentre(), Garfield::SolidSphere::IsInside(), Garfield::SolidExtrusion::SolidExtrusion(), ToGlobal(), and ToLocal().

◆ m_cZ

double Garfield::Solid::m_cZ = 0.

protected

Definition at line 202 of file Solid.hh.

Referenced by Garfield::SolidBox::GetBoundingBox(), Garfield::SolidExtrusion::GetBoundingBox(), Garfield::SolidHole::GetBoundingBox(), Garfield::SolidRidge::GetBoundingBox(), Garfield::SolidSphere::GetBoundingBox(), Garfield::SolidTube::GetBoundingBox(), Garfield::SolidWire::GetBoundingBox(), GetCentre(), Garfield::SolidSphere::IsInside(), Garfield::SolidExtrusion::SolidExtrusion(), ToGlobal(), and ToLocal().

◆ m_debug

bool Garfield::Solid::m_debug = false

protected

Debug flag.

Definition at line 218 of file Solid.hh.

Referenced by EnableDebugging(), Garfield::SolidBox::GetDiscretisationLevel(), Garfield::SolidHole::GetDiscretisationLevel(), and Garfield::SolidRidge::GetDiscretisationLevel().

◆ m_dX

double Garfield::Solid::m_dX = 0.

protected

Direction vector.

Definition at line 205 of file Solid.hh.

Referenced by GetDirection(), SetDirection(), Garfield::SolidExtrusion::SolidPanels(), Garfield::SolidHole::SolidPanels(), Garfield::SolidRidge::SolidPanels(), and Garfield::SolidTube::SolidPanels().

◆ m_dY

double Garfield::Solid::m_dY = 0.

protected

Definition at line 205 of file Solid.hh.

Referenced by GetDirection(), SetDirection(), Garfield::SolidExtrusion::SolidPanels(), Garfield::SolidHole::SolidPanels(), Garfield::SolidRidge::SolidPanels(), and Garfield::SolidTube::SolidPanels().

◆ m_dZ

double Garfield::Solid::m_dZ = 1.

protected

Definition at line 205 of file Solid.hh.

Referenced by GetDirection(), SetDirection(), Garfield::SolidExtrusion::SolidPanels(), Garfield::SolidHole::SolidPanels(), Garfield::SolidRidge::SolidPanels(), and Garfield::SolidTube::SolidPanels().

◆ m_eps

double Garfield::Solid::m_eps = 0.

protected

Dielectric constant.

Definition at line 227 of file Solid.hh.

◆ m_label

std::string Garfield::Solid::m_label = ""

protected

Label.

Definition at line 215 of file Solid.hh.

Referenced by GetLabel(), and SetLabel().

◆ m_sPhi

double Garfield::Solid::m_sPhi = 0.

protected

Definition at line 207 of file Solid.hh.

Referenced by GetOrientation(), SetDirection(), Garfield::SolidBox::SolidPanels(), Garfield::SolidExtrusion::SolidPanels(), Garfield::SolidHole::SolidPanels(), Garfield::SolidRidge::SolidPanels(), Garfield::SolidTube::SolidPanels(), ToGlobal(), ToLocal(), and VectorToLocal().

◆ m_sTheta

double Garfield::Solid::m_sTheta = 0.

protected

Definition at line 209 of file Solid.hh.

Referenced by GetOrientation(), SetDirection(), Garfield::SolidBox::SolidPanels(), Garfield::SolidExtrusion::SolidPanels(), Garfield::SolidHole::SolidPanels(), Garfield::SolidRidge::SolidPanels(), Garfield::SolidTube::SolidPanels(), ToGlobal(), ToLocal(), and VectorToLocal().

◆ m_volt

double Garfield::Solid::m_volt = 0.

protected

Potential at the surface.

Definition at line 223 of file Solid.hh.

Referenced by GetBoundaryPotential(), and SetBoundaryPotential().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ BoundaryCondition

Constructor & Destructor Documentation

◆ Solid() [1/2]

◆ Solid() [2/2]

◆ ~Solid()

Member Function Documentation

◆ Cut()

◆ EnableDebugging()

◆ GetBoundaryChargeDensity()

◆ GetBoundaryConditionType()

◆ GetBoundaryPotential()

◆ GetBoundingBox()

◆ GetCentre()

◆ GetColour()

◆ GetDirection()

◆ GetDiscretisationLevel()

◆ GetHalfLengthX()

◆ GetHalfLengthY()

◆ GetHalfLengthZ()

◆ GetId()

◆ GetInnerRadius()

◆ GetLabel()

◆ GetLowerRadius()

◆ GetOrientation()

◆ GetOuterRadius()

◆ GetProfile()

◆ GetRadius()

◆ GetRidgeHeight()

◆ GetRidgeOffset()

◆ GetUpperRadius()

◆ Intersect()

◆ IsBox()

◆ IsExtrusion()

◆ IsHole()

◆ IsInside()

◆ IsRidge()

◆ IsSphere()

◆ IsTube()

◆ IsWire()

◆ SetBoundaryChargeDensity()

◆ SetBoundaryDielectric()

◆ SetBoundaryFloat()

◆ SetBoundaryParallelField()

◆ SetBoundaryPerpendicularField()

◆ SetBoundaryPotential()

◆ SetColour()

◆ SetDirection()

◆ SetDiscretisationLevel()

◆ SetLabel()

◆ SolidPanels()

◆ ToGlobal()

◆ ToLocal()

◆ VectorToLocal()

Member Data Documentation

◆ m_bctype

◆ m_charge

◆ m_className

◆ m_colour

◆ m_cPhi

◆ m_cTheta

◆ m_cX

◆ m_cY

◆ m_cZ

◆ m_debug

◆ m_dX

◆ m_dY

◆ m_dZ

◆ m_eps

◆ m_label

◆ m_sPhi

◆ m_sTheta

◆ m_volt