Types.hh File Reference

#include "corecel/Macros.hh"
#include "celeritas/Types.hh"

Typedefs
using	celeritas::optical::LocalSurfaceId = OpaqueId< struct LocalSurface_, unsigned short int >
	Opaque index of sub-surface interface.
using	celeritas::optical::LocalPositionId = OpaqueId< struct LocalMat_, unsigned short int >
	Opaque index of sub-surface material region.
using	celeritas::ScintSpectrumId = OpaqueId< struct ScintSpectrumRecord >

Enumerations
enum class	celeritas::GeneratorType {   cherenkov , scintillation , wls , wls2 ,   size_ }
	Process used to generate optical photons.
enum class	celeritas::optical::SurfacePhysicsOrder { roughness , reflectivity , interaction , size_ }
	Ordering of surface physics boundary crossing models. More...
enum class	celeritas::optical::LocalDirection : bool { reverse = false , forward = true }
	Traversal direction of a sub-subsurface.
enum class	celeritas::optical::ReflectionMode {   specular_spike , specular_lobe , backscatter , diffuse_lobe ,   size_ = diffuse_lobe }
	Possible reflection moes for UNIFIED reflection model.
enum class	celeritas::optical::TrivialInteractionMode { absorb , transmit , backscatter }
	Trivial interaction modes. More...
enum class	celeritas::optical::ReflectivityAction { transmit , interact , absorb , size_ = absorb }
	Results of a reflectivity substep. More...
enum class	celeritas::optical::WlsDistribution { delta , exponential , size_ }
	Optical photon wavelength shifting time model. More...

Functions
char const *	celeritas::optical::to_cstring (GeneratorType value)
	Get a string corresponding to the photon generating process.
char const *	celeritas::optical::to_cstring (SurfacePhysicsOrder step)
	Get a string corresponding to an optical surface physics step.
char const *	celeritas::optical::to_cstring (ReflectionMode mode)
	Get a string corresponding to a UNIFIED reflection mode.
char const *	celeritas::optical::to_cstring (WlsDistribution value)
	Get a string corresponding to the wavelength shifting time model selection.
constexpr int	celeritas::optical::to_signed_offset (LocalDirection d)
	Convert sub-surface direction to a sign (+1/-1 for forward/reverse resp.)

Enumeration Type Documentation

ReflectivityAction

enum class celeritas::optical::ReflectivityAction

strong

Results of a reflectivity substep.

Enumerator
transmit	transmit with no change
interact	continue to sample surface interaction
absorb	absorb on surface

SurfacePhysicsOrder

enum class celeritas::optical::SurfacePhysicsOrder

strong

Ordering of surface physics boundary crossing models.

Enumerator
roughness	Sample a facet normal.
reflectivity	Select physics override.
interaction	Apply reflection and refraction.

TrivialInteractionMode

enum class celeritas::optical::TrivialInteractionMode

strong

Trivial interaction modes.

Enumerator
absorb	absorb on surface
transmit	transmit with no change
backscatter	back scatter

WlsDistribution

enum class celeritas::optical::WlsDistribution

strong

Optical photon wavelength shifting time model.

Todo:

replace with OnedDistributionType

Enumerator
delta	Delta function.
exponential	Exponential decay.