Celeritas 0.7.0-dev.194+develop.0df4cab59
Loading...
Searching...
No Matches
Public Member Functions | List of all members
celeritas::orangeinp::CutCylinder Class Referencefinal

A z-aligned cylinder centered on the origin, with top/bottom cuts. More...

#include <IntersectRegion.hh>

Inheritance diagram for celeritas::orangeinp::CutCylinder:
Inheritance graph
[legend]

Public Member Functions

 CutCylinder (real_type radius, real_type halfheight, Real3 const &bottom_normal, Real3 const &top_normal)
 Construct with radius, half-height, and bottom/top cutting plane normals.
 
void build (IntersectSurfaceBuilder &) const final
 Build surfaces.
 
void output (JsonPimpl *) const final
 Write output to the given JSON object.
 
bool encloses (CutCylinder const &other) const
 Whether this encloses another cut cylinder.
 
real_type radius () const
 Radius.
 
real_type halfheight () const
 Half-height along Z.
 
Real3 constbottom_normal () const
 Outward-facing normal of the bottom cuting plane.
 
Real3 consttop_normal () const
 Outward-facing normal of the top cuting plane.
 

Additional Inherited Members

- Protected Member Functions inherited from celeritas::orangeinp::IntersectRegionInterface
 CELER_DEFAULT_COPY_MOVE (IntersectRegionInterface)
 

Detailed Description

A z-aligned cylinder centered on the origin, with top/bottom cuts.

The shape is defined with a radius, half-height, and the outward-facing normals of the cutting planes, passing through \((0, 0, \pm \mathrm{hh})\).

Member Function Documentation

◆ build()

void celeritas::orangeinp::CutCylinder::build ( IntersectSurfaceBuilder insert_surface) const
finalvirtual

◆ output()

void celeritas::orangeinp::CutCylinder::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: