detray::propagation_record< detector_t > Struct Template Reference

Data for a single step. More...

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

Public Types
using	algebra_type = typename detector_t::algebra_type
	Detector algebra type.
using	bound_param_type = typename step_record_type::bound_param_type
	Bound track parameter type.
using	free_matrix_type = typename step_record_type::free_matrix_type
	Free track matrix type.
using	free_param_type = typename step_record_type::track_param_type
	Free track parameter type.
using	intersection_type = intersection_record<detector_t>::intersection_type
	Intersection type associated with the detector.
using	scalar_type = dscalar<algebra_type>
	Scalar type associated with the detector algebra.
using	step_record_type = step_record<algebra_type>
	Type storing the propagation step data.
using	value_type = dvalue<algebra_type>
	Value type associated with the detector algebra.

Public Member Functions
bound_param_type &	bound_track_param ()
const bound_param_type &	bound_track_param () const
void	bound_track_param (const bound_param_type &bound_param)
	Set the new bound parameters.
scalar_type	charge () const
void	charge (scalar_type charge)
	Set the new charge.
free_param_type	free_track_param () const
void	free_track_param (const free_param_type &free_param)
	Set the new free track parameters.
geometry::identifier	identifier () const
void	identifier (geometry::identifier geo_id)
	Set the new geometry identifier.
intersection_type &	intersection ()
const intersection_type &	intersection () const
void	intersection (const intersection_type &intr)
	Set the new intersection data.
free_matrix_type &	jacobian ()
const free_matrix_type &	jacobian () const
void	jacobian (const free_matrix_type &jac)
	Set the new Jacobian.
std::size_t	n_rkn_trials () const
void	n_rkn_trials (std::size_t n_rkn_trials)
	Set the new number of RKN iterations.
scalar_type	p_mag () const
void	p_mag (scalar_type p_mag)
	Set the new total momentum magnitude.
scalar_type	path_length () const
void	path_length (scalar_type path_length)
	Set the new path length.
scalar_type	step_size () const
void	step_size (scalar_type step_size)
	Set the new step size.

Detailed Description

template<concepts::detector detector_t>
struct detray::propagation_record< detector_t >

Data for a single step.

Member Function Documentation

bound_track_param() [1/3]

template<concepts::detector detector_t>

bound_param_type & detray::propagation_record< detector_t >::bound_track_param

(

)

Returns

the bound track parameters at the current surface (if any) - const

bound_track_param() [2/3]

template<concepts::detector detector_t>

const bound_param_type & detray::propagation_record< detector_t >::bound_track_param

(

)

const

Returns

the bound track parameters at the current surface (if any)

bound_track_param() [3/3]

template<concepts::detector detector_t>

void detray::propagation_record< detector_t >::bound_track_param

(

const bound_param_type &

bound_param

)

Set the new bound parameters.

Parameters

bound_param

charge() [1/2]

template<concepts::detector detector_t>

scalar_type detray::propagation_record< detector_t >::charge

(

)

const

Returns

the free track parameters

charge() [2/2]

template<concepts::detector detector_t>

void detray::propagation_record< detector_t >::charge

(

scalar_type

charge

)

Set the new charge.

Parameters

charge

free_track_param() [1/2]

template<concepts::detector detector_t>

free_param_type detray::propagation_record< detector_t >::free_track_param

(

)

const

Returns

the free track parameters

free_track_param() [2/2]

template<concepts::detector detector_t>

void detray::propagation_record< detector_t >::free_track_param

(

const free_param_type &

free_param

)

Set the new free track parameters.

Parameters

free_param

identifier() [1/2]

template<concepts::detector detector_t>

geometry::identifier detray::propagation_record< detector_t >::identifier

(

)

const

Returns

the current geometry identifier if the step landed on surface

identifier() [2/2]

template<concepts::detector detector_t>

void detray::propagation_record< detector_t >::identifier

(

geometry::identifier

geo_id

)

Set the new geometry identifier.

Parameters

geo_id

intersection() [1/3]

template<concepts::detector detector_t>

intersection_type & detray::propagation_record< detector_t >::intersection

(

)

Returns

the intersection data on the current surface (if any)

intersection() [2/3]

template<concepts::detector detector_t>

const intersection_type & detray::propagation_record< detector_t >::intersection

(

)

const

Returns

the intersection data on the current surface (if any) - const

intersection() [3/3]

template<concepts::detector detector_t>

void detray::propagation_record< detector_t >::intersection

(

const intersection_type &

intr

)

Set the new intersection data.

Set the intersection result.

Parameters

intr	New intersection result.

jacobian() [1/3]

template<concepts::detector detector_t>

free_matrix_type & detray::propagation_record< detector_t >::jacobian

(

)

Returns

transport Jacobian since the last surface - const

jacobian() [2/3]

template<concepts::detector detector_t>

const free_matrix_type & detray::propagation_record< detector_t >::jacobian

(

)

const

Returns

transport Jacobian since the last surface

jacobian() [3/3]

template<concepts::detector detector_t>

void detray::propagation_record< detector_t >::jacobian

(

const free_matrix_type &

jac

)

Set the new Jacobian.

Parameters

jac

n_rkn_trials() [1/2]

template<concepts::detector detector_t>

std::size_t detray::propagation_record< detector_t >::n_rkn_trials

(

)

const

Returns

the free track parameters

n_rkn_trials() [2/2]

template<concepts::detector detector_t>

void detray::propagation_record< detector_t >::n_rkn_trials

(

std::size_t

n_rkn_trials

)

Set the new number of RKN iterations.

Parameters

n_rkn_trials

p_mag() [1/2]

template<concepts::detector detector_t>

scalar_type detray::propagation_record< detector_t >::p_mag

(

)

const

Returns

the current total momentum magnitude

p_mag() [2/2]

template<concepts::detector detector_t>

void detray::propagation_record< detector_t >::p_mag

(

scalar_type

p_mag

)

Set the new total momentum magnitude.

Parameters

p_mag

path_length() [1/2]

template<concepts::detector detector_t>

scalar_type detray::propagation_record< detector_t >::path_length

(

)

const

Returns

the free track parameters

path_length() [2/2]

template<concepts::detector detector_t>

void detray::propagation_record< detector_t >::path_length

(

scalar_type

path_length

)

Set the new path length.

Parameters

path_length

step_size() [1/2]

template<concepts::detector detector_t>

scalar_type detray::propagation_record< detector_t >::step_size

(

)

const

Returns

the free track parameters

step_size() [2/2]

template<concepts::detector detector_t>

void detray::propagation_record< detector_t >::step_size

(

scalar_type

step_size

)

Set the new step size.

Parameters

step_size