detray::actor::random_scatterer< algebra_t > Struct Template Reference

Actor that applies random energy loss and multiple scattering in material. More...

#include <detray/test/utils/random_scatterer.hpp>

Inheritance diagram for detray::actor::random_scatterer< algebra_t >:

Collaboration diagram for detray::actor::random_scatterer< algebra_t >:

Classes
struct	kernel
	Material store visitor. More...
struct	state
	Per-propagation state for random scattering and energy loss. More...

Public Types
using	interaction_type = interaction<scalar_type>
	Material interaction calculator type.
using	scalar_type = dscalar<algebra_t>
	Scalar type used for the simulation quantities.
using	transform3_type = dtransform3D<algebra_t>
	3D transform type.
using	vector3_type = dvector3D<algebra_t>
	3D vector type used for directions.

Public Member Functions
template<typename generator_t>
scalar_type	attenuate (const scalar_type mpv, const scalar_type sigma, const scalar_type m0, const scalar_type p0, generator_t &generator) const
	Get the new momentum from the landau distribution.
template<typename propagator_state_t>
void	operator() (state &simulator_state, propagator_state_t &prop_state, parameter_transporter_result< algebra_t > &res) const
	Apply the sampled material effects to the transported parameters.
template<typename generator_t>
vector3_type	scatter (const vector3_type &dir, const scalar_type projected_scattering_angle, generator_t &generator) const
	Scatter the direction with projected scattering angle.

Detailed Description

template<concepts::algebra algebra_t>
struct detray::actor::random_scatterer< algebra_t >

Actor that applies random energy loss and multiple scattering in material.

Member Function Documentation

attenuate()

template<concepts::algebra algebra_t>

template<typename generator_t>

scalar_type detray::actor::random_scatterer< algebra_t >::attenuate	(	const scalar_type	mpv,
		const scalar_type	sigma,
		const scalar_type	m0,
		const scalar_type	p0,
		generator_t &	generator ) const

Get the new momentum from the landau distribution.

Parameters

mpv	Most probable energy loss.
sigma	Energy loss scale.
m0	Particle mass.
p0	Initial momentum magnitude.
generator	Random number generator.

Returns

Momentum magnitude after energy loss.

operator()()

template<concepts::algebra algebra_t>

template<typename propagator_state_t>

void detray::actor::random_scatterer< algebra_t >::operator()	(	state &	simulator_state,
		propagator_state_t &	prop_state,
		parameter_transporter_result< algebra_t > &	res ) const

Apply the sampled material effects to the transported parameters.

Parameters

simulator_state	Actor state with material effects and RNG.
prop_state	Propagator state.
res	Parameter transport result to update.

scatter()

template<concepts::algebra algebra_t>

template<typename generator_t>

vector3_type detray::actor::random_scatterer< algebra_t >::scatter	(	const vector3_type &	dir,
		const scalar_type	projected_scattering_angle,
		generator_t &	generator ) const

Scatter the direction with projected scattering angle.

Parameters

dir	input direction
projected_scattering_angle	projected scattering angle
generator	random generator

Returns

the new direction from random scattering