Garfield::GeometryBase Class Reference

Abstract base class for geometry classes. More...

#include <GeometryBase.hh>

Inheritance diagram for Garfield::GeometryBase:

Public Member Functions
	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::string	m_className = "GeometryBase"

Detailed Description

Abstract base class for geometry classes.

Definition at line 13 of file GeometryBase.hh.

Constructor & Destructor Documentation

GeometryBase()

Garfield::GeometryBase::GeometryBase ( )

default

Constructor.

~GeometryBase()

virtual Garfield::GeometryBase::~GeometryBase ( )

inlinevirtual

Destructor.

Definition at line 18 of file GeometryBase.hh.

{}

Member Function Documentation

GetBoundingBox()

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

pure virtual

Get the bounding box (envelope of the geometry).

Implemented in Garfield::GeometryRoot, and Garfield::GeometrySimple.

Referenced by Garfield::ComponentAnalyticField::GetBoundingBox(), Garfield::ComponentBase::GetBoundingBox(), and Garfield::ComponentNeBem2d::GetBoundingBox().

GetMedium()

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

pure virtual

Retrieve the medium at a given point.

Implemented in Garfield::GeometryRoot, and Garfield::GeometrySimple.

Referenced by Garfield::ComponentAnalyticField::ElectricField(), Garfield::ComponentBase::GetMedium(), Garfield::ComponentAnalyticField::GetMedium(), and Garfield::ComponentNeBem2d::GetMedium().

GetNumberOfSolids()

virtual unsigned int Garfield::GeometryBase::GetNumberOfSolids ( ) const

inlinevirtual

Return the number of solids in the geometry.

Reimplemented in Garfield::GeometrySimple.

Definition at line 25 of file GeometryBase.hh.

{ return 0; }

Referenced by Garfield::ComponentNeBem3d::Initialise().

GetSolid() [1/2]

virtual Solid * Garfield::GeometryBase::GetSolid ( const unsigned int  ) const

inlinevirtual

Get a solid from the list.

Reimplemented in Garfield::GeometrySimple.

Definition at line 27 of file GeometryBase.hh.

{ return nullptr; }

Referenced by Garfield::ComponentNeBem3d::Initialise().

GetSolid() [2/2]

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

inlinevirtual

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

Reimplemented in Garfield::GeometrySimple.

Definition at line 29 of file GeometryBase.hh.

                                                                       {
    medium = nullptr;
    return nullptr;
  }

IsInside()

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

pure virtual

Check if a point is inside the geometry.

Implemented in Garfield::GeometryRoot, and Garfield::GeometrySimple.

Member Data Documentation

m_className

std::string Garfield::GeometryBase::m_className = "GeometryBase"

protected

Definition at line 42 of file GeometryBase.hh.

Referenced by Garfield::GeometrySimple::AddSolid(), Garfield::GeometryRoot::GeometryRoot(), Garfield::GeometrySimple::GeometrySimple(), Garfield::GeometrySimple::GetMedium(), Garfield::GeometrySimple::GetSolid(), Garfield::GeometrySimple::IsInBoundingBox(), Garfield::GeometryRoot::PrintGeoNotDefined(), Garfield::GeometrySimple::PrintSolids(), Garfield::GeometryRoot::SetGeometry(), and Garfield::GeometryRoot::SetMedium().

---

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

• GeometryBase.hh