Celeritas  0.5.0-86+4a8eea4
Public Member Functions | List of all members
celeritas::orangeinp::Shape< T > Class Template Referencefinal

Shape that holds an intersect region and forwards construction args to it. More...

#include <Shape.hh>

Inheritance diagram for celeritas::orangeinp::Shape< T >:
Inheritance graph
[legend]

Public Member Functions

template<class... Ts>
 Shape (std::string &&label, Ts... region_args)
 Construct with a label and arguments of the intersect region.
 
 Shape (std::string &&label, T &&region)
 Construct with a label and intersect region.
 
std::string_view label () const final
 Get the user-provided label.
 
IntersectRegionInterface const & interior () const final
 Interior intersect region.
 
- Public Member Functions inherited from celeritas::orangeinp::ShapeBase
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.
 

Additional Inherited Members

- Public Types inherited from celeritas::orangeinp::ObjectInterface
using SPConstObject = std::shared_ptr< ObjectInterface const >
 
using VolumeBuilder = detail::VolumeBuilder
 
- Protected Member Functions inherited from celeritas::orangeinp::ShapeBase
 ShapeBase ()=default
 
 CELER_DEFAULT_COPY_MOVE (ShapeBase)
 
- Protected Member Functions inherited from celeritas::orangeinp::ObjectInterface
 ObjectInterface ()=default
 
 CELER_DEFAULT_COPY_MOVE (ObjectInterface)
 

Detailed Description

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

Shape that holds an intersect region and forwards construction args to it.

Construct as:

BoxShape s{"mybox", Real3{1, 2, 3}};
Array< real_type, 3 > Real3
Three-dimensional cartesian coordinates.
Definition: geocel/Types.hh:22

or

Shape s{"mybox", Box{{1, 2, 3}}};
Shape(std::string &&label, Ts... region_args)
Construct with a label and arguments of the intersect region.
Definition: Shape.hh:82

See IntersectRegion.hh for a list of the regions and their construction arguments.


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