Celeritas  0.5.0-86+4a8eea4
Classes | Public Member Functions | List of all members
celeritas::optical::CoreParams Class Referencefinal

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

#include <CoreParams.hh>

Inheritance diagram for celeritas::optical::CoreParams:
Inheritance graph
[legend]

Classes

struct  Input
 

Public Types

Type aliases
using SPConstGeo = std::shared_ptr< GeoParams const >
 
using SPConstMaterial = std::shared_ptr< MaterialParams 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

Access data on the host

HostRef const & host_ref () const final
 Access data on the device.
 
DeviceRef const & device_ref () const final
 Access data on the device.
 
SPConstGeo const & geometry () const
 
SPConstMaterial const & material () 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
 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.

◆ geometry()

SPConstGeo const& celeritas::optical::CoreParams::geometry ( ) const
inline

Access shared problem parameter data.

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

◆ 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: