detray::pdg_particle< scalar_t > Struct Template Reference

Particle hypothesis identified by PDG number, mass, and electric charge. More...

#include <detray/definitions/pdg_particle.hpp>

Inheritance diagram for detray::pdg_particle< scalar_t >:

Public Types
using	scalar_type = scalar_t
	Scalar representation of mass and charge.

Public Member Functions
template<typename T>
constexpr	pdg_particle (const std::int32_t pdg_num, const T mass, const T charge)
	Construct a particle hypothesis.
constexpr scalar_type	charge () const
constexpr bool	is_valid () const
constexpr scalar_type	mass () const
constexpr std::int32_t	pdg_num () const

Detailed Description

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

Particle hypothesis identified by PDG number, mass, and electric charge.

Template Parameters

scalar_t

Scalar representation of mass and charge.

Constructor & Destructor Documentation

pdg_particle()

template<concepts::scalar scalar_t>

template<typename T>

detray::pdg_particle< scalar_t >::pdg_particle ( const std::int32_t pdg_num, const T mass, const T charge )

constexpr

Construct a particle hypothesis.

Parameters

pdg_num	Signed PDG identifier, or zero for an invalid hypothesis.
mass	Particle mass in internal units.
charge	Electric charge in internal units.

Member Function Documentation

charge()

template<concepts::scalar scalar_t>

scalar_type detray::pdg_particle< scalar_t >::charge ( ) const

constexpr

Returns

Electric charge in internal units.

is_valid()

template<concepts::scalar scalar_t>

bool detray::pdg_particle< scalar_t >::is_valid ( ) const

constexpr

Returns

Whether the PDG identifier is nonzero.

mass()

template<concepts::scalar scalar_t>

scalar_type detray::pdg_particle< scalar_t >::mass ( ) const

constexpr

Returns

Particle mass in internal units.

pdg_num()

template<concepts::scalar scalar_t>

std::int32_t detray::pdg_particle< scalar_t >::pdg_num ( ) const

constexpr

Returns

Signed PDG identifier.