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

Return a "name" for a face. More...

#include <FaceNamer.hh>

Public Member Functions

 FaceNamer (std::string &&prefix)
 Construct with prefix.
 
template<class S >
std::string operator() (Sense s, S const &surf)
 Apply to a surface with known type.
 
std::string operator() (Sense s, VariantSurface const &surf)
 Apply to a surface with unknown type.
 
std::string operator() (std::string const &s) const
 Apply with an explicit face name. More...
 

Detailed Description

Return a "name" for a face.

This is generally a very short string to be used as an extension for a volume comprised of several intersecting surface half-spaces. Because successive surfaces should have separate names, this has a small internal state.

Member Function Documentation

◆ operator()()

std::string celeritas::FaceNamer::operator() ( std::string const &  s) const
inline

Apply with an explicit face name.

This can be useful for instances such as "generic trapezoid" where the surface type can change based on whether the face is planar or twisted.


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