Garfield::GeometrySimple Class Reference

#include <GeometrySimple.hh>

Inheritance diagram for Garfield::GeometrySimple:

Classes
struct	medium
struct	solid

Public Member Functions
	GeometrySimple ()
virtual	~GeometrySimple ()
void	AddSolid (Solid *s, Medium *m)
Solid *	GetSolid (const double x, const double y, const double z) const
Medium *	GetMedium (const double x, const double y, const double z) const
unsigned int	GetNumberOfSolids () const
unsigned int	GetNumberOfMedia () const
Solid *	GetSolid (const unsigned int i) const
virtual Medium *	GetMedium (const unsigned int i) const
void	Clear ()
void	PrintSolids ()
bool	IsInside (const double x, const double y, const double z) const
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)
void	EnableDebugging ()
void	DisableDebugging ()
Public Member Functions inherited from Garfield::GeometryBase
	GeometryBase ()
virtual	~GeometryBase ()
virtual Medium *	GetMedium (const double x, const double y, const double z) const =0
virtual bool	IsInside (const double x, const double y, const double z) const =0
virtual bool	GetBoundingBox (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax)=0

Protected Attributes
unsigned int	m_nMedia
std::vector< medium >	m_media
unsigned int	m_nSolids
std::vector< solid >	m_solids
bool	m_hasBoundingBox
double	m_xMinBoundingBox
double	m_yMinBoundingBox
double	m_zMinBoundingBox
double	m_xMaxBoundingBox
double	m_yMaxBoundingBox
double	m_zMaxBoundingBox
bool	m_debug
Protected Attributes inherited from Garfield::GeometryBase
std::string	m_className

Detailed Description

Definition at line 13 of file GeometrySimple.hh.

Constructor & Destructor Documentation

GeometrySimple()

Garfield::GeometrySimple::GeometrySimple

(

)

Definition at line 6 of file GeometrySimple.cc.

    : m_nMedia(0), m_nSolids(0), 
      m_hasBoundingBox(false), m_debug(false) {
 
  m_className = "GeometrySimple";
 
  m_media.clear();
  m_solids.clear();
}

~GeometrySimple()

virtual Garfield::GeometrySimple::~GeometrySimple ( )

inlinevirtual

Definition at line 19 of file GeometrySimple.hh.

{}

Member Function Documentation

AddSolid()

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

Definition at line 16 of file GeometrySimple.cc.

                                                 {
 
  // Make sure the solid and the medium are defined.
  if (!s) {
    std::cerr << m_className << "::AddSolid:\n";
    std::cerr << "    Solid pointer is null.\n";
    return;
  }
 
  if (!m) {
    std::cerr << m_className << "::AddSolid:\n";
    std::cerr << "    Medium pointer is null.\n";
    return;
  }
 
  int n = -1;
  int id = m->GetId();
  // Check if this medium is already in the list
  for (unsigned int i = 0; i < m_nMedia; ++i) {
    if (id == m_media[i].medium->GetId()) {
      n = i;
      break;
    }
  }
  // If the medium does not exist yet, add it to the list
  if (n < 0) {
    medium newMedium;
    newMedium.medium = m;
    m_media.push_back(newMedium);
    n = m_nMedia;
    ++m_nMedia;
  }
 
  // 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:\n";
    std::cerr << "    Solid has no bounding box.\n";
    return;
  }
 
  if (m_hasBoundingBox) {
    if (xmin < m_xMinBoundingBox) m_xMinBoundingBox = xmin;
    if (ymin < m_yMinBoundingBox) m_yMinBoundingBox = ymin;
    if (zmin < m_zMinBoundingBox) m_zMinBoundingBox = zmin;
    if (xmax > m_xMaxBoundingBox) m_xMaxBoundingBox = xmax;
    if (ymax > m_yMaxBoundingBox) m_yMaxBoundingBox = ymax;
    if (zmax > m_zMaxBoundingBox) 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
  solid newSolid;
  newSolid.solid = s;
  newSolid.medium = n;
  m_solids.push_back(newSolid);
  ++m_nSolids;
}

Referenced by GarfieldPhysics::CreateGeometry().

Clear()

void Garfield::GeometrySimple::Clear

(

)

Definition at line 127 of file GeometrySimple.cc.

                           {
 
  m_media.clear();
  m_solids.clear();
  m_nMedia = 0;
  m_nSolids = 0;
}

DisableDebugging()

void Garfield::GeometrySimple::DisableDebugging ( )

inline

Definition at line 53 of file GeometrySimple.hh.

{ m_debug = false; }

EnableDebugging()

void Garfield::GeometrySimple::EnableDebugging ( )

inline

Definition at line 52 of file GeometrySimple.hh.

{ m_debug = true; }

GetBoundingBox()

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

inlinevirtual

Implements Garfield::GeometryBase.

Definition at line 40 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

virtual

Implements Garfield::GeometryBase.

Definition at line 94 of file GeometrySimple.cc.

                                                                                      {
 
  for (unsigned int i = 0; i < m_nSolids; ++i) {
    if (m_solids[i].solid->IsInside(x, y, z)) {
      if (m_solids[i].medium < 0) return NULL;
      return m_media[m_solids[i].medium].medium;
    }
  }
  return NULL;
}

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

GetMedium() [2/2]

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

virtual

Definition at line 116 of file GeometrySimple.cc.

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

GetNumberOfMedia()

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

inline

Definition at line 29 of file GeometrySimple.hh.

{ return m_nMedia; }

GetNumberOfSolids()

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

inline

Definition at line 28 of file GeometrySimple.hh.

{ return m_nSolids; }

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

GetSolid() [1/2]

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

Definition at line 83 of file GeometrySimple.cc.

                                                      {
 
  for (unsigned int i = 0; i < m_nSolids; ++i) {
    if (m_solids[i].solid->IsInside(x, y, z)) {
      return m_solids[i].solid;
    }
  }
  return NULL;
}

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

GetSolid() [2/2]

Solid * Garfield::GeometrySimple::GetSolid

(

const unsigned int

i

)

const

Definition at line 105 of file GeometrySimple.cc.

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

IsInBoundingBox()

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

Definition at line 169 of file GeometrySimple.cc.

                                                           {
 
  if (!m_hasBoundingBox) {
    if (m_debug) {
      std::cerr << m_className << "::IsInBoundingBox:\n";
      std::cerr << "    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

virtual

Implements Garfield::GeometryBase.

Definition at line 158 of file GeometrySimple.cc.

                                                    {
 
  if (!IsInBoundingBox(x, y, z)) return false;
 
  for (unsigned int i = 0; i < m_nSolids; ++i) {
    if (m_solids[i].solid->IsInside(x, y, z)) return true;
  }
  return false;
}

PrintSolids()

void Garfield::GeometrySimple::PrintSolids

(

)

Definition at line 135 of file GeometrySimple.cc.

                                 {
 
  std::cout << m_className << "::PrintSolids:\n";
  if (m_nSolids == 1) {
    std::cout << "    1 solid\n";
  } else {
    std::cout << "    " << m_nSolids << " solids\n";
  }
  if (m_nSolids == 0) return;
  std::cout << "      Index      Type    Medium\n";
  for (unsigned int i = 0; i < m_nSolids; ++i) {
    std::cout << "        " << i << "         ";
    if (m_solids[i].solid->IsBox()) {
      std::cout << "box      ";
    } else if (m_solids[i].solid->IsTube()) {
      std::cout << "tube     ";
    } else {
      std::cout << "unknown  ";
    }
    std::cout << m_media[m_solids[i].medium].medium->GetName() << "\n";
  }
}

Member Data Documentation

m_debug

bool Garfield::GeometrySimple::m_debug

protected

Definition at line 77 of file GeometrySimple.hh.

Referenced by DisableDebugging(), EnableDebugging(), and IsInBoundingBox().

m_hasBoundingBox

bool Garfield::GeometrySimple::m_hasBoundingBox

protected

Definition at line 72 of file GeometrySimple.hh.

Referenced by AddSolid(), and IsInBoundingBox().

m_media

std::vector<medium> Garfield::GeometrySimple::m_media

protected

Definition at line 61 of file GeometrySimple.hh.

Referenced by AddSolid(), Clear(), GeometrySimple(), GetMedium(), and PrintSolids().

m_nMedia

unsigned int Garfield::GeometrySimple::m_nMedia

protected

Definition at line 57 of file GeometrySimple.hh.

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

m_nSolids

unsigned int Garfield::GeometrySimple::m_nSolids

protected

Definition at line 64 of file GeometrySimple.hh.

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

m_solids

std::vector<solid> Garfield::GeometrySimple::m_solids

protected

Definition at line 69 of file GeometrySimple.hh.

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

m_xMaxBoundingBox

double Garfield::GeometrySimple::m_xMaxBoundingBox

protected

Definition at line 74 of file GeometrySimple.hh.

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

m_xMinBoundingBox

double Garfield::GeometrySimple::m_xMinBoundingBox

protected

Definition at line 73 of file GeometrySimple.hh.

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

m_yMaxBoundingBox

double Garfield::GeometrySimple::m_yMaxBoundingBox

protected

Definition at line 74 of file GeometrySimple.hh.

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

m_yMinBoundingBox

double Garfield::GeometrySimple::m_yMinBoundingBox

protected

Definition at line 73 of file GeometrySimple.hh.

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

m_zMaxBoundingBox

double Garfield::GeometrySimple::m_zMaxBoundingBox

protected

Definition at line 74 of file GeometrySimple.hh.

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

m_zMinBoundingBox

double Garfield::GeometrySimple::m_zMinBoundingBox

protected

Definition at line 73 of file GeometrySimple.hh.

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

---

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

• GeometrySimple.hh
• GeometrySimple.cc