Global parameters required to run a problem. More...

#include <CoreParams.hh>

Inheritance diagram for celeritas::CoreParams:

Classes
struct	Input

Public Member Functions
	CoreParams (Input inp)
	Construct with all problem data, creating some actions too.

HostRef const &	host_ref () const final
	Access data on the host.

DeviceRef const &	device_ref () const final
	Access data on the device.

template<MemSpace M>
ConstPtr< M >	ptr () const

size_type	max_streams () const
	Maximum number of streams.

size_type	tracks_per_stream () const
	Number of track slots per stream.

template<MemSpace M>
auto	ptr () const -> ConstPtr< M >
	Access a native pointer to a NativeCRef.

template<MemSpace M>
auto	ptr () const -> ConstPtr< M >
	Access a native pointer to a NativeCRef.

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.

Type aliases
using	SPConstGeo = std::shared_ptr< GeoParams const >

using	SPConstMaterial = std::shared_ptr< MaterialParams const >

using	SPConstGeoMaterial = std::shared_ptr< GeoMaterialParams const >

using	SPConstParticle = std::shared_ptr< ParticleParams const >

using	SPConstCutoff = std::shared_ptr< CutoffParams const >

using	SPConstPhysics = std::shared_ptr< PhysicsParams const >

using	SPConstRng = std::shared_ptr< RngParams const >

using	SPConstSim = std::shared_ptr< SimParams const >

using	SPConstTrackInit = std::shared_ptr< TrackInitParams const >

using	SPConstWentzelOKVI = std::shared_ptr< WentzelOKVIParams const >

using	SPConstMpiCommunicator = std::shared_ptr< MpiCommunicator const >

using	SPActionRegistry = std::shared_ptr< ActionRegistry >

using	SPOutputRegistry = std::shared_ptr< OutputRegistry >

using	SPUserRegistry = std::shared_ptr< AuxParamsRegistry >

template<MemSpace M>
using	ConstRef = CoreParamsData< Ownership::const_reference, M >

template<MemSpace M>
using	ConstPtr = ObserverPtr< ConstRef< M > const, M >

SPConstGeo const &	geometry () const

SPConstMaterial const &	material () const

SPConstGeoMaterial const &	geomaterial () const

SPConstParticle const &	particle () const

SPConstCutoff const &	cutoff () const

SPConstPhysics const &	physics () const

SPConstRng const &	rng () const

SPConstSim const &	sim () const

SPConstTrackInit const &	init () const

SPConstWentzelOKVI const &	wentzel () const

SPActionRegistry const &	action_reg () const

SPOutputRegistry const &	output_reg () const

SPUserRegistry const &	aux_reg () const

SPConstMpiCommunicator const &	mpi_comm () const

Additional Inherited Members
Public Types inherited from celeritas::ParamsDataInterface< CoreParamsData >
using	HostRef = HostCRef< CoreParamsData >

using	DeviceRef = DeviceCRef< CoreParamsData >

Protected Member Functions inherited from celeritas::ParamsDataInterface< CoreParamsData >
	CELER_DEFAULT_COPY_MOVE (ParamsDataInterface)

Detailed Description

Global parameters required to run a problem.

Todo:: Applications specify tracks_per_stream to build the states, but unit tests currently omit this option.

Member Typedef Documentation

◆ ConstPtr

template<MemSpace M>

using celeritas::CoreParams::ConstPtr = ObserverPtr<ConstRef<M> const, M>

Access shared problem parameter data.

◆ ConstRef

template<MemSpace M>

using celeritas::CoreParams::ConstRef = CoreParamsData<Ownership::const_reference, M>

Access shared problem parameter data.

◆ SPActionRegistry

using celeritas::CoreParams::SPActionRegistry = std::shared_ptr<ActionRegistry>

Access shared problem parameter data.

◆ SPConstCutoff

using celeritas::CoreParams::SPConstCutoff = std::shared_ptr<CutoffParams const>

Access shared problem parameter data.

◆ SPConstGeo

using celeritas::CoreParams::SPConstGeo = std::shared_ptr<GeoParams const>

Access shared problem parameter data.

◆ SPConstGeoMaterial

using celeritas::CoreParams::SPConstGeoMaterial = std::shared_ptr<GeoMaterialParams const>

Access shared problem parameter data.

◆ SPConstMaterial

using celeritas::CoreParams::SPConstMaterial = std::shared_ptr<MaterialParams const>

Access shared problem parameter data.

◆ SPConstMpiCommunicator

using celeritas::CoreParams::SPConstMpiCommunicator = std::shared_ptr<MpiCommunicator const>

Access shared problem parameter data.

◆ SPConstParticle

using celeritas::CoreParams::SPConstParticle = std::shared_ptr<ParticleParams const>

Access shared problem parameter data.

◆ SPConstPhysics

using celeritas::CoreParams::SPConstPhysics = std::shared_ptr<PhysicsParams const>

Access shared problem parameter data.

◆ SPConstRng

using celeritas::CoreParams::SPConstRng = std::shared_ptr<RngParams const>

Access shared problem parameter data.

◆ SPConstSim

using celeritas::CoreParams::SPConstSim = std::shared_ptr<SimParams const>

Access shared problem parameter data.

◆ SPConstTrackInit

using celeritas::CoreParams::SPConstTrackInit = std::shared_ptr<TrackInitParams const>

Access shared problem parameter data.

◆ SPConstWentzelOKVI

using celeritas::CoreParams::SPConstWentzelOKVI = std::shared_ptr<WentzelOKVIParams const>

Access shared problem parameter data.

◆ SPOutputRegistry

using celeritas::CoreParams::SPOutputRegistry = std::shared_ptr<OutputRegistry>

Access shared problem parameter data.

◆ SPUserRegistry

using celeritas::CoreParams::SPUserRegistry = std::shared_ptr<AuxParamsRegistry>

Access shared problem parameter data.

Member Function Documentation

◆ action_reg()

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

inline

Access shared problem parameter data.

◆ aux_reg()

SPUserRegistry const & celeritas::CoreParams::aux_reg ( ) const

inline

Access shared problem parameter data.

◆ cutoff()

SPConstCutoff const & celeritas::CoreParams::cutoff ( ) const

inline

Access shared problem parameter data.

◆ device_ref()

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

inlinefinalvirtual

Access data on the device.

Implements celeritas::ParamsDataInterface< CoreParamsData >.

◆ geomaterial()

SPConstGeoMaterial const & celeritas::CoreParams::geomaterial ( ) const

inline

Access shared problem parameter data.

◆ geometry()

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

inline

Access shared problem parameter data.

◆ host_ref()

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

inlinefinalvirtual

Access data on the host.

Implements celeritas::ParamsDataInterface< CoreParamsData >.

◆ init()

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

inline

Access shared problem parameter data.

◆ material()

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

inline

Access shared problem parameter data.

◆ mpi_comm()

SPConstMpiCommunicator const & celeritas::CoreParams::mpi_comm ( ) const

inline

Access shared problem parameter data.

◆ output_reg()

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

inline

Access shared problem parameter data.

◆ particle()

SPConstParticle const & celeritas::CoreParams::particle ( ) const

inline

Access shared problem parameter data.

◆ physics()

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

inline

Access shared problem parameter data.

◆ ptr() [1/2]

template<MemSpace M>

auto celeritas::CoreParams::ptr ( ) const -> ConstPtr<M>

Access a native pointer to a NativeCRef.

This way, CUDA kernels only need to copy a pointer in the kernel arguments, rather than the entire (rather large) DeviceRef object.

◆ ptr() [2/2]

template<MemSpace M>

auto celeritas::CoreParams::ptr ( ) const -> ConstPtr<M>

Access a native pointer to a NativeCRef.

This way, CUDA kernels only need to copy a pointer in the kernel arguments, rather than the entire (rather large) DeviceRef object.

◆ rng()

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

inline

Access shared problem parameter data.

◆ sim()

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

inline

Access shared problem parameter data.

◆ wentzel()

SPConstWentzelOKVI const & celeritas::CoreParams::wentzel ( ) const

inline

Access shared problem parameter data.

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

Classes

Public Member Functions

Type aliases

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConstPtr

◆ ConstRef

◆ SPActionRegistry

◆ SPConstCutoff

◆ SPConstGeo

◆ SPConstGeoMaterial

◆ SPConstMaterial

◆ SPConstMpiCommunicator

◆ SPConstParticle

◆ SPConstPhysics

◆ SPConstRng

◆ SPConstSim

◆ SPConstTrackInit

◆ SPConstWentzelOKVI

◆ SPOutputRegistry

◆ SPUserRegistry

Member Function Documentation

◆ action_reg()

◆ aux_reg()

◆ cutoff()

◆ device_ref()

◆ geomaterial()

◆ geometry()

◆ host_ref()

◆ init()

◆ material()

◆ mpi_comm()

◆ output_reg()

◆ particle()

◆ physics()

◆ ptr() [1/2]

◆ ptr() [2/2]

◆ rng()

◆ sim()

◆ wentzel()