Celeritas 0.7+cf8d83d
Loading...
Searching...
No Matches
Public Member Functions | List of all members
celeritas::optical::PhysicsParams Class Referencefinal

Bulk physics interaction models for optical photons. More...

#include <PhysicsParams.hh>

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

Public Types

Type aliases
using ActionIdRange = Range< ActionId >
 
using SPActionRegistry = std::shared_ptr< ActionRegistry >
 
using SPAuxRegistry = std::shared_ptr< AuxParamsRegistry >
 
using SPGeneratorRegistry = std::shared_ptr< GeneratorRegistry >
 
using SPConstModel = std::shared_ptr< Model const >
 
using SPConstCoreMaterials = std::shared_ptr< celeritas::MaterialParams const >
 
using SPConstMaterials = std::shared_ptr< MaterialParams const >
 
using VecModels = std::vector< SPConstModel >
 
- Public Types inherited from celeritas::ParamsDataInterface< PhysicsParamsData >
using HostRef = HostCRef< PhysicsParamsData >
 
using DeviceRef = DeviceCRef< PhysicsParamsData >
 

Public Member Functions

 PhysicsParams (inp::OpticalBulkPhysics const &, SPConstMaterials const &, SPConstCoreMaterials const &, SPActionRegistry, SPAuxRegistry, SPGeneratorRegistry, size_type)
 Construct from imported and shared data.
 
ModelId::size_type num_models () const
 Number of optical models.
 
SPConstModel model (ModelId mid) const
 Get an optical model associated with the given model identifier.
 
ActionIdRange model_actions () const
 Get the action identifiers for all optical models.
 
HostRef consthost_ref () const final
 Access optical physics data on the host.
 
DeviceRef constdevice_ref () const final
 Access optical physics data on the device.
 
- Public Member Functions inherited from celeritas::ParamsDataInterface< PhysicsParamsData >
PhysicsParamsData< Ownership::const_reference, M > const & ref () const
 
PhysicsParamsData< 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< PhysicsParamsData >
 ParamsDataInterface (ParamsDataInterface const &)=default
 
 ParamsDataInterface (ParamsDataInterface &&)=default
 
ParamsDataInterfaceoperator= (ParamsDataInterface const &)=default
 
ParamsDataInterfaceoperator= (ParamsDataInterface &&)=default
 

Detailed Description

Bulk physics interaction models for optical photons.

Todo:
Rename BulkPhysicsParams

Constructor & Destructor Documentation

◆ PhysicsParams()

celeritas::optical::PhysicsParams::PhysicsParams ( inp::OpticalBulkPhysics const input,
SPConstMaterials const materials,
SPConstCoreMaterials const core_materials,
SPActionRegistry  action_reg,
SPAuxRegistry  aux_reg,
SPGeneratorRegistry  gen_reg,
size_type  gen_capacity 
)
explicit

Construct from imported and shared data.

The following models are first constructed:

  • "discrete-select": sample models by XS for discrete interactions

Optical models provided by the model builders input are then constructed and registered in the action registry. Finally, scalar data and MFP tables are constructed on the physics storage data.

Member Function Documentation

◆ device_ref()

DeviceRef const & celeritas::optical::PhysicsParams::device_ref ( ) const
inlinefinalvirtual

Access optical physics data on the device.

Implements celeritas::ParamsDataInterface< PhysicsParamsData >.

◆ host_ref()

HostRef const & celeritas::optical::PhysicsParams::host_ref ( ) const
inlinefinalvirtual

Access optical physics data on the host.

Implements celeritas::ParamsDataInterface< PhysicsParamsData >.


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