Garfield::GeometryRoot Class Reference

Use a geometry defined using the ROOT TGeo package. More...

#include <GeometryRoot.hh>

Inheritance diagram for Garfield::GeometryRoot:

Public Member Functions
	GeometryRoot ()
	Constructor.
	~GeometryRoot ()
	Destructor.
void	SetGeometry (TGeoManager *geoman)
	Set the geometry (pointer to ROOT TGeoManager).
Medium *	GetMedium (const double x, const double y, const double z, const bool tesselated=false) const override
	Retrieve the medium at a given point.
unsigned int	GetNumberOfMaterials ()
	Get the number of materials defined in the ROOT geometry.
TGeoMaterial *	GetMaterial (const unsigned int i)
	Get a pointer to the ROOT material with a given index.
TGeoMaterial *	GetMaterial (const char *name)
	Get a pointer to the ROOT material with a given name.
void	SetMedium (const unsigned int imat, Medium *med)
	Associate a ROOT material with a Garfield medium.
void	SetMedium (const char *mat, Medium *med)
	Associate a ROOT material with a Garfield medium.
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	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 debugging and warning messages on/off.
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 Member Functions
void	PrintGeoNotDefined (const std::string &fcn) const

Protected Attributes
TGeoManager *	m_geoManager = nullptr
std::map< std::string, Medium * >	m_materials
bool	m_debug = false
Protected Attributes inherited from Garfield::Geometry
std::string	m_className = "Geometry"

Detailed Description

Use a geometry defined using the ROOT TGeo package.

Definition at line 15 of file GeometryRoot.hh.

Constructor & Destructor Documentation

GeometryRoot()

Garfield::GeometryRoot::GeometryRoot

(

)

Constructor.

Definition at line 12 of file GeometryRoot.cc.

: Geometry("GeometryRoot") {}

~GeometryRoot()

Garfield::GeometryRoot::~GeometryRoot ( )

inline

Destructor.

Definition at line 20 of file GeometryRoot.hh.

{}

Member Function Documentation

EnableDebugging()

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

inline

Switch debugging and warning messages on/off.

Definition at line 45 of file GeometryRoot.hh.

{ m_debug = on; }

GetBoundingBox()

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

overridevirtual

Get the bounding box (envelope of the geometry).

Implements Garfield::Geometry.

Definition at line 134 of file GeometryRoot.cc.

                                                                            {
  if (!m_geoManager) return false;
  auto top = m_geoManager->GetTopVolume();
  if (!top) return false;
  if (!top->GetShape()) return false;
  TGeoBBox* box = (TGeoBBox*)m_geoManager->GetTopVolume()->GetShape();
  if (!box) return false;
  const double dx = box->GetDX();
  const double dy = box->GetDY();
  const double dz = box->GetDZ();
  const double ox = box->GetOrigin()[0];
  const double oy = box->GetOrigin()[1];
  const double oz = box->GetOrigin()[2];
  xmin = ox - dx;
  xmax = ox + dx;
  ymin = oy - dy;
  ymax = oy + dy;
  zmin = oz - dz;
  zmax = oz + dz;
  return true;
}

GetMaterial() [1/2]

TGeoMaterial * Garfield::GeometryRoot::GetMaterial

(

const char *

name

)

Get a pointer to the ROOT material with a given name.

Definition at line 54 of file GeometryRoot.cc.

                                                        {
  if (!m_geoManager) {
    PrintGeoNotDefined("GetMaterial");
    return nullptr;
  }
 
  return m_geoManager->GetMaterial(name);
}

GetMaterial() [2/2]

TGeoMaterial * Garfield::GeometryRoot::GetMaterial

(

const unsigned int

i

)

Get a pointer to the ROOT material with a given index.

Definition at line 45 of file GeometryRoot.cc.

                                                            {
  if (!m_geoManager) {
    PrintGeoNotDefined("GetMaterial");
    return nullptr;
  }
 
  return m_geoManager->GetMaterial(i);
}

GetMedium()

Medium * Garfield::GeometryRoot::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 23 of file GeometryRoot.cc.

                                                    {
  if (!m_geoManager) return nullptr;
  m_geoManager->SetCurrentPoint(x, y, z);
  if (m_geoManager->IsOutside()) return nullptr;
  TGeoNode* cnode = m_geoManager->GetCurrentNode();
  std::string name(cnode->GetMedium()->GetMaterial()->GetName());
 
  const auto it = m_materials.find(name);
  if (it == m_materials.end()) return nullptr;
  return it->second;
}

GetNumberOfMaterials()

unsigned int Garfield::GeometryRoot::GetNumberOfMaterials

(

)

Get the number of materials defined in the ROOT geometry.

Definition at line 36 of file GeometryRoot.cc.

                                                {
  if (!m_geoManager) {
    PrintGeoNotDefined("GetNumberOfMaterials");
    return 0;
  }
 
  return m_geoManager->GetListOfMaterials()->GetEntries();
}

IsInside()

bool Garfield::GeometryRoot::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 125 of file GeometryRoot.cc.

                                                {
  if (m_geoManager) {
    m_geoManager->SetCurrentPoint(x, y, z);
    return !m_geoManager->IsOutside();
  }
  return false;
}

PrintGeoNotDefined()

void Garfield::GeometryRoot::PrintGeoNotDefined ( const std::string &  fcn ) const

protected

Definition at line 157 of file GeometryRoot.cc.

                                                                {
 
  std::cerr << m_className + "::" + fcn << ":\n"
            << "    ROOT geometry is not defined. Call SetGeometry first.\n";
}

Referenced by GetMaterial(), GetNumberOfMaterials(), and SetMedium().

SetGeometry()

void Garfield::GeometryRoot::SetGeometry

(

TGeoManager *

geoman

)

Set the geometry (pointer to ROOT TGeoManager).

Definition at line 14 of file GeometryRoot.cc.

                                                  {
  if (!geoman) {
    std::cerr << m_className << "::SetGeometry: Null pointer.\n";
    return;
  }
  m_geoManager = geoman;
  m_materials.clear();
}

SetMedium() [1/2]

void Garfield::GeometryRoot::SetMedium	(	const char *	mat,
		Medium *	med
	)

Associate a ROOT material with a Garfield medium.

Definition at line 104 of file GeometryRoot.cc.

                                                          {
  if (!m_geoManager) {
    PrintGeoNotDefined("SetMedium");
    return;
  }
 
  if (!med) {
    std::cerr << m_className << "::SetMedium: Null pointer.\n";
    return;
  }
 
  const int imat = m_geoManager->GetMaterialIndex(name);
  if (imat < 0) {
    std::cerr << m_className << "::SetMedium:\n"
              << "    ROOT material " << name << " does not exist.\n";
    return;
  }
 
  SetMedium(imat, med);
}

SetMedium() [2/2]

void Garfield::GeometryRoot::SetMedium	(	const unsigned int	imat,
		Medium *	med
	)

Associate a ROOT material with a Garfield medium.

Definition at line 63 of file GeometryRoot.cc.

                                                                 {
  if (!m_geoManager) {
    PrintGeoNotDefined("SetMedium");
    return;
  }
 
  if (!med) {
    std::cerr << m_className << "::SetMedium: Null pointer.\n";
    return;
  }
 
  TGeoMaterial* mat = m_geoManager->GetMaterial(imat);
  if (!mat) {
    std::cerr << m_className << "::SetMedium:\n"
              << "    ROOT material " << imat << " does not exist.\n";
    return;
  }
 
  std::string name(mat->GetName());
 
  // Check if this material has already been associated with a medium.
  if (m_materials.count(name) > 0) {
    std::cout << m_className << "::SetMedium:\n"
              << "    Replacing existing association of material " << name
              << " with medium " << med->GetName() << ".\n";
  }
  m_materials[name] = med;
 
  // Check if material properties match
  const double rho1 = mat->GetDensity();
  const double rho2 = med->GetMassDensity();
  std::cout << m_className << "::SetMedium:\n"
            << "    ROOT material: " << name << "\n"
            << "      Density: " << rho1 << " g / cm3\n"
            << "    Medium: " << med->GetName() << "\n"
            << "      Density: " << rho2 << " g / cm3\n";
  if (rho1 > 0 && fabs(rho1 - rho2) / rho1 > 0.01) {
    std::cout << "    WARNING: Densities differ by > 1%.\n";
  }
}

Referenced by SetMedium().

Member Data Documentation

m_debug

bool Garfield::GeometryRoot::m_debug = false

protected

Definition at line 55 of file GeometryRoot.hh.

Referenced by EnableDebugging().

m_geoManager

TGeoManager* Garfield::GeometryRoot::m_geoManager = nullptr

protected

Definition at line 49 of file GeometryRoot.hh.

Referenced by GetBoundingBox(), GetMaterial(), GetMedium(), GetNumberOfMaterials(), IsInside(), SetGeometry(), and SetMedium().

m_materials

std::map<std::string, Medium*> Garfield::GeometryRoot::m_materials

protected

Definition at line 52 of file GeometryRoot.hh.

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

---

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

• GeometryRoot.hh
• GeometryRoot.cc