celeritas::CoulombScatteringProcess Class Reference

Coulomb scattering process for electrons off of atoms. More...

#include <CoulombScatteringProcess.hh>

Inheritance diagram for celeritas::CoulombScatteringProcess:

Classes
struct	Options

Public Types
Type aliases
using	SPConstParticles = std::shared_ptr< ParticleParams const >
using	SPConstMaterials = std::shared_ptr< MaterialParams const >
using	SPConstImported = std::shared_ptr< ImportedProcesses const >
Public Types inherited from celeritas::Process
using	SPConstModel = std::shared_ptr< Model const >
using	UPConstGridBuilder = std::unique_ptr< ValueGridBuilder const >
using	VecModel = std::vector< SPConstModel >
using	StepLimitBuilders = ValueGridArray< UPConstGridBuilder >
using	ActionIdIter = RangeIter< ActionId >

Public Member Functions
	CoulombScatteringProcess (SPConstParticles particles, SPConstMaterials materials, SPConstImported process_data, Options const &options)
	Construct from Coulomb scattering data.
VecModel	build_models (ActionIdIter start_id) const final
	Construct the models associated with this process.
StepLimitBuilders	step_limits (Applicability range) const final
	Get the interaction cross sections for the given energy range.
bool	use_integral_xs () const final
	Whether to use the integral method to sample interaction length.
bool	applies_at_rest () const final
	Whether the process applies when the particle is stopped.
std::string_view	label () const final
	Name of the process.
Public Member Functions inherited from celeritas::Process
virtual	~Process ()
	Default destructor.

Additional Inherited Members
Protected Member Functions inherited from celeritas::Process
	CELER_DEFAULT_COPY_MOVE (Process)

Detailed Description

Coulomb scattering process for electrons off of atoms.

Constructor & Destructor Documentation

CoulombScatteringProcess()

celeritas::CoulombScatteringProcess::CoulombScatteringProcess	(	SPConstParticles	particles,
		SPConstMaterials	materials,
		SPConstImported	process_data,
		Options const &	options
	)

Construct from Coulomb scattering data.

Construct from host data.

Member Function Documentation

applies_at_rest()

bool celeritas::CoulombScatteringProcess::applies_at_rest ( ) const

inlinefinalvirtual

Whether the process applies when the particle is stopped.

Implements celeritas::Process.

build_models()

auto celeritas::CoulombScatteringProcess::build_models ( ActionIdIter  start_id ) const

finalvirtual

Construct the models associated with this process.

Implements celeritas::Process.

label()

std::string_view celeritas::CoulombScatteringProcess::label ( ) const

finalvirtual

Name of the process.

Implements celeritas::Process.

step_limits()

auto celeritas::CoulombScatteringProcess::step_limits ( Applicability  range ) const

finalvirtual

Get the interaction cross sections for the given energy range.

Implements celeritas::Process.

use_integral_xs()

bool celeritas::CoulombScatteringProcess::use_integral_xs ( ) const

finalvirtual

Whether to use the integral method to sample interaction length.

May be controlled via options provided in the constructor.

Implements celeritas::Process.

---

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

• CoulombScatteringProcess.hh
• CoulombScatteringProcess.cc