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

Set up and launch the optical absorption model interaction. More...

#include <AbsorptionModel.hh>

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

Public Types

Type aliases
using SPConstImported = std::shared_ptr< ImportedModels const >
 
- 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

 AbsorptionModel (ActionId id, SPConstImported imported)
 Construct the model from imported data.
 
void build_mfps (OpticalMaterialId mat, MfpBuilder &) const final
 Build the mean free paths for the model.
 
void step (CoreParams const &, CoreStateHost &) const final
 Execute the model on the host.
 
void step (CoreParams const &, CoreStateDevice &) const final
 Execute the model on the device. More...
 
- Public Member Functions inherited from celeritas::optical::Model
StepActionOrder order () const override final
 Action order for optical models is always post-step.
 
 ConcreteAction (ActionId id, std::string label) noexcept(!CELERITAS_DEBUG)
 Construct a concrete action from a label and ID.
 
 ConcreteAction (ActionId id, std::string label, std::string description) noexcept(!CELERITAS_DEBUG)
 Construct a concrete action from an ID, a unique label, and a description.
 
- 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::ConcreteAction
 ConcreteAction (ActionId id, std::string label) noexcept(!CELERITAS_DEBUG)
 Construct a concrete action from a label and ID.
 
 ConcreteAction (ActionId id, std::string label, std::string description) noexcept(!CELERITAS_DEBUG)
 Construct a concrete action from an ID, a unique label, and a description.
 
 ~ConcreteAction () noexcept
 Default destructor.
 
 CELER_DELETE_COPY_MOVE (ConcreteAction)
 
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 the optical absorption model interaction.

Member Function Documentation

◆ step()

void celeritas::optical::AbsorptionModel::step ( CoreParams const &  ,
CoreStateDevice &   
) const
final

Execute the model on the device.

Interact with device data.


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