celeritas::orangeinp::Solid< T > Class Template Reference

A shape that has undergone an intersection or combination of intersections. More...

#include <Solid.hh>

Inheritance diagram for celeritas::orangeinp::Solid< T >:

Public Types
Type aliases
using	OptionalRegion = std::optional< T >
Public Types inherited from celeritas::orangeinp::ObjectInterface
using	SPConstObject = std::shared_ptr< ObjectInterface const >
using	VolumeBuilder = detail::VolumeBuilder

Public Member Functions
	Solid (std::string &&label, T &&interior, OptionalRegion &&excluded, SolidEnclosedAngle &&enclosed)
	Construct with optional optional excluded region and enclosed angle.
	Solid (std::string &&label, T &&interior, SolidEnclosedAngle &&enclosed)
	Construct with an enclosed angle.
	Solid (std::string &&label, T &&interior, T &&excluded)
	Construct with an excluded interior.
	Solid (std::string &&label, T &&interior, SolidZSlab &&z_slab)
	Construct with only a z-slab.
std::string_view	label () const final
	Get the user-provided label.
IntersectRegionInterface const &	interior () const final
	Interior intersect region interface for construction and access.
IntersectRegionInterface const *	excluded () const final
	Access the optional excluded.
SolidEnclosedAngle	enclosed_angle () const final
	Optional angular restriction.
SolidZSlab	z_slab () const final
	Optional z-slab intersection.
Public Member Functions inherited from celeritas::orangeinp::SolidBase
NodeId	build (VolumeBuilder &) const final
	Construct a volume from this shape.
void	output (JsonPimpl *) const final
	Output to JSON.
Public Member Functions inherited from celeritas::orangeinp::ObjectInterface
virtual	~ObjectInterface ()=0
	Anchored default destructor.

Static Public Member Functions
static SPConstObject	or_shape (std::string &&label, T &&interior, OptionalRegion &&excluded, SolidEnclosedAngle &&enclosed)
	Return a solid or shape given an optional interior or enclosed angle.

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

Detailed Description

template<class T>
class celeritas::orangeinp::Solid< T >

A shape that has undergone an intersection or combination of intersections.

This shape may be: A) hollow (exluded interior), B) truncated azimuthally (enclosed angle), C) truncated in z (intersected with z-slab), D) both A and B.

Examples:

// A cone with a thickness of 0.1
Solid s{"cone", Cone{{1, 2}, 10.0}, Cone{{0.9, 1.9}, 10.0}};
// A cylinder segment in z={-2.5, 2.5}, r={0.5, 0.75}, theta={-45, 45} deg
Solid s{"cyl", Cylinder{0.75, 5.0}, Cylinder{0.5, 5.0},
        {Turn{0}, Turn{0.25}};
// The east-facing quarter of a cone shape
Solid s{"cone", Cone{{1, 2}, 10.0}, {Turn{-0.125}, Turn{0.25}};

Member Function Documentation

enclosed_angle()

template<class T >

SolidEnclosedAngle celeritas::orangeinp::Solid< T >::enclosed_angle ( ) const

inlinefinalvirtual

Optional angular restriction.

Implements celeritas::orangeinp::SolidBase.

excluded()

template<class T >

IntersectRegionInterface const * celeritas::orangeinp::Solid< T >::excluded ( ) const

finalvirtual

Access the optional excluded.

Implements celeritas::orangeinp::SolidBase.

interior()

template<class T >

IntersectRegionInterface const & celeritas::orangeinp::Solid< T >::interior ( ) const

inlinefinalvirtual

Interior intersect region interface for construction and access.

Implements celeritas::orangeinp::SolidBase.

label()

template<class T >

std::string_view celeritas::orangeinp::Solid< T >::label ( ) const

inlinefinalvirtual

Get the user-provided label.

Implements celeritas::orangeinp::ObjectInterface.

z_slab()

template<class T >

SolidZSlab celeritas::orangeinp::Solid< T >::z_slab ( ) const

inlinefinalvirtual

Optional z-slab intersection.

Implements celeritas::orangeinp::SolidBase.

---

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

• Solid.hh
• Solid.cc