Common namespace for this Monte Carlo generator.

Namespaces
namespace	card
	Location for all steering card parsers/writers.

namespace	constants
	List of physical constants useful that may be used for the matrix element definition.

namespace	cuts
	A namespace for all kinematic cuts.

namespace	formfac
	Form factors definition scope.

namespace	hadr
	Location for all hadronisers to be run downstream to the events generation.

namespace	herwig6
	Herwig 6 utilities namespace.

namespace	ktblock
	Collection of common blocks for Fortran \(k_{\rm T}\)-processes.

namespace	mg5amc

namespace	mode
	Collection of enums for the definition of process mode.

namespace	proc
	Location for all physics processes to be generated.

namespace	pythia6
	Pythia 6 utilities namespace.

namespace	python

namespace	sigrat
	A collector namespace for modellings of the \(R=\sigma_L/\sigma_T\) ratio.

namespace	strfun
	Structure functions modelling scope.

namespace	test

namespace	utils
	Collection of utilities.

Classes
class	ArgumentsParser
	A generic command line arguments parser. More...

class	Beam
	Incoming beams characteristics. More...

struct	CardsHandlerFactory
	A card handler factory. More...

class	CollinearFlux
	Base object for a collinear parton flux parameterisation. More...

class	Coupling
	A generic \(\alpha_S(Q^2)\) evaluation algorithm. More...

struct	CutsList
	A collection of cuts to apply on the physical phase space. More...

class	Event
	Container for the information on the in- and outgoing particles' kinematics. More...

class	EventExporter
	Output format handler for events export. More...

class	EventHandler
	Class template for modules interacting with events. More...

class	EventHarvester
	Generic text file output handler. More...

class	EventImporter
	Base event importer module. More...

class	EventModifier
	Class template to interface (external/internal) events modification algorithms. More...

class	Exception
	Standard exception message. More...

class	FunctionalIntegrand
	Wrapper to a string-built functional to be integrated. More...

class	FunctionIntegrand
	Wrapper to the function to be integrated. More...

class	Generator
	Core generator object allowing for process definition, cross-section computation, and event generation. More...

class	GeneratorWorker
	Event generator worker instance. More...

class	GridHandler
	A generic class for \(\mathbb{R}^D\mapsto\mathbb{R}^N\) grid interpolation. More...

class	GridParameters
	A parameters placeholder for the grid integration helper. More...

class	GSLIntegrator

struct	HeavyIon
	Heavy ion container (Z+A) More...

class	IncomingBeams
	Beam/primary particle's kinematics. More...

class	Integrand
	An integrand wrapper placeholder. More...

class	Integrator
	Integration algorithm. More...

class	Kinematics
	List of kinematic constraints to apply on the process phase space. More...

class	KTFlux

class	Limits
	Validity interval for a variable. More...

class	LoggedMessage
	A simple exception handler. More...

class	Matrix
	A \(n\times m\) matrix object. More...

struct	Message
	A generic message type. More...

class	ModuleFactory
	A generic factory to build modules. More...

class	Momentum
	Container for a particle's 4-momentum, along with useful methods to ease the development of any matrix element level generator. More...

class	NachtmannAmplitudes
	Amplitudes computational tool, as developed by Nachtmann et al. [2]. More...

class	NamedModule
	Base runtime module object. More...

struct	NullStream
	Placeholder for debugging messages if logging threshold is not reached. More...

class	ParametersDescription
	A description object for parameters collection. More...

class	ParametersList

class	Particle
	Kinematic information for one particle. More...

struct	ParticleProperties

class	ParticlesMap
	Map between a particle's role and its associated Particle object. More...

class	PartonFlux

struct	PartonFluxFactory
	A generic parton fluxes objects factory. More...

class	PartonsPhaseSpaceGenerator
	A generic phase space integration wrapper. More...

class	PDG
	A singleton holding all physics constants associated to particles. More...

class	PhaseSpaceGenerator
	Class template to define any phase space helper process. More...

struct	PhaseSpaceGeneratorFactory

class	PolarisationState

class	ProcessIntegrand
	Wrapper to the function to be integrated. More...

class	ResonanceObject
	General definition for a resonance. More...

class	ROOTCanvas
	A "prettified" generic figure canvas. More...

class	ROOTPaveText
	A "prettified" text box object. More...

class	RunParameters
	List of parameters used to start and run the simulation job. More...

class	Steerable
	Base runtime module object. More...

class	SteeredObject
	Base user-steerable object. More...

class	Value
	A scalar value with its uncertainty. More...

class	Vector
	Specialisation of an \(m\times 1\) matrix. More...

class	VectorRef

struct	version
	Collection of CepGen version information handlers. More...

Typedefs
using	EventModifiersSequence = std::vector<std::unique_ptr<EventModifier> >
	Event modification algos collection.

using	EventExportersSequence = std::vector<std::unique_ptr<EventExporter> >
	Event export modules collection.

using	TamingFunctionsSequence = std::vector<std::unique_ptr<utils::Functional> >
	Function evaluators collection.

using	ParticlesIds = std::set<int>
	A set of integer-type particle identifiers.

using	ParticleRef = std::reference_wrapper<Particle>
	Reference to a Particle object.

using	Particles = std::vector<Particle>
	List of Particle objects.

using	ParticlesRefs = std::vector<ParticleRef>
	List of references to Particle objects.

using	ParticleRoles = std::vector<Particle::Role>
	List of particles' roles.

using	PerIdCuts = std::unordered_map<pdgid_t, cuts::Central>
	Collection of cuts to be applied on all particle with a given PDG id.

using	pdgid_t = unsigned long long
	Alias for the integer-like particle PDG id.

using	pdgids_t = std::vector<pdgid_t>
	Alias for a collection of particles PDG ids.

using	spdgid_t = long long
	Alias for a signed particle PDG id (adding charge information)

using	spdgids_t = std::vector<spdgid_t>
	Alias for a collection of particles signed PDG ids A collection of physics constants associated to a single particle.

Enumerations
enum class	Element { invalid = -1 , neutron = 0 , H = 1 , C = 6 , O = 8 , Al = 13 , Cu = 29 , Xe = 54 , Au = 79 , Pb = 82 , U = 92 }
	Enumeration of chemical elements. More...

enum struct	GridType { linear , logarithmic , square }
	Interpolation type for the grid coordinates. More...

Functions
template<>
ParametersDescription &	ParametersDescription::setKey< std::string > (const std::string &)

bool	callPath (const std::string &, bool(*callback)(const std::string &))

bool	loadLibrary (const std::string &, bool match=false)
	Import a shared library in RTE Launch the initialisation procedure.

void	initialise (bool safe_mode=false)

void	printHeader ()
	Dump this program's header into the standard output stream.

	DEFINE_FACTORY (BaseCardsHandlerFactory, card::Handler, "Cards handlers factory")
	A card handler base factory.

	DEFINE_FACTORY (AlphaEMFactory, Coupling, "Electromagnetic coupling evolution factory")
	An electromagnetic coupling evolution algorithms factory.

	DEFINE_FACTORY (AlphaSFactory, Coupling, "Strong coupling evolution factory")
	A strong coupling evolution algorithms factory.

	DEFINE_FACTORY (DerivatorFactory, utils::Derivator, "Derivators factory")
	An analytical derivator objects factory.

	DEFINE_FACTORY (DocumentationGeneratorFactory, utils::DocumentationGenerator, "Documentation generator factory")
	A documentation generator factory.

	DEFINE_FACTORY (DrawerFactory, utils::Drawer, "Drawing utility factory")
	A plotting utilities factory.

	DEFINE_FACTORY (EventExporterFactory, EventExporter, "Export modules factory")
	An output modules factory.

	DEFINE_FACTORY (EventImporterFactory, EventImporter, "Event importers factory")
	An event import algorithm factory.

	DEFINE_FACTORY (EventModifierFactory, EventModifier, "Event modifiers factory")
	An event modifier algorithms factory.

	DEFINE_FACTORY (FormFactorsFactory, formfac::Parameterisation, "Nucleon form factors factory")
	A form factors parameterisations factory.

	DEFINE_FACTORY (FunctionalFactory, utils::Functional, "Functional factory")
	A functional objects factory.

	DEFINE_FACTORY (GeneratorWorkerFactory, GeneratorWorker, "Generator worker factory")
	A generator worker algorithms factory.

	DEFINE_FACTORY (IntegratorFactory, Integrator, "Integrators factory")
	An integrator objects factory.

	DEFINE_FACTORY (CollinearFluxFactory, CollinearFlux, "Collinear parton flux estimators factory")
	A collinear parton fluxes objects factory.

	DEFINE_FACTORY (KTFluxFactory, KTFlux, "KT-factorised flux estimators factory")
	A KT-factorised parton fluxes objects factory.

	DEFINE_FACTORY (PartonsPhaseSpaceGeneratorFactory, PartonsPhaseSpaceGenerator, "Partons phase space generator factory")
	A partons' phase space mapping algorithms factory.

	DEFINE_FACTORY (BasePhaseSpaceGeneratorFactory, PhaseSpaceGenerator, "Phase space generator factory")
	A phase space mapping algorithms factory.

	DEFINE_FACTORY (ProcessFactory, proc::Process, "Physics processes factory")
	A processes factory.

	DEFINE_FACTORY (RandomGeneratorFactory, utils::RandomGenerator, "Random number generator factory")
	A random number generator algorithms factory.

	DEFINE_FACTORY (StructureFunctionsFactory, strfun::Parameterisation, "Nucleon structure functions parameterisations factory")
	A structure functions parameterisations factory.

	DEFINE_FACTORY (SigmaRatiosFactory, sigrat::Parameterisation, "Sigma L/T parameterisations factory")
	A sigma ratio parameterisations factory.

std::ostream &	operator<< (std::ostream &os, const Element &elem)

utils::Drawer::Mode	operator\| (const utils::Drawer::Mode &, const utils::Drawer::Mode::value_t &)

utils::Drawer::Mode	operator\| (const utils::Drawer::Mode::value_t &, const utils::Drawer::Mode::value_t &)

std::ostream &	operator<< (std::ostream &os, const utils::Logger::Level &)

template<typename T >
T *	AddUnderOverflowBins (const T *hist)

Variables
const auto	MODULE_NAME = "mod_name"
	Indexing key for the module name Parameters container.

static std::vector< std::string >	loaded_libraries
	Collection of libraries loaded in RTE.

static std::vector< std::string >	invalid_libraries
	Collection of libraries tested not to work with RTE.

static std::vector< std::string >	search_paths
	Collection of search paths to build RTE Execute an action on a path if found in search paths collection.

Typedef Documentation

◆ EventExportersSequence

using EventExportersSequence = std::vector<std::unique_ptr<EventExporter> >

Definition at line 40 of file RunParameters.h.

◆ EventModifiersSequence

using EventModifiersSequence = std::vector<std::unique_ptr<EventModifier> >

Definition at line 39 of file RunParameters.h.

◆ ParticleRef

using ParticleRef = std::reference_wrapper<Particle>

Definition at line 167 of file Particle.h.

◆ ParticleRoles

using ParticleRoles = std::vector<Particle::Role>

Definition at line 170 of file Particle.h.

◆ Particles

using Particles = std::vector<Particle>

Definition at line 168 of file Particle.h.

◆ ParticlesIds

using ParticlesIds = std::set<int>

Definition at line 29 of file Particle.h.

◆ ParticlesRefs

using ParticlesRefs = std::vector<ParticleRef>

Definition at line 169 of file Particle.h.

◆ pdgid_t

using pdgid_t = unsigned long long

Definition at line 25 of file ParticleProperties.h.

◆ pdgids_t

using pdgids_t = std::vector<pdgid_t>

Definition at line 26 of file ParticleProperties.h.

◆ PerIdCuts

using PerIdCuts = std::unordered_map<pdgid_t, cuts::Central>

Definition at line 26 of file CutsList.h.

◆ spdgid_t

using spdgid_t = long long

Definition at line 27 of file ParticleProperties.h.

◆ spdgids_t

using spdgids_t = std::vector<spdgid_t>

Definition at line 28 of file ParticleProperties.h.

◆ TamingFunctionsSequence

using TamingFunctionsSequence = std::vector<std::unique_ptr<utils::Functional> >

Definition at line 41 of file RunParameters.h.

Enumeration Type Documentation

◆ Element

enum class Element

strong

Enumerator
invalid
neutron
H	hydrogen
C	carbon
O	oxygen
Al	aluminium
Cu	copper
Xe	xenon
Au	gold
Pb	lead
U	uranium

Definition at line 26 of file HeavyIon.h.

◆ GridType

enum struct GridType

strong

Enumerator
linear
logarithmic
square

Definition at line 38 of file GridHandler.h.

Function Documentation

◆ AddUnderOverflowBins()

template<typename T >

T * AddUnderOverflowBins ( const T * hist )

Definition at line 72 of file ROOTCanvas.h.

◆ callPath()

bool callPath	(	const std::string &	,
		bool(*)(const std::string &)	callback )

◆ DEFINE_FACTORY() [1/21]

DEFINE_FACTORY	(	AlphaEMFactory	,
		Coupling	,
		"Electromagnetic coupling evolution factory"	)

◆ DEFINE_FACTORY() [2/21]

DEFINE_FACTORY	(	AlphaSFactory	,
		Coupling	,
		"Strong coupling evolution factory"	)

◆ DEFINE_FACTORY() [3/21]

DEFINE_FACTORY	(	BaseCardsHandlerFactory	,
		card::Handler	,
		"Cards handlers factory"	)

◆ DEFINE_FACTORY() [4/21]

DEFINE_FACTORY	(	BasePhaseSpaceGeneratorFactory	,
		PhaseSpaceGenerator	,
		"Phase space generator factory"	)

◆ DEFINE_FACTORY() [5/21]

DEFINE_FACTORY	(	CollinearFluxFactory	,
		CollinearFlux	,
		"Collinear parton flux estimators factory"	)

◆ DEFINE_FACTORY() [6/21]

DEFINE_FACTORY	(	DerivatorFactory	,
		utils::Derivator	,
		"Derivators factory"	)

◆ DEFINE_FACTORY() [7/21]

DEFINE_FACTORY	(	DocumentationGeneratorFactory	,
		utils::DocumentationGenerator	,
		"Documentation generator factory"	)

◆ DEFINE_FACTORY() [8/21]

DEFINE_FACTORY	(	DrawerFactory	,
		utils::Drawer	,
		"Drawing utility factory"	)

◆ DEFINE_FACTORY() [9/21]

DEFINE_FACTORY	(	EventExporterFactory	,
		EventExporter	,
		"Export modules factory"	)

◆ DEFINE_FACTORY() [10/21]

DEFINE_FACTORY	(	EventImporterFactory	,
		EventImporter	,
		"Event importers factory"	)

◆ DEFINE_FACTORY() [11/21]

DEFINE_FACTORY	(	EventModifierFactory	,
		EventModifier	,
		"Event modifiers factory"	)

◆ DEFINE_FACTORY() [12/21]

DEFINE_FACTORY	(	FormFactorsFactory	,
		formfac::Parameterisation	,
		"Nucleon form factors factory"	)

◆ DEFINE_FACTORY() [13/21]

DEFINE_FACTORY	(	FunctionalFactory	,
		utils::Functional	,
		"Functional factory"	)

◆ DEFINE_FACTORY() [14/21]

DEFINE_FACTORY	(	GeneratorWorkerFactory	,
		GeneratorWorker	,
		"Generator worker factory"	)

◆ DEFINE_FACTORY() [15/21]

DEFINE_FACTORY	(	IntegratorFactory	,
		Integrator	,
		"Integrators factory"	)

◆ DEFINE_FACTORY() [16/21]

DEFINE_FACTORY	(	KTFluxFactory	,
		KTFlux	,
		"KT-factorised flux estimators factory"	)

◆ DEFINE_FACTORY() [17/21]

DEFINE_FACTORY	(	PartonsPhaseSpaceGeneratorFactory	,
		PartonsPhaseSpaceGenerator	,
		"Partons phase space generator factory"	)

◆ DEFINE_FACTORY() [18/21]

DEFINE_FACTORY	(	ProcessFactory	,
		proc::Process	,
		"Physics processes factory"	)

◆ DEFINE_FACTORY() [19/21]

DEFINE_FACTORY	(	RandomGeneratorFactory	,
		utils::RandomGenerator	,
		"Random number generator factory"	)

◆ DEFINE_FACTORY() [20/21]

DEFINE_FACTORY	(	SigmaRatiosFactory	,
		sigrat::Parameterisation	,
		"Sigma L/T parameterisations factory"	)

◆ DEFINE_FACTORY() [21/21]

DEFINE_FACTORY	(	StructureFunctionsFactory	,
		strfun::Parameterisation	,
		"Nucleon structure functions parameterisations factory"	)

◆ initialise()

void initialise ( bool safe_mode = false )

◆ loadLibrary()

bool loadLibrary	(	const std::string &	,
		bool	match = false )

Parameters

[in] safe_mode Drop libraries initialisation?

◆ operator<<() [1/2]

std::ostream & operator<<	(	std::ostream &	os,
		const Element &	elem )

◆ operator<<() [2/2]

std::ostream & operator<<	(	std::ostream &	os,
		const utils::Logger::Level &	)

◆ operator|() [1/2]

utils::Drawer::Mode operator\|	(	const utils::Drawer::Mode &	,
		const utils::Drawer::Mode::value_t &	)

◆ operator|() [2/2]

utils::Drawer::Mode operator\|	(	const utils::Drawer::Mode::value_t &	,
		const utils::Drawer::Mode::value_t &	)

◆ ParametersDescription::setKey< std::string >()

template<>

ParametersDescription & ParametersDescription::setKey< std::string > ( const std::string & )

◆ printHeader()

void printHeader ( )

Variable Documentation

◆ invalid_libraries

std::vector<std::string> invalid_libraries

static

Definition at line 37 of file Generator.h.

◆ loaded_libraries

std::vector<std::string> loaded_libraries

static

Definition at line 36 of file Generator.h.

◆ MODULE_NAME

const auto MODULE_NAME = "mod_name"

Definition at line 50 of file ParametersList.h.

◆ search_paths

std::vector<std::string> search_paths

static

Definition at line 38 of file Generator.h.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ EventExportersSequence

◆ EventModifiersSequence

◆ ParticleRef

◆ ParticleRoles

◆ Particles

◆ ParticlesIds

◆ ParticlesRefs

◆ pdgid_t

◆ pdgids_t

◆ PerIdCuts

◆ spdgid_t

◆ spdgids_t

◆ TamingFunctionsSequence

Enumeration Type Documentation

◆ Element

◆ GridType

Function Documentation

◆ AddUnderOverflowBins()

◆ callPath()

◆ DEFINE_FACTORY() [1/21]

◆ DEFINE_FACTORY() [2/21]

◆ DEFINE_FACTORY() [3/21]

◆ DEFINE_FACTORY() [4/21]

◆ DEFINE_FACTORY() [5/21]

◆ DEFINE_FACTORY() [6/21]

◆ DEFINE_FACTORY() [7/21]

◆ DEFINE_FACTORY() [8/21]

◆ DEFINE_FACTORY() [9/21]

◆ DEFINE_FACTORY() [10/21]

◆ DEFINE_FACTORY() [11/21]

◆ DEFINE_FACTORY() [12/21]

◆ DEFINE_FACTORY() [13/21]

◆ DEFINE_FACTORY() [14/21]

◆ DEFINE_FACTORY() [15/21]

◆ DEFINE_FACTORY() [16/21]

◆ DEFINE_FACTORY() [17/21]

◆ DEFINE_FACTORY() [18/21]

◆ DEFINE_FACTORY() [19/21]

◆ DEFINE_FACTORY() [20/21]

◆ DEFINE_FACTORY() [21/21]

◆ initialise()

◆ loadLibrary()

◆ operator<<() [1/2]

◆ operator<<() [2/2]

◆ operator|() [1/2]

◆ operator|() [2/2]

◆ ParametersDescription::setKey< std::string >()

◆ printHeader()

Variable Documentation

◆ invalid_libraries

◆ loaded_libraries

◆ MODULE_NAME

◆ search_paths