Thermal-FIST  1.3
Package for hadron resonance gas model applications
Public Member Functions | List of all members
thermalfist::RandomGenerators::ParticleMomentumGenerator Class Referenceabstract

Base class for Monte Carlo sampling of particle momenta. More...

#include <RandomGenerators.h>

Inheritance diagram for thermalfist::RandomGenerators::ParticleMomentumGenerator:
thermalfist::RandomGenerators::BoostInvariantMomentumGenerator thermalfist::RandomGenerators::SiemensRasmussenMomentumGenerator thermalfist::RandomGenerators::SSHMomentumGenerator thermalfist::RandomGenerators::SiemensRasmussenMomentumGeneratorGeneralized

Public Member Functions

 ParticleMomentumGenerator ()
 Default constructor. More...
 
virtual ~ParticleMomentumGenerator ()
 Destructor. More...
 
virtual std::vector< double > GetMomentum (double mass=-1.) const =0
 

Detailed Description

Base class for Monte Carlo sampling of particle momenta.

Definition at line 95 of file RandomGenerators.h.

Constructor & Destructor Documentation

thermalfist::RandomGenerators::ParticleMomentumGenerator::ParticleMomentumGenerator ( )
inline

Default constructor.

Definition at line 99 of file RandomGenerators.h.

virtual thermalfist::RandomGenerators::ParticleMomentumGenerator::~ParticleMomentumGenerator ( )
inlinevirtual

Destructor.

Definition at line 102 of file RandomGenerators.h.

Member Function Documentation

virtual std::vector<double> thermalfist::RandomGenerators::ParticleMomentumGenerator::GetMomentum ( double  mass = -1.) const
pure virtual

Samples the 3-momentum of a particle

Parameters
massThe mass of a particle. If negative value provided, defaults to the pole/vacuum mass
Returns
std::vector<double> A vector containing the sampled \(p_x\), \(p_y\), \(p_z\) components of the three-momentum

Implemented in thermalfist::RandomGenerators::SSHMomentumGenerator, thermalfist::RandomGenerators::BoostInvariantMomentumGenerator, thermalfist::RandomGenerators::SiemensRasmussenMomentumGeneratorGeneralized, and thermalfist::RandomGenerators::SiemensRasmussenMomentumGenerator.


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