PhaseSpaceGenerator Class Reference

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

#include <CepGen/Process/PhaseSpaceGenerator.h>

Inheritance diagram for PhaseSpaceGenerator:

Collaboration diagram for PhaseSpaceGenerator:

Public Member Functions
	PhaseSpaceGenerator (const ParametersList &params)
virtual bool	ktFactorised () const
virtual void	setCentralCuts (const cuts::Central &)
	Set cuts on central particles.
virtual void	initialise (proc::FactorisedProcess *)=0
	Set all process parameters.
virtual bool	generate ()=0
	Generate a kinematics combination, and return a success flag.
virtual double	weight () const =0
	Return the event weight for a kinematics combination.
virtual pdgids_t	partons () const =0
	List of incoming partons in kinematics.
virtual void	setCentral (const std::vector< int > &)=0
	Override the central particles list.
virtual std::vector< int >	central () const =0
	List of outgoing central particles in kinematics.
virtual double	that () const =0
virtual double	uhat () const =0
const std::string &	name () const
	Module unique indexing name.
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 ()
	Describe all steering parameters for this module.

Protected Member Functions
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
const std::string	name_
	Module unique indexing name.
ParametersList	params_
	Module parameters.

Detailed Description

Author

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

Date

Feb 2024

Definition at line 34 of file PhaseSpaceGenerator.h.

Constructor & Destructor Documentation

PhaseSpaceGenerator()

PhaseSpaceGenerator ( const ParametersList &  params )

explicit

Definition at line 36 of file PhaseSpaceGenerator.h.

Member Function Documentation

central()

virtual std::vector< int > central ( ) const

pure virtual

Implemented in PhaseSpaceGenerator2to4< T >.

description()

static ParametersDescription description ( )

staticinherited

Definition at line 36 of file NamedModule.h.

generate()

virtual bool generate ( )

pure virtual

Implemented in PhaseSpaceGenerator2to4< T >.

initialise()

virtual void initialise ( proc::FactorisedProcess *  )

pure virtual

Implemented in PhaseSpaceGenerator2to4< T >.

ktFactorised()

virtual bool ktFactorised ( ) const

virtual

Reimplemented in PhaseSpaceGenerator2to4< T >.

Definition at line 38 of file PhaseSpaceGenerator.h.

name()

const std::string & name ( ) const

inherited

Definition at line 42 of file NamedModule.h.

operator!=()

template<typename T >

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

inherited

Definition at line 51 of file SteeredObject.h.

operator==()

template<typename T >

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

inherited

Definition at line 49 of file SteeredObject.h.

parameters()

template<typename T >

const ParametersList & parameters ( ) const

overridevirtualinherited

Reimplemented from Steerable.

Definition at line 54 of file SteeredObject.h.

partons()

virtual pdgids_t partons ( ) const

pure virtual

Implemented in PhaseSpaceGenerator2to4< T >.

setCentral()

virtual void setCentral ( const std::vector< int > &  )

pure virtual

Implemented in PhaseSpaceGenerator2to4< T >.

setCentralCuts()

virtual void setCentralCuts ( const cuts::Central &  )

virtual

Reimplemented in PhaseSpaceGenerator2to4< T >.

Definition at line 40 of file PhaseSpaceGenerator.h.

setDescribedParameters()

template<typename T >

void setDescribedParameters ( const ParametersList &  params_orig )

inherited

Definition at line 73 of file SteeredObject.h.

setParameters()

template<typename T >

virtual void setParameters ( const ParametersList &  params )

overridevirtualinherited

Reimplemented from Steerable.

Reimplemented in Initial, Remnants, CutsList, IncomingBeams, and Kinematics.

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.

that()

virtual double that ( ) const

pure virtual

Implemented in PhaseSpaceGenerator2to4< T >.

uhat()

virtual double uhat ( ) const

pure virtual

Implemented in PhaseSpaceGenerator2to4< T >.

weight()

virtual double weight ( ) const

pure virtual

Implemented in PhaseSpaceGenerator2to4< T >.

Member Data Documentation

name_

const std::string name_

protectedinherited

Definition at line 45 of file NamedModule.h.

params_

ParametersList params_

mutableprotectedinherited

Definition at line 50 of file Steerable.h.