Celeritas 0.7-develop+980877a
Loading...
Searching...
No Matches
Public Member Functions | List of all members
celeritas::DecayChannel Class Referenceabstract

Abstract base class for a decay channel. More...

#include <DecayChannel.hh>

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

Public Types

Type aliases
using VecParticle = std::vector< ParticleId >
 
- 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

virtual VecParticle const & parents () const =0
 Particle types that decay through this channel.
 
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.
 
virtual ActionId action_id () const =0
 ID of this action for verification and ordering.
 
virtual std::string_view label () const =0
 Short unique label of the action.
 
virtual std::string_view description () const =0
 Description of the action.
 

Additional Inherited Members

- Protected Member Functions inherited from celeritas::ActionInterface
 ActionInterface (ActionInterface const &)=default
 
ActionInterface & operator= (ActionInterface const &)=default
 
 ActionInterface (ActionInterface &&)=default
 
ActionInterface & operator= (ActionInterface &&)=default
 

Detailed Description

Abstract base class for a decay channel.

A decay channel is the decay analog of a Model : it is the step action that samples the decay products of a particle that the DecayProcess selected to decay. Each channel knows the particle types it applies to and what they decay into.

Member Function Documentation

◆ order()

StepActionOrder celeritas::DecayChannel::order ( ) const
inlinefinalvirtual

Dependency ordering of the action.

Implements celeritas::StepActionInterface< P, S >.

◆ parents()

virtual VecParticle const & celeritas::DecayChannel::parents ( ) const
pure virtual

Particle types that decay through this channel.

Implemented in celeritas::MuDecayChannel.


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