detray::material_rod< scalar_t > Struct Template Reference

Rod structure to be mapped on the line mask. More...

#include <detray/material/material_rod.hpp>

Public Types
using	material_type = material<scalar_t>
	Bulk material type represented by this rod.
using	scalar_type = scalar_t
	Scalar type used for rod dimensions and material properties.

Public Member Functions
constexpr	material_rod (const material_type &material, scalar_type radius)
	Construct a rod from a material and its radius.
constexpr const material_type &	get_material () const
	Access the (average) material parameters.
constexpr	operator bool () const
	Boolean operator.
constexpr bool	operator== (const material_rod< scalar_type > &rhs) const
	Equality operator.
constexpr scalar_type	path_segment (const scalar_type cos_inc_angle, const scalar_type approach) const
	Compute the path length through the rod for a track crossing.
constexpr scalar_type	path_segment_in_L0 (const scalar_type cos_inc_angle, const scalar_type approach) const
	Compute the path length through the rod for a track crossing.
constexpr scalar_type	path_segment_in_X0 (const scalar_type cos_inc_angle, const scalar_type approach) const
	Compute the path length through the rod for a track crossing.
constexpr scalar_type	radius () const
	Return the rod radius.
constexpr scalar_type	thickness () const
	Return the rod radius.

Detailed Description

template<concepts::scalar scalar_t>
struct detray::material_rod< scalar_t >

Rod structure to be mapped on the line mask.

Constructor & Destructor Documentation

material_rod()

template<concepts::scalar scalar_t>

detray::material_rod< scalar_t >::material_rod ( const material_type & material, scalar_type radius )

constexpr

Construct a rod from a material and its radius.

Parameters

material	bulk material in the rod
radius	geometric radius of the rod

Member Function Documentation

get_material()

template<concepts::scalar scalar_t>

const material_type & detray::material_rod< scalar_t >::get_material ( ) const

constexpr

Access the (average) material parameters.

Returns

rod material

operator bool()

template<concepts::scalar scalar_t>

detray::material_rod< scalar_t >::operator bool ( ) const

explicitconstexpr

Boolean operator.

Returns

true when the rod contributes material

operator==()

template<concepts::scalar scalar_t>

bool detray::material_rod< scalar_t >::operator== ( const material_rod< scalar_type > & rhs ) const

constexpr

Equality operator.

Parameters

rhs	is the right hand side to be compared to

Returns

whether material and radius match

path_segment()

template<concepts::scalar scalar_t>

scalar_type detray::material_rod< scalar_t >::path_segment ( const scalar_type cos_inc_angle, const scalar_type approach ) const

constexpr

Compute the path length through the rod for a track crossing.

Returns

the path segment through the material

Parameters

cos_inc_angle	cosine of the track incidence angle
approach	the closes approach of the track to the wire

path_segment_in_L0()

template<concepts::scalar scalar_t>

scalar_type detray::material_rod< scalar_t >::path_segment_in_L0 ( const scalar_type cos_inc_angle, const scalar_type approach ) const

constexpr

Compute the path length through the rod for a track crossing.

Returns

the path segment through the material in L0

Parameters

cos_inc_angle	cosine of the track incidence angle
approach	the closes approach of the track to the wire

path_segment_in_X0()

template<concepts::scalar scalar_t>

scalar_type detray::material_rod< scalar_t >::path_segment_in_X0 ( const scalar_type cos_inc_angle, const scalar_type approach ) const

constexpr

Compute the path length through the rod for a track crossing.

Returns

the path segment through the material in X0

Parameters

cos_inc_angle	cosine of the track incidence angle
approach	the closes approach of the track to the wire

radius()

template<concepts::scalar scalar_t>

scalar_type detray::material_rod< scalar_t >::radius ( ) const

constexpr

Return the rod radius.

Returns

the radius

thickness()

template<concepts::scalar scalar_t>

scalar_type detray::material_rod< scalar_t >::thickness ( ) const

constexpr

Return the rod radius.

Returns

the radius (alias function to keep interfaces homogeneous)