Celeritas  0.5.0-86+4a8eea4
Public Member Functions | List of all members
celeritas::orangeinp::SolidEnclosedAngle Class Reference

Define the angular region of a solid. More...

#include <Solid.hh>

Public Types

Type aliases
using SenseWedge = std::pair< Sense, InfWedge >
 

Public Member Functions

 SolidEnclosedAngle ()=default
 Default to "all angles".
 
 SolidEnclosedAngle (Turn start, Turn interior)
 Construct from a starting angle and interior angle.
 
SenseWedge make_wedge () const
 Construct a wedge shape to intersect (inside) or subtract (outside).
 
 operator bool () const
 Whether the enclosed angle is not a full circle.
 
Turn start () const
 Starting angle.
 
Turn interior () const
 Interior angle.
 

Detailed Description

Define the angular region of a solid.

This is a pie slice infinite along the z axis and outward from it. Its cross section is in the x-y plane, and a start angle of zero corresponding to the +x axis. An interior angle of one results in no radial excluded in the resulting solid. A interior angle of more than 0.5 turns (180 degrees) results in a wedge being subtracted from the solid, and an angle of less than or equal to 0.5 turns results in the intersection of the solid with a wedge.

// Truncates a solid to the east-facing quadrant:
SolidEnclosedAngle{Turn{-0.125}, Turn{0.25}};
// Removes the second quadrant (northwest) from a solid:
Quantity< TwoPi, real_type > Turn
Quantity denoting a full turn.
Definition: Turn.hh:45
SolidEnclosedAngle()=default
Default to "all angles".

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