Garfield::Geometry Class Reference

Abstract base class for geometry classes. More...

#include <Geometry.hh>

Inheritance diagram for Garfield::Geometry:

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

Detailed Description

Abstract base class for geometry classes.

Definition at line 13 of file Geometry.hh.

Constructor & Destructor Documentation

Geometry() [1/2]

Garfield::Geometry::Geometry ( )

delete

Default constructor.

Geometry() [2/2]

Garfield::Geometry::Geometry ( const std::string &  name )

inline

Constructor.

Definition at line 18 of file Geometry.hh.

: m_className(name) {}

~Geometry()

virtual Garfield::Geometry::~Geometry ( )

inlinevirtual

Destructor.

Definition at line 20 of file Geometry.hh.

{}

Member Function Documentation

GetBoundingBox()

virtual bool Garfield::Geometry::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::Component::GetBoundingBox(), Garfield::ComponentNeBem2d::GetBoundingBox(), and Garfield::ComponentParallelPlate::GetBoundingBox().

GetMedium()

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

pure virtual

Retrieve the medium at a given point.

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

Referenced by Garfield::ComponentAnalyticField::ElectricField(), Garfield::ComponentParallelPlate::ElectricField(), Garfield::Component::GetMedium(), Garfield::ComponentAnalyticField::GetMedium(), Garfield::ComponentNeBem2d::GetMedium(), Garfield::ComponentNeBem3d::GetMedium(), and Garfield::ComponentParallelPlate::GetMedium().

GetNumberOfSolids()

virtual size_t Garfield::Geometry::GetNumberOfSolids ( ) const

inlinevirtual

Return the number of solids in the geometry.

Reimplemented in Garfield::GeometrySimple.

Definition at line 27 of file Geometry.hh.

{ return 0; }

Referenced by Garfield::ComponentNeBem3d::GetVolume(), and Garfield::ComponentNeBem3d::Initialise().

GetSolid() [1/2]

virtual Solid * Garfield::Geometry::GetSolid ( const  size_t ) const

inlinevirtual

Get a solid from the list.

Reimplemented in Garfield::GeometrySimple.

Definition at line 29 of file Geometry.hh.

{ return nullptr; }

Referenced by Garfield::ComponentNeBem3d::GetVolume(), and Garfield::ComponentNeBem3d::Initialise().

GetSolid() [2/2]

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

inlinevirtual

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

Reimplemented in Garfield::GeometrySimple.

Definition at line 31 of file Geometry.hh.

                                                                 {
    medium = nullptr;
    return nullptr;
  }

IsInside()

virtual bool Garfield::Geometry::IsInside ( const double  x, const double  y, const double  z, const bool  tesselated = false  ) 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::Geometry::m_className = "Geometry"

protected

Definition at line 44 of file Geometry.hh.

Referenced by Garfield::GeometrySimple::AddSolid(), 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:

• Geometry.hh