org.lcsim.detector.solids

Class RightRegularPolyhedron

java.lang.Object

org.lcsim.detector.solids.AbstractSolid

org.lcsim.detector.solids.RightRegularPolyhedron

All Implemented Interfaces:

ISolid

public class RightRegularPolyhedron
extends AbstractSolid

This class encapsulates the behavior of a right regular polyhedron whose principal axis is aligned with the z axis and whose parallel ends are made of regular polygons. The polygons have a flat base at the bottom. The polyhedron is allowed to be hollow by specifying an inner radius for an inner polyhedron coaxial along z. For now it must have the same number of sides with the same orientation.

Version:

$Id: RightRegularPolyhedron.java,v 1.4 2010/04/22 21:18:39 ngraf Exp $

Author:

Norman A. Graf

Field Summary

Fields

Modifier and Type	Field and Description
private RegularPolygon	_innerPolygon
private boolean	_isHollow
private int	_nsides
private RegularPolygon	_outerPolygon
private double	_rmax
private double	_rmin
private double	_zmax
private double	_zmin

Fields inherited from class org.lcsim.detector.solids.AbstractSolid

name

Constructor Summary

Constructors

Constructor and Description
RightRegularPolyhedron(String name, int nsides, double radius, double zmin, double zmax) Fully qualified constructor for a solid right regular polyhedron.
RightRegularPolyhedron(String name, int nsides, double rmin, double rmax, double zmin, double zmax) Fully qualified constructor for a hollow right regular polyhedron.

Method Summary

Methods

Modifier and Type	Method and Description
double	getCubicVolume()
RegularPolygon	getInnerPolygon() The polygon representing the 2D end faces of the inner boundary of this solid.
int	getNumberOfSides()
RegularPolygon	getOuterPolygon() The polygon representing the 2D end faces.
double	getRMax()
double	getRMin() The radius of the inscribe polygon if hollow.
double	getZMax()
double	getZMin()
Inside	inside(Hep3Vector pos) Determines whether a point lies within or outside of this solid.
boolean	isHollow() Is this a hollow polygon?
double	polygonalArea() Returns the area of the polygonal face
private double	t(Hep3Vector a, Hep3Vector b, Hep3Vector c)
String	toString()
double	volume() Returns the volume of this solid

Methods inherited from class org.lcsim.detector.solids.AbstractSolid

getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_nsides

private int _nsides

_rmin

private double _rmin

_rmax

private double _rmax

_zmin

private double _zmin

_zmax

private double _zmax

_innerPolygon

private RegularPolygon _innerPolygon

_outerPolygon

private RegularPolygon _outerPolygon

_isHollow

private boolean _isHollow

Constructor Detail

RightRegularPolyhedron

public RightRegularPolyhedron(String name,
                      int nsides,
                      double rmin,
                      double rmax,
                      double zmin,
                      double zmax)

Fully qualified constructor for a hollow right regular polyhedron.

Parameters:

name - the name of this solid

nsides - the number of sides of the regular polygon forming the ends.

rmin - the radius of the inner polygon's inscribed circle

rmax - the radius of the outer polygon's circumscribed circle

zmin - the minimum z extent

zmax - the maximum z extent

RightRegularPolyhedron

public RightRegularPolyhedron(String name,
                      int nsides,
                      double radius,
                      double zmin,
                      double zmax)

Fully qualified constructor for a solid right regular polyhedron.

Parameters:

name - the name of this solid

nsides - the number of sides of the regular polygon forming the ends.

radius - the radius of the outer polygon's circumscribed circle

zmin - the minimum z extent

zmax - the maximum z extent

Method Detail

getCubicVolume

public double getCubicVolume()

inside

public Inside inside(Hep3Vector pos)

Determines whether a point lies within or outside of this solid.

Parameters:

pos - the point to check

Returns:

an enumeration of INSIDE or OUTSIDE ( SURFACE is reported as INSIDE)

polygonalArea

public double polygonalArea()

Returns the area of the polygonal face

Returns:

the area of polygon forming the face of this solid

isHollow

public boolean isHollow()

Is this a hollow polygon?

Returns:

true if this polygon is hollow

volume

public double volume()

Returns the volume of this solid

Returns:

the volume of this solid

toString

public String toString()

Overrides:

toString in class Object

getNumberOfSides

public int getNumberOfSides()

Returns:

the number of equal sides of the polygonal faces

getZMin

public double getZMin()

Returns:

the minimum z extent of this solid

getZMax

public double getZMax()

Returns:

the maximal z extent of this solid

getRMin

public double getRMin()

The radius of the inscribe polygon if hollow. Returns zero if the polygon is not hollow

Returns:

the radius of the inscribed circle

getRMax

public double getRMax()

Returns:

the radius of the circumscribed circle

getInnerPolygon

public RegularPolygon getInnerPolygon()

The polygon representing the 2D end faces of the inner boundary of this solid. Note that z=0.

Returns:

null if the solid is not hollow.

getOuterPolygon

public RegularPolygon getOuterPolygon()

The polygon representing the 2D end faces. Note that z=0.

Returns:

The polygon representing the end faces

t

private double t(Hep3Vector a,
       Hep3Vector b,
       Hep3Vector c)