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	SPConstGeo = std::shared_ptr< GeoParams const >
using	SPConstMaterial = std::shared_ptr< MaterialParams const >
using	SPConstPhysics = std::shared_ptr< PhysicsParams const >
using	SPConstRng = std::shared_ptr< RngParams const >
using	SPConstTrackInit = std::shared_ptr< TrackInitParams const >
using	SPActionRegistry = std::shared_ptr< ActionRegistry >
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
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.
SPConstGeo const &	geometry () const
SPConstMaterial const &	material () const
SPConstPhysics const &	physics () const
SPConstRng const &	rng () const
SPConstTrackInit const &	init () const
SPActionRegistry const &	action_reg () 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 >
	CELER_DEFAULT_COPY_MOVE (ParamsDataInterface)

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.

device_ref()

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

inlinefinalvirtual

Access data on the device.

Implements celeritas::ParamsDataInterface< CoreParamsData >.

geometry()

SPConstGeo 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 >.

init()

SPConstTrackInit const & celeritas::optical::CoreParams::init ( ) const

inline

Access shared problem parameter data.

material()

SPConstMaterial const & celeritas::optical::CoreParams::material ( ) 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.

---

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

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