"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 override
	Retrieve the medium at a given point.

unsigned int	GetNumberOfMedia () const
	Get the number of media in the geometry.

Medium *	GetMedium (const unsigned int i) const
	Get a medium from the list.

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

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

Solid *	GetSolid (const unsigned int 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
	Get the solid at a given location (x, y, z).

void	Clear ()
	Reset the geometry.

void	PrintSolids ()

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

bool	IsInBoundingBox (const double x, const double y, const double z) const

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)

Public Member Functions inherited from Garfield::GeometryBase
	GeometryBase ()=default
	Constructor.

virtual	~GeometryBase ()
	Destructor.

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

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

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

virtual Solid *	GetSolid (const unsigned int, 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 =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< Medium * >	m_media
	List of media.

std::vector< std::pair< Solid *, int > >	m_solids
	List of solids.

bool	m_hasBoundingBox = false

double	m_xMinBoundingBox

double	m_yMinBoundingBox

double	m_zMinBoundingBox

double	m_xMaxBoundingBox

double	m_yMaxBoundingBox

double	m_zMaxBoundingBox

bool	m_debug = false
	Switch on/off debugging messages.

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

Detailed Description

"Native" geometry, using simple shapes.

Definition at line 12 of file GeometrySimple.hh.

Constructor & Destructor Documentation

◆ GeometrySimple()

Garfield::GeometrySimple::GeometrySimple ( )

Constructor.

Definition at line 7 of file GeometrySimple.cc.

                               : GeometryBase() {
  m_className = "GeometrySimple";
}

◆ ~GeometrySimple()

virtual Garfield::GeometrySimple::~GeometrySimple ( )

inlinevirtual

Destructor.

Definition at line 17 of file GeometrySimple.hh.

17{}

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 11 of file GeometrySimple.cc.

                                                 {
  // Make sure the solid and the medium are defined.
  if (!s || !m) {
    std::cerr << m_className << "::AddSolid: Null pointer.\n";
    return;
  }
 
  // Check if this medium is already in the list
  const unsigned int nMedia = m_media.size();
  unsigned int n = nMedia;
  const int id = m->GetId();
  for (unsigned int i = 0; i < nMedia; ++i) {
    if (id == m_media[i]->GetId()) {
      n = i;
      break;
    }
  }
  // If the medium does not exist yet, add it to the list
  if (n == nMedia) m_media.push_back(m);
 
  // Update the bounding box ranges
  double xmin, ymin, zmin;
  double xmax, ymax, zmax;
  if (!s->GetBoundingBox(xmin, ymin, zmin, xmax, ymax, zmax)) {
    std::cerr << m_className << "::AddSolid: Solid has no bounding box.\n";
    return;
  }
 
  if (m_hasBoundingBox) {
    m_xMinBoundingBox = std::min(m_xMinBoundingBox, xmin);
    m_yMinBoundingBox = std::min(m_yMinBoundingBox, ymin);
    m_zMinBoundingBox = std::min(m_zMinBoundingBox, zmin);
    m_xMaxBoundingBox = std::max(m_xMaxBoundingBox, xmax);
    m_yMaxBoundingBox = std::max(m_yMaxBoundingBox, ymax);
    m_zMaxBoundingBox = std::max(m_zMaxBoundingBox, zmax);
  } else {
    m_xMinBoundingBox = xmin;
    m_yMinBoundingBox = ymin;
    m_zMinBoundingBox = zmin;
    m_xMaxBoundingBox = xmax;
    m_yMaxBoundingBox = ymax;
    m_zMaxBoundingBox = zmax;
    m_hasBoundingBox = true;
  }
 
  // Add the new solid to the list.
  m_solids.emplace_back(std::make_pair(s, n));
}

Referenced by GarfieldPhysics::CreateGeometry().

◆ Clear()

void Garfield::GeometrySimple::Clear ( )

Reset the geometry.

Definition at line 109 of file GeometrySimple.cc.

                           {
  m_media.clear();
  m_solids.clear();
}

◆ EnableDebugging()

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

inline

Definition at line 54 of file GeometrySimple.hh.

54{ m_debug = on; }

Garfield::GeometrySimple::m_debug

bool m_debug

Switch on/off debugging messages.

Definition: GeometrySimple.hh:69

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

Definition at line 42 of file GeometrySimple.hh.

                                                           {
    xmin = m_xMinBoundingBox;
    ymin = m_yMinBoundingBox;
    zmin = m_zMinBoundingBox;
    xmax = m_xMaxBoundingBox;
    ymax = m_yMaxBoundingBox;
    zmax = m_zMaxBoundingBox;
    return true;
  }

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

◆ GetMedium() [1/2]

Medium * Garfield::GeometrySimple::GetMedium	(	const double	x,
		const double	y,
		const double	z
	)		const

overridevirtual

Retrieve the medium at a given point.

Implements Garfield::GeometryBase.

Definition at line 68 of file GeometrySimple.cc.

                                                        {
  for (const auto& solid : m_solids) {
    if (solid.first->IsInside(x, y, z)) {
      if (solid.second < 0) return nullptr;
      return m_media[solid.second];
    }
  }
  return nullptr;
}

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

◆ GetMedium() [2/2]

Medium * Garfield::GeometrySimple::GetMedium ( const unsigned int i ) const

Get a medium from the list.

Definition at line 100 of file GeometrySimple.cc.

                                                            {
  if (i >= m_media.size()) {
    std::cerr << m_className << "::GetMedium:\n"
              << "    Requested medium " << i << " does not exist.\n";
    return nullptr;
  }
  return m_media[i];
}

◆ GetNumberOfMedia()

unsigned int Garfield::GeometrySimple::GetNumberOfMedia ( ) const

inline

Get the number of media in the geometry.

Definition at line 22 of file GeometrySimple.hh.

22{ return m_media.size(); }

◆ GetNumberOfSolids()

unsigned int Garfield::GeometrySimple::GetNumberOfSolids ( ) const

inlineoverridevirtual

Return the number of solids in the geometry.

Reimplemented from Garfield::GeometryBase.

Definition at line 26 of file GeometrySimple.hh.

26{ return m_solids.size(); }

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

◆ GetSolid() [1/3]

Solid * Garfield::GeometrySimple::GetSolid	(	const double	x,
		const double	y,
		const double	z
	)		const

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

Definition at line 60 of file GeometrySimple.cc.

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

◆ GetSolid() [2/3]

Solid * Garfield::GeometrySimple::GetSolid ( const unsigned int ) const

overridevirtual

Get a solid from the list.

Reimplemented from Garfield::GeometryBase.

Definition at line 79 of file GeometrySimple.cc.

                                                          {
  if (i >= m_solids.size()) {
    std::cerr << m_className << "::GetSolid:\n"
              << "    Requested solid " << i << " does not exist.\n";
    return nullptr;
  }
 
  return m_solids[i].first;
}

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

◆ GetSolid() [3/3]

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

overridevirtual

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

Reimplemented from Garfield::GeometryBase.

Definition at line 89 of file GeometrySimple.cc.

                                                                           {
  if (i >= m_solids.size()) {
    std::cerr << m_className << "::GetSolid:\n"
              << "    Requested solid " << i << " does not exist.\n";
    return nullptr;
  }
 
  medium = m_media[m_solids[i].second];
  return m_solids[i].first;
}

◆ IsInBoundingBox()

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

Definition at line 149 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_xMinBoundingBox && x <= m_xMaxBoundingBox &&
      y >= m_yMinBoundingBox && y <= m_yMaxBoundingBox &&
      z >= m_zMinBoundingBox && z <= m_zMaxBoundingBox)
    return true;
  return false;
}

Referenced by IsInside().

◆ IsInside()

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

overridevirtual

Check if a point is inside the geometry.

Implements Garfield::GeometryBase.

Definition at line 139 of file GeometrySimple.cc.

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

◆ PrintSolids()

void Garfield::GeometrySimple::PrintSolids ( )

Definition at line 114 of file GeometrySimple.cc.

                                 {
  std::cout << m_className << "::PrintSolids:\n";
  const unsigned int 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 (unsigned int 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 {
      std::cout << "unknown  ";
    }
    std::cout << m_media[m_solids[i].second]->GetName() << "\n";
  }
}

Member Data Documentation

◆ m_debug

bool Garfield::GeometrySimple::m_debug = false

protected

Switch on/off debugging messages.

Definition at line 69 of file GeometrySimple.hh.

Referenced by EnableDebugging(), and IsInBoundingBox().

◆ m_hasBoundingBox

bool Garfield::GeometrySimple::m_hasBoundingBox = false

protected

Definition at line 64 of file GeometrySimple.hh.

Referenced by AddSolid(), and IsInBoundingBox().

◆ m_media

std::vector<Medium*> Garfield::GeometrySimple::m_media

protected

List of media.

Definition at line 58 of file GeometrySimple.hh.

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

◆ m_solids

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

protected

List of solids.

Definition at line 61 of file GeometrySimple.hh.

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

◆ m_xMaxBoundingBox

double Garfield::GeometrySimple::m_xMaxBoundingBox

protected

Definition at line 66 of file GeometrySimple.hh.

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

◆ m_xMinBoundingBox

double Garfield::GeometrySimple::m_xMinBoundingBox

protected

Definition at line 65 of file GeometrySimple.hh.

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

◆ m_yMaxBoundingBox

double Garfield::GeometrySimple::m_yMaxBoundingBox

protected

Definition at line 66 of file GeometrySimple.hh.

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

◆ m_yMinBoundingBox

double Garfield::GeometrySimple::m_yMinBoundingBox

protected

Definition at line 65 of file GeometrySimple.hh.

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

◆ m_zMaxBoundingBox

double Garfield::GeometrySimple::m_zMaxBoundingBox

protected

Definition at line 66 of file GeometrySimple.hh.

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

◆ m_zMinBoundingBox

double Garfield::GeometrySimple::m_zMinBoundingBox

protected

Definition at line 65 of file GeometrySimple.hh.

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

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() [1/2]

◆ GetMedium() [2/2]

◆ GetNumberOfMedia()

◆ GetNumberOfSolids()

◆ GetSolid() [1/3]

◆ GetSolid() [2/3]

◆ GetSolid() [3/3]

◆ IsInBoundingBox()

◆ IsInside()

◆ PrintSolids()

Member Data Documentation

◆ m_debug

◆ m_hasBoundingBox

◆ m_media

◆ m_solids

◆ m_xMaxBoundingBox

◆ m_xMinBoundingBox

◆ m_yMaxBoundingBox

◆ m_yMinBoundingBox

◆ m_zMaxBoundingBox

◆ m_zMinBoundingBox