celeritas::ParamsDataInterface< P > Class Template Reference

Interface class for accessing "collection groups" of parameter data. More...

#include <ParamsDataInterface.hh>

Inherited by celeritas::AuxParams< StatusCheckParamsData, StatusCheckStateData >, celeritas::AuxParams< AuxMockParamsData, AuxMockStateData >, celeritas::ParamsDataStore< ParticleTallyParamsData >, celeritas::ParamsDataStore< celeritas::AtomicRelaxParamsData >, celeritas::ParamsDataStore< celeritas::CherenkovData >, celeritas::ParamsDataStore< celeritas::NeutronElasticData >, celeritas::ParamsDataStore< celeritas::CuHipRngParamsData >, celeritas::ParamsDataStore< celeritas::CutoffParamsData >, celeritas::ParamsDataStore< celeritas::CylMapFieldParamsData >, celeritas::ParamsDataStore< celeritas::DTMixMucfData >, celeritas::ParamsDataStore< celeritas::DetectorParamsData >, celeritas::ParamsDataStore< celeritas::ElectroNuclearData >, celeritas::ParamsDataStore< celeritas::FluctuationData >, celeritas::ParamsDataStore< celeritas::GammaNuclearData >, celeritas::ParamsDataStore< celeritas::GeoMaterialParamsData >, celeritas::ParamsDataStore< celeritas::ImageParamsData >, celeritas::ParamsDataStore< celeritas::LivermorePEData >, celeritas::ParamsDataStore< celeritas::MaterialParamsData >, celeritas::ParamsDataStore< celeritas::MuPairProductionData >, celeritas::ParamsDataStore< celeritas::NeutronInelasticData >, celeritas::ParamsDataStore< celeritas::OrangeParamsData >, celeritas::ParamsDataStore< celeritas::ParticleParamsData >, celeritas::ParamsDataStore< celeritas::RZMapFieldParamsData >, celeritas::ParamsDataStore< celeritas::RanluxppRngParamsData >, celeritas::ParamsDataStore< celeritas::RayleighData >, celeritas::ParamsDataStore< celeritas::RelativisticBremData >, celeritas::ParamsDataStore< celeritas::ScintillationData >, celeritas::ParamsDataStore< celeritas::SeltzerBergerData >, celeritas::ParamsDataStore< celeritas::SimParamsData >, celeritas::ParamsDataStore< SimpleCaloParamsData >, celeritas::ParamsDataStore< celeritas::StatusCheckParamsData >, celeritas::ParamsDataStore< celeritas::SurfaceParamsData >, celeritas::ParamsDataStore< celeritas::TrackInitParamsData >, celeritas::ParamsDataStore< celeritas::UniformFieldParamsData >, celeritas::ParamsDataStore< celeritas::UrbanMscData >, celeritas::ParamsDataStore< celeritas::VecgeomParamsData >, celeritas::ParamsDataStore< celeritas::WentzelOKVIData >, celeritas::ParamsDataStore< celeritas::WentzelVIMscData >, celeritas::ParamsDataStore< celeritas::XorwowRngParamsData >, celeritas::ParamsDataStore< celeritas::optical::DielectricData >, celeritas::ParamsDataStore< celeritas::optical::UnifiedReflectionData >, celeritas::ParamsDataStore< celeritas::optical::GaussianRoughnessData >, celeritas::ParamsDataStore< celeritas::optical::MaterialParamsData >, celeritas::ParamsDataStore< celeritas::optical::MieData >, celeritas::ParamsDataStore< celeritas::optical::PhysicsParamsData >, celeritas::ParamsDataStore< celeritas::DistributionParamsData >, celeritas::ParamsDataStore< celeritas::optical::SimParamsData >, celeritas::ParamsDataStore< celeritas::optical::SmearRoughnessData >, celeritas::ParamsDataStore< celeritas::optical::SurfacePhysicsParamsData >, celeritas::ParamsDataStore< celeritas::optical::TrivialInteractionData >, celeritas::ParamsDataStore< celeritas::optical::WavelengthShiftData >, celeritas::ParamsDataStore< celeritas::test::AuxMockParamsData >, celeritas::ParamsDataStore< celeritas::test::MockInteractData >, celeritas::AuxParams< P, S >, and celeritas::ParamsDataStore< P >.

Public Types
Type aliases
using	HostRef = HostCRef< P >
using	DeviceRef = DeviceCRef< P >

Public Member Functions
virtual HostRef const &	host_ref () const =0
	Reference CPU geometry data.
virtual DeviceRef const &	device_ref () const =0
	Reference managed GPU geometry data.
template<MemSpace M>
P< Ownership::const_reference, M > const &	ref () const
template<MemSpace M>
P< Ownership::const_reference, M > const &	ref () const
	Dispatch a "ref" call to host or device data.

Protected Member Functions
	ParamsDataInterface (ParamsDataInterface const &)=default
ParamsDataInterface &	operator= (ParamsDataInterface const &)=default
	ParamsDataInterface (ParamsDataInterface &&)=default
ParamsDataInterface &	operator= (ParamsDataInterface &&)=default

Detailed Description

template<template< Ownership, MemSpace > class P>
class celeritas::ParamsDataInterface< P >

Interface class for accessing "collection groups" of parameter data.

This class provides typedefs to host and devie data, and a templated switching function that dispatches to "virtual" functions.

Note

Mark child implementations of the host/device ref functions as final to optimize out any virtual function calls.

Member Function Documentation

device_ref()

template<template< Ownership, MemSpace > class P>

virtual DeviceRef const & celeritas::ParamsDataInterface< P >::device_ref ( ) const

pure virtual

Reference managed GPU geometry data.

Implemented in celeritas::AtomicRelaxationParams, celeritas::FluctuationParams, celeritas::UrbanMscParams, celeritas::WentzelOKVIParams, celeritas::WentzelVIMscParams, celeritas::CartMapFieldParams, celeritas::CylMapFieldParams, celeritas::RZMapFieldParams, celeritas::UniformFieldParams, celeritas::GeoMaterialParams, celeritas::CoreParams, celeritas::MaterialParams, celeritas::optical::CoreParams, celeritas::CherenkovParams, celeritas::ScintillationParams, celeritas::optical::MaterialParams, celeritas::optical::PhysicsParams, celeritas::optical::SimParams, celeritas::optical::SurfacePhysicsParams, celeritas::CutoffParams, celeritas::ParticleParams, celeritas::PhysicsParams, celeritas::SimParams, celeritas::StatusChecker, celeritas::TrackInitParams, celeritas::ParamsDataStore< P >, celeritas::ParamsDataStore< celeritas::AtomicRelaxParamsData >, celeritas::ParamsDataStore< celeritas::CherenkovData >, celeritas::ParamsDataStore< celeritas::CuHipRngParamsData >, celeritas::ParamsDataStore< celeritas::CutoffParamsData >, celeritas::ParamsDataStore< celeritas::CylMapFieldParamsData >, celeritas::ParamsDataStore< celeritas::DetectorParamsData >, celeritas::ParamsDataStore< celeritas::DistributionParamsData >, celeritas::ParamsDataStore< celeritas::DTMixMucfData >, celeritas::ParamsDataStore< celeritas::ElectroNuclearData >, celeritas::ParamsDataStore< celeritas::FluctuationData >, celeritas::ParamsDataStore< celeritas::GammaNuclearData >, celeritas::ParamsDataStore< celeritas::GeoMaterialParamsData >, celeritas::ParamsDataStore< celeritas::ImageParamsData >, celeritas::ParamsDataStore< celeritas::LivermorePEData >, celeritas::ParamsDataStore< celeritas::MaterialParamsData >, celeritas::ParamsDataStore< celeritas::MuPairProductionData >, celeritas::ParamsDataStore< celeritas::NeutronElasticData >, celeritas::ParamsDataStore< celeritas::NeutronInelasticData >, celeritas::ParamsDataStore< celeritas::optical::DielectricData >, celeritas::ParamsDataStore< celeritas::optical::GaussianRoughnessData >, celeritas::ParamsDataStore< celeritas::optical::MaterialParamsData >, celeritas::ParamsDataStore< celeritas::optical::MieData >, celeritas::ParamsDataStore< celeritas::optical::PhysicsParamsData >, celeritas::ParamsDataStore< celeritas::optical::SimParamsData >, celeritas::ParamsDataStore< celeritas::optical::SmearRoughnessData >, celeritas::ParamsDataStore< celeritas::optical::SurfacePhysicsParamsData >, celeritas::ParamsDataStore< celeritas::optical::TrivialInteractionData >, celeritas::ParamsDataStore< celeritas::optical::UnifiedReflectionData >, celeritas::ParamsDataStore< celeritas::optical::WavelengthShiftData >, celeritas::ParamsDataStore< celeritas::OrangeParamsData >, celeritas::ParamsDataStore< celeritas::ParticleParamsData >, celeritas::ParamsDataStore< celeritas::RanluxppRngParamsData >, celeritas::ParamsDataStore< celeritas::RayleighData >, celeritas::ParamsDataStore< celeritas::RelativisticBremData >, celeritas::ParamsDataStore< celeritas::RZMapFieldParamsData >, celeritas::ParamsDataStore< celeritas::ScintillationData >, celeritas::ParamsDataStore< celeritas::SeltzerBergerData >, celeritas::ParamsDataStore< celeritas::SimParamsData >, celeritas::ParamsDataStore< celeritas::StatusCheckParamsData >, celeritas::ParamsDataStore< celeritas::SurfaceParamsData >, celeritas::ParamsDataStore< celeritas::test::AuxMockParamsData >, celeritas::ParamsDataStore< celeritas::test::MockInteractData >, celeritas::ParamsDataStore< celeritas::TrackInitParamsData >, celeritas::ParamsDataStore< celeritas::UniformFieldParamsData >, celeritas::ParamsDataStore< celeritas::UrbanMscData >, celeritas::ParamsDataStore< celeritas::VecgeomParamsData >, celeritas::ParamsDataStore< celeritas::WentzelOKVIData >, celeritas::ParamsDataStore< celeritas::WentzelVIMscData >, celeritas::ParamsDataStore< celeritas::XorwowRngParamsData >, celeritas::ParamsDataStore< ParticleTallyParamsData >, celeritas::ParamsDataStore< SimpleCaloParamsData >, celeritas::CuHipRngParams, celeritas::RanluxppRngParams, celeritas::XorwowRngParams, celeritas::DetectorParams, celeritas::GeantGeoParams, celeritas::ImageParams, celeritas::SurfaceParams, celeritas::VecgeomParams, celeritas::OrangeParams, and celeritas::test::AuxMockParams.

host_ref()

template<template< Ownership, MemSpace > class P>

virtual HostRef const & celeritas::ParamsDataInterface< P >::host_ref ( ) const

pure virtual

Reference CPU geometry data.

Implemented in celeritas::AtomicRelaxationParams, celeritas::FluctuationParams, celeritas::UrbanMscParams, celeritas::WentzelOKVIParams, celeritas::WentzelVIMscParams, celeritas::CartMapFieldParams, celeritas::CylMapFieldParams, celeritas::RZMapFieldParams, celeritas::UniformFieldParams, celeritas::GeoMaterialParams, celeritas::CoreParams, celeritas::MaterialParams, celeritas::optical::CoreParams, celeritas::CherenkovParams, celeritas::ScintillationParams, celeritas::optical::MaterialParams, celeritas::optical::PhysicsParams, celeritas::optical::SimParams, celeritas::optical::SurfacePhysicsParams, celeritas::CutoffParams, celeritas::ParticleParams, celeritas::PhysicsParams, celeritas::SimParams, celeritas::StatusChecker, celeritas::TrackInitParams, celeritas::ParamsDataStore< P >, celeritas::ParamsDataStore< celeritas::AtomicRelaxParamsData >, celeritas::ParamsDataStore< celeritas::CherenkovData >, celeritas::ParamsDataStore< celeritas::CuHipRngParamsData >, celeritas::ParamsDataStore< celeritas::CutoffParamsData >, celeritas::ParamsDataStore< celeritas::CylMapFieldParamsData >, celeritas::ParamsDataStore< celeritas::DetectorParamsData >, celeritas::ParamsDataStore< celeritas::DistributionParamsData >, celeritas::ParamsDataStore< celeritas::DTMixMucfData >, celeritas::ParamsDataStore< celeritas::ElectroNuclearData >, celeritas::ParamsDataStore< celeritas::FluctuationData >, celeritas::ParamsDataStore< celeritas::GammaNuclearData >, celeritas::ParamsDataStore< celeritas::GeoMaterialParamsData >, celeritas::ParamsDataStore< celeritas::ImageParamsData >, celeritas::ParamsDataStore< celeritas::LivermorePEData >, celeritas::ParamsDataStore< celeritas::MaterialParamsData >, celeritas::ParamsDataStore< celeritas::MuPairProductionData >, celeritas::ParamsDataStore< celeritas::NeutronElasticData >, celeritas::ParamsDataStore< celeritas::NeutronInelasticData >, celeritas::ParamsDataStore< celeritas::optical::DielectricData >, celeritas::ParamsDataStore< celeritas::optical::GaussianRoughnessData >, celeritas::ParamsDataStore< celeritas::optical::MaterialParamsData >, celeritas::ParamsDataStore< celeritas::optical::MieData >, celeritas::ParamsDataStore< celeritas::optical::PhysicsParamsData >, celeritas::ParamsDataStore< celeritas::optical::SimParamsData >, celeritas::ParamsDataStore< celeritas::optical::SmearRoughnessData >, celeritas::ParamsDataStore< celeritas::optical::SurfacePhysicsParamsData >, celeritas::ParamsDataStore< celeritas::optical::TrivialInteractionData >, celeritas::ParamsDataStore< celeritas::optical::UnifiedReflectionData >, celeritas::ParamsDataStore< celeritas::optical::WavelengthShiftData >, celeritas::ParamsDataStore< celeritas::OrangeParamsData >, celeritas::ParamsDataStore< celeritas::ParticleParamsData >, celeritas::ParamsDataStore< celeritas::RanluxppRngParamsData >, celeritas::ParamsDataStore< celeritas::RayleighData >, celeritas::ParamsDataStore< celeritas::RelativisticBremData >, celeritas::ParamsDataStore< celeritas::RZMapFieldParamsData >, celeritas::ParamsDataStore< celeritas::ScintillationData >, celeritas::ParamsDataStore< celeritas::SeltzerBergerData >, celeritas::ParamsDataStore< celeritas::SimParamsData >, celeritas::ParamsDataStore< celeritas::StatusCheckParamsData >, celeritas::ParamsDataStore< celeritas::SurfaceParamsData >, celeritas::ParamsDataStore< celeritas::test::AuxMockParamsData >, celeritas::ParamsDataStore< celeritas::test::MockInteractData >, celeritas::ParamsDataStore< celeritas::TrackInitParamsData >, celeritas::ParamsDataStore< celeritas::UniformFieldParamsData >, celeritas::ParamsDataStore< celeritas::UrbanMscData >, celeritas::ParamsDataStore< celeritas::VecgeomParamsData >, celeritas::ParamsDataStore< celeritas::WentzelOKVIData >, celeritas::ParamsDataStore< celeritas::WentzelVIMscData >, celeritas::ParamsDataStore< celeritas::XorwowRngParamsData >, celeritas::ParamsDataStore< ParticleTallyParamsData >, celeritas::ParamsDataStore< SimpleCaloParamsData >, celeritas::CuHipRngParams, celeritas::RanluxppRngParams, celeritas::XorwowRngParams, celeritas::DetectorParams, celeritas::GeantGeoParams, celeritas::ImageParams, celeritas::SurfaceParams, celeritas::VecgeomParams, celeritas::OrangeParams, and celeritas::test::AuxMockParams.

---

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

• ParamsDataInterface.hh