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
	Check whether a given point is inside the solid.
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	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	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	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 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.
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.

Private Attributes
double	m_lX
	Half-length in x.
double	m_lY
	Half-length in y.
double	m_hz
	Height of the ridge.
double	m_hx
	Offset of the ridge in x.
std::array< double, 5 >	m_dis {{-1., -1., -1., -1., -1.}}
	Discretisation levels.

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
	Transform a point from global coordinates (x, y, z) to local coordinates (u, v, w).
void	ToGlobal (const double u, const double v, const double w, double &x, double &y, double &z) const
	Transform a point from local coordinates (u, v, w) to global coordinates (x, y, z).
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 12 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.

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

◆ ~SolidRidge()

Garfield::SolidRidge::~SolidRidge ( )

inline

Destructor.

Definition at line 22 of file SolidRidge.hh.

22{}

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.

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

◆ GetDiscretisationLevel()

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

overridevirtual

Retrieve the discretisation level of a panel.

Implements Garfield::Solid.

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

39{ return m_lX; }

Garfield::SolidRidge::m_lX

double m_lX

Half-length in x.

Definition SolidRidge.hh:54

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

40{ return m_lY; }

Garfield::SolidRidge::m_lY

double m_lY

Half-length in y.

Definition SolidRidge.hh:56

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

41{ return m_hz; }

Garfield::SolidRidge::m_hz

double m_hz

Height of the ridge.

Definition SolidRidge.hh:58

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

42{ return m_hx; }

Garfield::SolidRidge::m_hx

double m_hx

Offset of the ridge in x.

Definition SolidRidge.hh:60

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

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

28{ 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.

45{ m_dis.fill(dis); }

Garfield::SolidRidge::m_dis

std::array< double, 5 > m_dis

Discretisation levels.

Definition SolidRidge.hh:63

◆ SetHalfLengthX()

void Garfield::SolidRidge::SetHalfLengthX ( const double lx )

Set the half-length along x.

◆ SetHalfLengthY()

void Garfield::SolidRidge::SetHalfLengthY ( const double ly )

Set the half-length along y.

◆ SetRidgeHeight()

void Garfield::SolidRidge::SetRidgeHeight ( const double hz )

Set the height of the ridge.

◆ SetRidgeOffset()

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

inline

Set the x-offset of the ridge.

Definition at line 37 of file SolidRidge.hh.

37{ m_hx = dx; }

◆ SolidPanels()

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

overridevirtual

Retrieve the surface panels of the solid.

Implements Garfield::Solid.

Member Data Documentation

◆ m_dis

std::array<double, 5> Garfield::SolidRidge::m_dis {{-1., -1., -1., -1., -1.}}

private

Discretisation levels.

Definition at line 63 of file SolidRidge.hh.

63{{-1., -1., -1., -1., -1.}};

◆ m_hx

double Garfield::SolidRidge::m_hx

private

Offset of the ridge in x.

Definition at line 60 of file SolidRidge.hh.

◆ m_hz

double Garfield::SolidRidge::m_hz

private

Height of the ridge.

Definition at line 58 of file SolidRidge.hh.

◆ m_lX

double Garfield::SolidRidge::m_lX

private

Half-length in x.

Definition at line 54 of file SolidRidge.hh.

◆ m_lY

double Garfield::SolidRidge::m_lY

private

Half-length in y.

Definition at line 56 of file SolidRidge.hh.

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

/builds/garfield/docs/source/Include/Garfield/SolidRidge.hh

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SolidRidge() [1/2]

◆ SolidRidge() [2/2]

◆ ~SolidRidge()

Member Function Documentation

◆ Cut()

◆ GetBoundingBox()

◆ GetDiscretisationLevel()

◆ GetHalfLengthX()

◆ GetHalfLengthY()

◆ GetRidgeHeight()

◆ GetRidgeOffset()

◆ IsInside()

◆ IsRidge()

◆ SetDiscretisationLevel()

◆ SetHalfLengthX()

◆ SetHalfLengthY()

◆ SetRidgeHeight()

◆ SetRidgeOffset()

◆ SolidPanels()

Member Data Documentation

◆ m_dis

◆ m_hx

◆ m_hz

◆ m_lX

◆ m_lY