"Native" geometry, using simple shapes. More...

#include <GeometrySimple.hh>

Inheritance diagram for Garfield::GeometrySimple:

Public Member Functions
	GeometrySimple ()
	Constructor.

virtual	~GeometrySimple ()
	Destructor.

Medium *	GetMedium (const double x, const double y, const double z, const bool tesselated=false) const override
	Retrieve the medium at a given point.

size_t	GetNumberOfSolids () const override
	Return the number of solids in the geometry.

Solid *	GetSolid (const size_t i) const override
	Get a solid from the list.

Solid *	GetSolid (const size_t i, Medium *&medium) const override
	Get a solid from the list, together with the associated medium.

void	AddSolid (Solid s, Medium m)
	Add a solid to the geometry, together with the medium inside.

Solid *	GetSolid (const double x, const double y, const double z, const bool tesselated=false) const
	Get the solid at a given location (x, y, z).

void	SetMedium (Medium *medium)
	Set a background medium.

void	Clear ()
	Reset the geometry.

void	PrintSolids ()
	Print a summary of the solids present in the geometry.

bool	IsInside (const double x, const double y, const double z, const bool tesselated=false) const override
	Check if a point is inside the geometry.

bool	IsInBoundingBox (const double x, const double y, const double z) const
	Determine whether a point is inside the envelope of the geometry.

bool	GetBoundingBox (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) override
	Get the bounding box (envelope of the geometry).

void	EnableDebugging (const bool on=true)
	Switch on/off debugging and warning messages.

Public Member Functions inherited from Garfield::Geometry
	Geometry ()=delete
	Default constructor.

	Geometry (const std::string &name)
	Constructor.

virtual	~Geometry ()
	Destructor.

virtual Medium *	GetMedium (const double x, const double y, const double z, const bool tesselated=false) const =0
	Retrieve the medium at a given point.

virtual size_t	GetNumberOfSolids () const
	Return the number of solids in the geometry.

virtual Solid *	GetSolid (const size_t) const
	Get a solid from the list.

virtual Solid *	GetSolid (const size_t, Medium *&medium) const
	Get a solid from the list, together with the associated medium.

virtual bool	IsInside (const double x, const double y, const double z, const bool tesselated=false) const =0
	Check if a point is inside the geometry.

virtual bool	GetBoundingBox (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax)=0
	Get the bounding box (envelope of the geometry).

Protected Attributes
std::vector< std::pair< Solid , Medium > >	m_solids
	List of solids and associated media.

Medium *	m_medium = nullptr
	Background medium.

bool	m_hasBoundingBox = false

std::array< double, 3 >	m_bbMin = {{0., 0., 0.}}

std::array< double, 3 >	m_bbMax = {{0., 0., 0.}}

bool	m_debug = false
	Switch on/off debugging messages.

Protected Attributes inherited from Garfield::Geometry
std::string	m_className = "Geometry"

Detailed Description

"Native" geometry, using simple shapes.

Definition at line 13 of file GeometrySimple.hh.

Constructor & Destructor Documentation

◆ GeometrySimple()

Garfield::GeometrySimple::GeometrySimple ( )

Constructor.

Definition at line 8 of file GeometrySimple.cc.

8: Geometry("GeometrySimple") {}

Garfield::Geometry::Geometry

Geometry()=delete

Default constructor.

◆ ~GeometrySimple()

virtual Garfield::GeometrySimple::~GeometrySimple ( )

inlinevirtual

Destructor.

Definition at line 18 of file GeometrySimple.hh.

18{}

Member Function Documentation

◆ AddSolid()

void Garfield::GeometrySimple::AddSolid	(	Solid *	s,
		Medium *	m
	)

Add a solid to the geometry, together with the medium inside.

Definition at line 10 of file GeometrySimple.cc.

                                                          {
  // Make sure the solid and the medium are defined.
  if (!solid || !medium) {
    std::cerr << m_className << "::AddSolid: Null pointer.\n";
    return;
  }
 
  // Update the bounding box ranges
  double xmin, ymin, zmin;
  double xmax, ymax, zmax;
  if (!solid->GetBoundingBox(xmin, ymin, zmin, xmax, ymax, zmax)) {
    std::cerr << m_className << "::AddSolid: Solid has no bounding box.\n";
    return;
  }
 
  if (m_hasBoundingBox) {
    m_bbMin[0] = std::min(m_bbMin[0], xmin);
    m_bbMin[1] = std::min(m_bbMin[1], ymin);
    m_bbMin[2] = std::min(m_bbMin[2], zmin);
    m_bbMax[0] = std::max(m_bbMax[0], xmax);
    m_bbMax[1] = std::max(m_bbMax[1], ymax);
    m_bbMax[2] = std::max(m_bbMax[2], zmax);
  } else {
    m_bbMin[0] = xmin;
    m_bbMin[1] = ymin;
    m_bbMin[2] = zmin;
    m_bbMax[0] = xmax;
    m_bbMax[1] = ymax;
    m_bbMax[2] = zmax;
    m_hasBoundingBox = true;
  }
 
  // Add the new solid to the list.
  m_solids.emplace_back(std::make_pair(solid, medium));
}

◆ Clear()

void Garfield::GeometrySimple::Clear ( )

Reset the geometry.

Definition at line 82 of file GeometrySimple.cc.

                           {
  m_solids.clear();
  m_medium = nullptr;
}

◆ EnableDebugging()

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

inline

Switch on/off debugging and warning messages.

Definition at line 57 of file GeometrySimple.hh.

57{ m_debug = on; }

Garfield::GeometrySimple::m_debug

bool m_debug

Switch on/off debugging messages.

Definition: GeometrySimple.hh:71

◆ GetBoundingBox()

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

inlineoverridevirtual

Get the bounding box (envelope of the geometry).

Implements Garfield::Geometry.

Definition at line 45 of file GeometrySimple.hh.

                                                           {
    xmin = m_bbMin[0];
    ymin = m_bbMin[1];
    zmin = m_bbMin[2];
    xmax = m_bbMax[0];
    ymax = m_bbMax[1];
    zmax = m_bbMax[2];
    return true;
  }

Referenced by Garfield::ViewGeometry::Plot2d(), and Garfield::ViewGeometry::Plot3d().

◆ GetMedium()

Medium * Garfield::GeometrySimple::GetMedium	(	const double	x,
		const double	y,
		const double	z,
		const bool	tesselated = `false`
	)		const

overridevirtual

Retrieve the medium at a given point.

Implements Garfield::Geometry.

Definition at line 54 of file GeometrySimple.cc.

                                 {
  for (const auto& solid : m_solids) {
    if (solid.first->IsInside(x, y, z, tesselated)) {
      return solid.second;
    }
  }
  return m_medium;
}

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

◆ GetNumberOfSolids()

size_t Garfield::GeometrySimple::GetNumberOfSolids ( ) const

inlineoverridevirtual

Return the number of solids in the geometry.

Reimplemented from Garfield::Geometry.

Definition at line 23 of file GeometrySimple.hh.

23{ return m_solids.size(); }

Referenced by Garfield::ViewGeometry::Plot2d(), and Garfield::ViewGeometry::Plot3d().

◆ GetSolid() [1/3]

Solid * Garfield::GeometrySimple::GetSolid	(	const double	x,
		const double	y,
		const double	z,
		const bool	tesselated = `false`
	)		const

Get the solid at a given location (x, y, z).

Definition at line 46 of file GeometrySimple.cc.

                                                                             {
  for (const auto& solid : m_solids) {
    if (solid.first->IsInside(x, y, z, tesselated)) return solid.first;
  }
  return nullptr;
}

◆ GetSolid() [2/3]

Solid * Garfield::GeometrySimple::GetSolid ( const size_t size_t ) const

overridevirtual

Get a solid from the list.

Reimplemented from Garfield::Geometry.

Definition at line 65 of file GeometrySimple.cc.

                                                    {
  if (i >= m_solids.size()) {
    std::cerr << m_className << "::GetSolid: Index out of range.\n";
    return nullptr;
  }
  return m_solids[i].first;
}

Referenced by Garfield::ViewGeometry::Plot2d(), and Garfield::ViewGeometry::Plot3d().

◆ GetSolid() [3/3]

Solid * Garfield::GeometrySimple::GetSolid	(	const size_t	size_t,
		Medium *&	medium
	)		const

overridevirtual

Get a solid from the list, together with the associated medium.

Reimplemented from Garfield::Geometry.

Definition at line 73 of file GeometrySimple.cc.

                                                                     {
  if (i >= m_solids.size()) {
    std::cerr << m_className << "::GetSolid: Index out of range.\n";
    return nullptr;
  }
  medium = m_solids[i].second;
  return m_solids[i].first;
}

◆ IsInBoundingBox()

bool Garfield::GeometrySimple::IsInBoundingBox	(	const double	x,
		const double	y,
		const double	z
	)		const

Determine whether a point is inside the envelope of the geometry.

Definition at line 134 of file GeometrySimple.cc.

                                                           {
  if (!m_hasBoundingBox) {
    if (m_debug) {
      std::cerr << m_className << "::IsInBoundingBox:\n"
                << "    Bounding box is not defined.\n";
    }
    return true;
  }
 
  if (x >= m_bbMin[0] && x <= m_bbMax[0] &&
      y >= m_bbMin[1] && y <= m_bbMax[1] &&
      z >= m_bbMin[2] && z <= m_bbMax[2])
    return true;
  return false;
}

Referenced by IsInside().

◆ IsInside()

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

overridevirtual

Check if a point is inside the geometry.

Implements Garfield::Geometry.

Definition at line 124 of file GeometrySimple.cc.

                                                                           {
  if (!IsInBoundingBox(x, y, z)) return false;
 
  for (const auto& solid : m_solids) {
    if (solid.first->IsInside(x, y, z, tesselated)) return true;
  }
  return false;
}

◆ PrintSolids()

void Garfield::GeometrySimple::PrintSolids ( )

Print a summary of the solids present in the geometry.

Definition at line 87 of file GeometrySimple.cc.

                                 {
  std::cout << m_className << "::PrintSolids:\n";
  const auto nSolids = m_solids.size();
  if (nSolids == 1) {
    std::cout << "    1 solid\n";
  } else {
    std::cout << "    " << nSolids << " solids\n";
  }
  if (m_solids.empty()) return;
  std::cout << "      Index      Type    Medium\n";
  for (size_t i = 0; i < nSolids; ++i) {
    std::cout << "        " << i << "         ";
    if (m_solids[i].first->IsBox()) {
      std::cout << "box       ";
    } else if (m_solids[i].first->IsTube()) {
      std::cout << "tube      ";
    } else if (m_solids[i].first->IsSphere()) {
      std::cout << "sphere    ";
    } else if (m_solids[i].first->IsHole()) {
      std::cout << "hole      ";
    } else if (m_solids[i].first->IsRidge()) {
      std::cout << "ridge     ";
    } else if (m_solids[i].first->IsExtrusion()) {
      std::cout << "extrusion ";
    } else if (m_solids[i].first->IsWire()) {
      std::cout << "wire      ";
    } else {
      std::cout << "unknown  ";
    }
    if (m_solids[i].second) {
      std::cout << m_solids[i].second->GetName() << "\n";
    } else {
      std::cout << " ---\n";
    }
  }
}

◆ SetMedium()

void Garfield::GeometrySimple::SetMedium ( Medium * medium )

inline

Set a background medium.

Definition at line 34 of file GeometrySimple.hh.

34{ m_medium = medium; }

Member Data Documentation

◆ m_bbMax

std::array<double, 3> Garfield::GeometrySimple::m_bbMax = {{0., 0., 0.}}

protected

Definition at line 68 of file GeometrySimple.hh.

Referenced by AddSolid(), GetBoundingBox(), and IsInBoundingBox().

◆ m_bbMin

std::array<double, 3> Garfield::GeometrySimple::m_bbMin = {{0., 0., 0.}}

protected

Definition at line 67 of file GeometrySimple.hh.

Referenced by AddSolid(), GetBoundingBox(), and IsInBoundingBox().

◆ m_debug

bool Garfield::GeometrySimple::m_debug = false

protected

Switch on/off debugging messages.

Definition at line 71 of file GeometrySimple.hh.

Referenced by EnableDebugging(), and IsInBoundingBox().

◆ m_hasBoundingBox

bool Garfield::GeometrySimple::m_hasBoundingBox = false

protected

Definition at line 66 of file GeometrySimple.hh.

Referenced by AddSolid(), and IsInBoundingBox().

◆ m_medium

Medium* Garfield::GeometrySimple::m_medium = nullptr

protected

Background medium.

Definition at line 63 of file GeometrySimple.hh.

Referenced by Clear(), GetMedium(), and SetMedium().

◆ m_solids

std::vector<std::pair<Solid*, Medium*> > Garfield::GeometrySimple::m_solids

protected

List of solids and associated media.

Definition at line 61 of file GeometrySimple.hh.

Referenced by AddSolid(), Clear(), GetMedium(), GetNumberOfSolids(), GetSolid(), IsInside(), and PrintSolids().

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GeometrySimple()

◆ ~GeometrySimple()

Member Function Documentation

◆ AddSolid()

◆ Clear()

◆ EnableDebugging()

◆ GetBoundingBox()

◆ GetMedium()

◆ GetNumberOfSolids()

◆ GetSolid() [1/3]

◆ GetSolid() [2/3]

◆ GetSolid() [3/3]

◆ IsInBoundingBox()

◆ IsInside()

◆ PrintSolids()

◆ SetMedium()

Member Data Documentation

◆ m_bbMax

◆ m_bbMin

◆ m_debug

◆ m_hasBoundingBox

◆ m_medium

◆ m_solids