celeritas::orangeinp::Prism Class Reference

A regular, z-extruded polygon centered on the origin. More...

#include <IntersectRegion.hh>

Inheritance diagram for celeritas::orangeinp::Prism:

Public Member Functions
	Prism (int num_sides, real_type apothem, real_type halfheight, real_type orientation)
	Construct with inner radius (apothem), half height, and orientation.
void	build (IntersectSurfaceBuilder &) const final
	Build surfaces.
void	output (JsonPimpl *) const final
	Write output to the given JSON object.
bool	encloses (Prism const &other) const
	Whether this encloses another prism.
int	num_sides () const
	Number of sides.
real_type	apothem () const
	Inner radius.
real_type	halfheight () const
	Half the Z height.
real_type	orientation () const
	Rotation factor.

Additional Inherited Members
Protected Member Functions inherited from celeritas::orangeinp::IntersectRegionInterface
	CELER_DEFAULT_COPY_MOVE (IntersectRegionInterface)

Detailed Description

A regular, z-extruded polygon centered on the origin.

This is the base component of a G4Polyhedra (PGON). The default rotation is to put the first point at \( y = 0 \). Looking at an x-y slice for a prism with apothem a, odd-numbered prisms have a plane at \( x=-a \):

• \( n=3 \) is a triangle pointing right,
• \( n=4 \) is a diamond,
• \( n=5 \) is a tilted pentagon (flat on the left), and
• \( n=6 \) is a flat-top hexagon.

The "orientation" parameter is a scaled counterclockwise rotation on \([0, 1)\), where zero preserves the orientation described above, and unity would replicate the original shape but with the "p0" face being where the "p1" originally was. With a value of 0.5:

• \( n=3 \) is a triangle pointing left
• \( n=4 \) is an upright square,
• \( n=5 \) is a tilted pentagon (flat on the right), and
• \( n=6 \) is a pointy-top hexagon.

Member Function Documentation

build()

void celeritas::orangeinp::Prism::build ( IntersectSurfaceBuilder &  insert_surface ) const

finalvirtual

Build surfaces.

Implements celeritas::orangeinp::IntersectRegionInterface.

output()

void celeritas::orangeinp::Prism::output ( JsonPimpl *  j ) const

finalvirtual

Write output to the given JSON object.

Implements celeritas::orangeinp::IntersectRegionInterface.

---

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

• IntersectRegion.hh
• IntersectRegion.cc