PartonsPhaseSpaceGenerator Class Reference

A generic phase space integration wrapper. More...

#include <CepGen/Process/PartonsPhaseSpaceGenerator.h>

Inheritance diagram for PartonsPhaseSpaceGenerator:

Collaboration diagram for PartonsPhaseSpaceGenerator:

Public Member Functions
	PartonsPhaseSpaceGenerator (const ParametersList &params)
void	initialise (proc::FactorisedProcess *process)
virtual bool	ktFactorised () const =0
	Do incoming partons carry a primordial kT?
virtual bool	generatePartonKinematics ()=0
	Generate the 4-momentum of incoming partons.
virtual double	fluxes () const =0
	Retrieve the event weight in the phase space.
template<typename T = PartonFlux>
const T &	positiveFlux () const
	Retrieve a type-casted positive-z parton flux modelling.
template<typename T = PartonFlux>
const T &	negativeFlux () const
	Retrieve a type-casted negative-z parton flux modelling.
bool	operator== (const SteeredObject &oth) const
	Equality operator.
bool	operator!= (const SteeredObject &oth) const
	Inequality operator.
const ParametersList &	parameters () const override
	Module user-defined parameters.
virtual void	setParameters (const ParametersList &params) override
	Set module parameters.
void	setDescribedParameters (const ParametersList &params_orig)
	Set (documented) module parameters.

Static Public Member Functions
static ParametersDescription	description ()
	Description of all object parameters.

Protected Member Functions
virtual void	initialise ()=0
	Initialise the process and define the integration phase space.
proc::FactorisedProcess &	process ()
	Consumer process object Const-qualified consumer process object.
const proc::FactorisedProcess &	process () const
template<typename T >
T	steer (const std::string &key) const
	Retrieve a parameters as previously steered.
template<typename T , typename U >
U	steerAs (const std::string &key) const
	Retrieve a recasted parameters as previously steered.
std::string	steerName () const
	Retrieve module name from parameters.
std::string	steerPath (const std::string &key) const
	Retrieve a path from common search paths.

Protected Attributes
std::unique_ptr< PartonFlux >	pos_flux_ {nullptr}
std::unique_ptr< PartonFlux >	neg_flux_ {nullptr}
ParametersList	params_
	Module parameters.

Detailed Description

Class template to define any phase space helper process

Author

Laurent Forthomme laure.nosp@m.nt.f.nosp@m.ortho.nosp@m.mme@.nosp@m.cern..nosp@m.ch

Date

Jul 2023

Definition at line 37 of file PartonsPhaseSpaceGenerator.h.

Constructor & Destructor Documentation

PartonsPhaseSpaceGenerator()

PartonsPhaseSpaceGenerator ( const ParametersList &  params )

explicit

Definition at line 39 of file PartonsPhaseSpaceGenerator.h.

Member Function Documentation

description()

ParametersDescription description ( )

staticinherited

Definition at line 42 of file Steerable.cpp.

fluxes()

virtual double fluxes ( ) const

pure virtual

Implemented in PartonsCollinearPhaseSpaceGenerator, and PartonsKTPhaseSpaceGenerator.

generatePartonKinematics()

virtual bool generatePartonKinematics ( )

pure virtual

Implemented in PartonsCollinearPhaseSpaceGenerator, and PartonsKTPhaseSpaceGenerator.

initialise() [1/2]

virtual void initialise ( )

protectedpure virtual

initialise() [2/2]

void initialise

(

proc::FactorisedProcess *

process

)

Definition at line 41 of file PartonsPhaseSpaceGenerator.h.

ktFactorised()

virtual bool ktFactorised ( ) const

pure virtual

Implemented in PartonsCollinearPhaseSpaceGenerator, and PartonsKTPhaseSpaceGenerator.

negativeFlux()

template<typename T = PartonFlux>

const T & negativeFlux

(

)

const

Definition at line 57 of file PartonsPhaseSpaceGenerator.h.

operator!=()

bool operator!= ( const SteeredObject< PartonsPhaseSpaceGenerator > &  oth ) const

inherited

Definition at line 51 of file SteeredObject.h.

operator==()

bool operator== ( const SteeredObject< PartonsPhaseSpaceGenerator > &  oth ) const

inherited

Definition at line 49 of file SteeredObject.h.

parameters()

const ParametersList & parameters ( ) const

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 54 of file SteeredObject.h.

positiveFlux()

template<typename T = PartonFlux>

const T & positiveFlux

(

)

const

Definition at line 52 of file PartonsPhaseSpaceGenerator.h.

process() [1/2]

proc::FactorisedProcess & process ( )

protected

Definition at line 63 of file PartonsPhaseSpaceGenerator.h.

process() [2/2]

const proc::FactorisedProcess & process ( ) const

protected

Definition at line 65 of file PartonsPhaseSpaceGenerator.h.

setDescribedParameters()

void setDescribedParameters ( const ParametersList &  params_orig )

inherited

Definition at line 73 of file SteeredObject.h.

setParameters()

virtual void setParameters ( const ParametersList &  params )

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 62 of file SteeredObject.h.

steer()

template<typename T >

T steer ( const std::string &  key ) const

protectedinherited

Definition at line 39 of file Steerable.h.

steerAs()

template<typename T , typename U >

U steerAs ( const std::string &  key ) const

protectedinherited

Definition at line 44 of file Steerable.h.

steerName()

std::string steerName ( ) const

protectedinherited

Definition at line 48 of file Steerable.h.

steerPath()

std::string steerPath ( const std::string &  key ) const

protectedinherited

Definition at line 30 of file Steerable.cpp.

Member Data Documentation

neg_flux_

std::unique_ptr<PartonFlux> neg_flux_ {nullptr}

protected

Definition at line 66 of file PartonsPhaseSpaceGenerator.h.

params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.

pos_flux_

std::unique_ptr<PartonFlux> pos_flux_ {nullptr}

protected

Definition at line 66 of file PartonsPhaseSpaceGenerator.h.