Celeritas  0.5.0-56+6b053cd
Public Types | Public Member Functions | List of all members
celeritas::RayleighModel Class Referencefinal

Set up and launch Rayleigh scattering. More...

#include <RayleighModel.hh>

Inheritance diagram for celeritas::RayleighModel:
Inheritance graph
[legend]

Public Types

using HostRef = HostCRef< RayleighData >
 Type aliases.
 
using DeviceRef = DeviceCRef< RayleighData >
 
using SPConstImported = std::shared_ptr< ImportedProcesses const >
 
- Public Types inherited from celeritas::Model
using UPConstGridBuilder = std::unique_ptr< ValueGridBuilder const >
 Type aliases.
 
using MicroXsBuilders = std::vector< UPConstGridBuilder >
 
using SetApplicability = std::set< Applicability >
 
- Public Types inherited from celeritas::ActionTypeTraits< P, S >
using CoreParams = P
 
using CoreStateHost = S< MemSpace::host >
 
using CoreStateDevice = S< MemSpace::device >
 
using SpanCoreStateHost = Span< S< MemSpace::host > *const >
 
using SpanCoreStateDevice = Span< S< MemSpace::device > *const >
 

Public Member Functions

 RayleighModel (ActionId id, ParticleParams const &particles, MaterialParams const &materials, SPConstImported data)
 Construct from model ID and other necessary data.
 
SetApplicability applicability () const final
 Particle types and energy ranges that this model applies to.
 
MicroXsBuilders micro_xs (Applicability) const final
 Get the microscopic cross sections for the given particle and material.
 
void step (CoreParams const &, CoreStateHost &) const final
 Interact with host data.
 
void step (CoreParams const &, CoreStateDevice &) const final
 Interact with device data.
 
HostRef const & host_ref () const
 Access Rayleigh data on the host.
 
DeviceRef const & device_ref () const
 Access Rayleigh data on the device.
 
- Public Member Functions inherited from celeritas::Model
StepActionOrder order () const final
 Dependency ordering of the action.
 
- Public Member Functions inherited from celeritas::StepActionInterface< P, S >
virtual void step (P const &, S< MemSpace::host > &) const =0
 Execute the action with host data.
 
virtual void step (P const &, S< MemSpace::device > &) const =0
 Execute the action with device data.
 
- Public Member Functions inherited from celeritas::ActionInterface
virtual ~ActionInterface () noexcept=0
 Default destructor.
 
- Public Member Functions inherited from celeritas::StaticConcreteAction
 StaticConcreteAction (ActionId id, std::string_view label) noexcept(!CELERITAS_DEBUG)
 Construct a concrete action from a label and ID.
 
 StaticConcreteAction (ActionId id, std::string_view label, std::string_view description) noexcept(!CELERITAS_DEBUG)
 Construct a concrete action from an ID, a unique label, and a description.
 
 CELER_DELETE_COPY_MOVE (StaticConcreteAction)
 
ActionId action_id () const final
 ID of this action for verification.
 
std::string_view label () const final
 Short label.
 
std::string_view description () const final
 Descriptive label.
 

Additional Inherited Members

- Protected Member Functions inherited from celeritas::ActionInterface
 ActionInterface ()=default
 
 CELER_DEFAULT_COPY_MOVE (ActionInterface)
 

Detailed Description

Set up and launch Rayleigh scattering.


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