Garfield::SolidSphere Class Reference

Sphere. More...

#include <SolidSphere.hh>

Inheritance diagram for Garfield::SolidSphere:

Public Member Functions
	SolidSphere (const double cx, const double cy, const double cz, const double rmin, const double rmax)
	Constructor.
	~SolidSphere ()
	Destructor.
virtual bool	IsInside (const double x, const double y, const double z) const
	Check whether a given point is inside the solid.
virtual bool	GetBoundingBox (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) const
	Return the bounding box of the solid.
virtual bool	IsSphere () const
	Return true if the solid is a sphere.
virtual bool	GetCenter (double &x, double &y, double &z) const
virtual bool	GetDimensions (double &l1, double &l2, double &l3) const
virtual bool	GetOrientation (double &ctheta, double &stheta, double &cphi, double &sphi) const
void	SetInnerRadius (const double rmin)
void	SetOuterRadius (const double rmax)
Public Member Functions inherited from Garfield::Solid
	Solid ()
	Constructor.
virtual	~Solid ()
	Destructor.
virtual bool	IsInside (const double x, const double y, const double z) const =0
	Check whether a given point is inside the solid.
virtual bool	GetBoundingBox (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) const =0
	Return the bounding box of the solid.
virtual bool	IsBox () const
	Return true if the solid is a box.
virtual bool	IsTube () const
	Return true if the solid is a tube.
virtual bool	IsSphere () const
	Return true if the solid is a sphere.
virtual bool	GetCenter (double &x, double &y, double &z) const =0
virtual bool	GetDimensions (double &l1, double &l2, double &l3) const =0
virtual bool	GetOrientation (double &ctheta, double &stheta, double &cphi, double &shpi) const =0
void	EnableDebugging ()
	Switch on debugging messages.
void	DisableDebugging ()

Additional Inherited Members
Protected Attributes inherited from Garfield::Solid
bool	m_debug

Detailed Description

Sphere.

Definition at line 10 of file SolidSphere.hh.

Constructor & Destructor Documentation

SolidSphere()

Garfield::SolidSphere::SolidSphere	(	const double	cx,
		const double	cy,
		const double	cz,
		const double	rmin,
		const double	rmax
	)

Constructor.

Definition at line 10 of file SolidSphere.cc.

    : Solid(),
      m_cX(cx), m_cY(cy), m_cZ(cz),
      m_rMin(rmin), m_rMax(rmax) {}

~SolidSphere()

Garfield::SolidSphere::~SolidSphere ( )

inline

Destructor.

Definition at line 17 of file SolidSphere.hh.

{}

Member Function Documentation

GetBoundingBox()

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

virtual

Return the bounding box of the solid.

Implements Garfield::Solid.

Definition at line 51 of file SolidSphere.cc.

                                                                                 {
 
  xmin = m_cX - m_rMax;
  xmax = m_cX + m_rMax;
  ymin = m_cY - m_rMax;
  ymax = m_cY + m_rMax;
  zmin = m_cZ - m_rMax;
  zmax = m_cZ + m_rMax;
  return true;
}

GetCenter()

bool Garfield::SolidSphere::GetCenter ( double &  x, double &  y, double &  z  ) const

virtual

Implements Garfield::Solid.

Definition at line 63 of file SolidSphere.cc.

                                                                 {
 
  x = m_cX;
  y = m_cY;
  z = m_cZ;
  return true;
}

GetDimensions()

bool Garfield::SolidSphere::GetDimensions ( double &  l1, double &  l2, double &  l3  ) const

virtual

Implements Garfield::Solid.

Definition at line 71 of file SolidSphere.cc.

                                                                        {
 
  l1 = m_rMin;
  l2 = m_rMax;
  l3 = 0.;
  return true;
}

GetOrientation()

bool Garfield::SolidSphere::GetOrientation ( double &  ctheta, double &  stheta, double &  cphi, double &  sphi  ) const

virtual

Implements Garfield::Solid.

Definition at line 79 of file SolidSphere.cc.

                                                     {
 
  ctheta = 1.;
  stheta = 0.;
  cphi = 1.;
  sphi = 0.;
  return true;
}

IsInside()

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

virtual

Check whether a given point is inside the solid.

Implements Garfield::Solid.

Definition at line 16 of file SolidSphere.cc.

                                                 {
 
  // Transform the point to local coordinates
  const double dx = x - m_cX;
  const double dy = y - m_cY;
  const double dz = z - m_cZ;
 
  if (fabs(dx) > m_rMax || fabs(dy) > m_rMax || fabs(dz) > m_rMax) {
    if (m_debug) {
      std::cout << "SolidSphere::IsInside:\n";
      std::cout << "    (" << x << ", " << y << ", " << z << ")"
                << " is outside.\n";
    }
    return false;
  }
 
  const double r = sqrt(dx * dx + dy * dy + dz * dz);
  if (r >= m_rMin && r <= m_rMax) {
    if (m_debug) {
      std::cout << "SolidSphere::IsInside:\n";
      std::cout << "    (" << x << ", " << y << ", " << z << ")"
                << " is inside.\n";
    }
    return true;
  }
 
  if (m_debug) {
    std::cout << "SolidSphere::IsInside:\n";
    std::cout << "    (" << x << ", " << y << ", " << z << ") "
              << " is outside.\n";
  }
  return false;
}

IsSphere()

virtual bool Garfield::SolidSphere::IsSphere ( ) const

inlinevirtual

Return true if the solid is a sphere.

Reimplemented from Garfield::Solid.

Definition at line 22 of file SolidSphere.hh.

{ return true; }

SetInnerRadius()

void Garfield::SolidSphere::SetInnerRadius

(

const double

rmin

)

Definition at line 89 of file SolidSphere.cc.

                                                  {
 
  if (rmin <= 0.) {
    std::cerr << "SolidSphere::SetInnerRadius:\n";
    std::cerr << "    Radius must be > 0.\n";
    return;
  }
  if (rmin >= m_rMax) {
    std::cerr << "SolidSphere::SetInnerRadius:\n";
    std::cerr << "    Inner radius must be smaller than outer radius.\n";
    return;
  }
  m_rMin = rmin;
}

SetOuterRadius()

void Garfield::SolidSphere::SetOuterRadius

(

const double

rmax

)

Definition at line 104 of file SolidSphere.cc.

                                                  {
 
  if (rmax <= 0.) {
    std::cerr << "SolidSphere::SetOuterRadius:\n";
    std::cerr << "    Radius must be > 0.\n";
    return;
  }
  if (rmax <= m_rMin) {
    std::cerr << "SolidSphere::SetOuterRadius:\n";
    std::cerr << "    Outer radius must be greater than inner radius.\n";
    return;
  }
  m_rMax = rmax;
}

---

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

• SolidSphere.hh
• SolidSphere.cc