celeritas::optical::CoreParams Class Reference

Shared parameters for the optical photon loop. More...

#include <CoreParams.hh>

Inheritance diagram for celeritas::optical::CoreParams:

Classes
struct	Input

Public Types
Type aliases
using	SPActionRegistry = std::shared_ptr< ActionRegistry >
using	SPOutputRegistry = std::shared_ptr< OutputRegistry >
using	SPGeneratorRegistry = std::shared_ptr< GeneratorRegistry >
using	SPAuxRegistry = std::shared_ptr< AuxParamsRegistry >
using	SPConstCoreGeo = std::shared_ptr< CoreGeoParams const >
using	SPConstMaterial = std::shared_ptr< MaterialParams const >
using	SPConstPhysics = std::shared_ptr< PhysicsParams const >
using	SPConstRng = std::shared_ptr< RngParams const >
using	SPConstSim = std::shared_ptr< SimParams const >
using	SPConstVolume = std::shared_ptr< VolumeParams const >
using	SPConstSurface = std::shared_ptr< SurfaceParams const >
using	SPConstSurfacePhysics = std::shared_ptr< SurfacePhysicsParams const >
using	SPConstDetectors = std::shared_ptr< DetectorParams const >
using	SPConstCherenkov = std::shared_ptr< CherenkovParams const >
using	SPConstScintillation = std::shared_ptr< ScintillationParams const >
template<MemSpace M>
using	ConstRef = CoreParamsData< Ownership::const_reference, M >
template<MemSpace M>
using	ConstPtr = ObserverPtr< ConstRef< M > const, M >
Public Types inherited from celeritas::ParamsDataInterface< CoreParamsData >
using	HostRef = HostCRef< CoreParamsData >
using	DeviceRef = DeviceCRef< CoreParamsData >

Public Member Functions
	CoreParams (Input &&inp)
	Construct with all problem data, creating some actions too.
template<MemSpace M>
ConstPtr< M >	ptr () const
OpticalSizes const &	sizes () const
	Per-process state and buffer capacities.
size_type	max_streams () const
	Maximum number of streams.
Data interface
HostRef const &	host_ref () const final
	Access data on the host.
DeviceRef const &	device_ref () const final
	Access data on the device.
SPConstCoreGeo const &	geometry () const
SPConstMaterial const &	material () const
SPConstPhysics const &	physics () const
SPConstRng const &	rng () const
SPConstSim const &	sim () const
SPConstVolume const &	volume () const
SPConstSurface const &	surface () const
SPConstSurfacePhysics const &	surface_physics () const
SPActionRegistry const &	action_reg () const
SPOutputRegistry const &	output_reg () const
SPAuxRegistry const &	aux_reg () const
SPGeneratorRegistry const &	gen_reg () const
SPConstDetectors const &	detectors () const
SPConstCherenkov const &	cherenkov () const
SPConstScintillation const &	scintillation () const
Public Member Functions inherited from celeritas::ParamsDataInterface< CoreParamsData >
CoreParamsData< Ownership::const_reference, M > const &	ref () const
CoreParamsData< Ownership::const_reference, M > const &	ref () const
	Dispatch a "ref" call to host or device data.

Additional Inherited Members
Protected Member Functions inherited from celeritas::ParamsDataInterface< CoreParamsData >
	ParamsDataInterface (ParamsDataInterface const &)=default
	ParamsDataInterface (ParamsDataInterface &&)=default
ParamsDataInterface &	operator= (ParamsDataInterface const &)=default
ParamsDataInterface &	operator= (ParamsDataInterface &&)=default

Detailed Description

Shared parameters for the optical photon loop.

Member Function Documentation

action_reg()

SPActionRegistry const & celeritas::optical::CoreParams::action_reg ( ) const

inline

Access shared problem parameter data.

aux_reg()

SPAuxRegistry const & celeritas::optical::CoreParams::aux_reg ( ) const

inline

Access shared problem parameter data.

cherenkov()

SPConstCherenkov const & celeritas::optical::CoreParams::cherenkov ( ) const

inline

Access shared problem parameter data.

detectors()

SPConstDetectors const & celeritas::optical::CoreParams::detectors ( ) const

inline

Access shared problem parameter data.

device_ref()

DeviceRef const & celeritas::optical::CoreParams::device_ref ( ) const

inlinefinalvirtual

Access data on the device.

Implements celeritas::ParamsDataInterface< CoreParamsData >.

gen_reg()

SPGeneratorRegistry const & celeritas::optical::CoreParams::gen_reg ( ) const

inline

Access shared problem parameter data.

geometry()

SPConstCoreGeo const & celeritas::optical::CoreParams::geometry ( ) const

inline

Access shared problem parameter data.

host_ref()

HostRef const & celeritas::optical::CoreParams::host_ref ( ) const

inlinefinalvirtual

Access data on the host.

Implements celeritas::ParamsDataInterface< CoreParamsData >.

material()

SPConstMaterial const & celeritas::optical::CoreParams::material ( ) const

inline

Access shared problem parameter data.

output_reg()

SPOutputRegistry const & celeritas::optical::CoreParams::output_reg ( ) const

inline

Access shared problem parameter data.

physics()

SPConstPhysics const & celeritas::optical::CoreParams::physics ( ) const

inline

Access shared problem parameter data.

rng()

SPConstRng const & celeritas::optical::CoreParams::rng ( ) const

inline

Access shared problem parameter data.

scintillation()

SPConstScintillation const & celeritas::optical::CoreParams::scintillation ( ) const

inline

Access shared problem parameter data.

sim()

SPConstSim const & celeritas::optical::CoreParams::sim ( ) const

inline

Access shared problem parameter data.

surface()

SPConstSurface const & celeritas::optical::CoreParams::surface ( ) const

inline

Access shared problem parameter data.

surface_physics()

SPConstSurfacePhysics const & celeritas::optical::CoreParams::surface_physics ( ) const

inline

Access shared problem parameter data.

volume()

SPConstVolume const & celeritas::optical::CoreParams::volume ( ) const

inline

Access shared problem parameter data.

---

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

• optical/CoreParams.hh
• optical/CoreParams.cc