The LuminosityFunction describes the momentum distribution of the incoming beams in an experiment. More...

#include <LuminosityFunction.h>

Inheritance diagram for ThePEG::LuminosityFunction:

[legend]

Public Member Functions
Standard constructors and destructors.
	LuminosityFunction (Energy a=45.6 GeV, Energy b=45.6 GeV)
	Default constructor.

Virtual functions to be overridden by sub-classes.
virtual bool	canHandle (const cPDPair &) const
	Return true if this luminosity function can actually handle a given pair of incoming particles.

virtual Energy	maximumCMEnergy () const
	Return the maximum possible center of mass energy for an event.

virtual LorentzRotation	getBoost () const
	Return the rotation needed to transform from the collision cm system to the labotatory system.

virtual double	Y () const
	Return the rapidity of the colliding particles (at the maximum energy) in the laboratory system.

virtual int	nDim (const cPDPair &) const
	How many random numbers are needed to generate a phase space point? Default is zero in which means the energy of the incoming particles is fixed.

virtual double	value (const cPDPair &, double l1, double l2) const
	The value of the luminosity function for the given particle types for the given energy fractions l1 and l2 ( \(l=\log(1/x)\)).

virtual pair< double, double >	generateLL (const double *r, double &jacobian) const
	Generate energy fractions l1 and l2 ( \(l=\log(1/x)\)) given 'nDim()' random numbers in the range ]0,1[ given by the iterators.

Public Member Functions inherited from ThePEG::HandlerBaseT< UseRandom >
virtual	~HandlerBaseT ()
	Destructor.

double	rnd () const
	Return a simple flat random number in the range ]0,1[.

double	rnd (double xu) const
	Return a simple flat random number in the range ]0,xu[.

double	rnd (double xl, double xu) const
	Return a simple flat random number in the range ]xl,xu[.

bool	rndbool () const
	Return true with 50% probability.

bool	rndbool (double p) const
	Return a true with probability p.

bool	rndbool (double p1, double p2) const
	Return a true with probability p1/(p1+p2).

int	rndsign (double p1, double p2, double p3) const
	Return -1, 0, or 1 with relative probabilities p1, p2, p3.

int	rnd2 (double p0, double p1) const
	Return an integer \(i\) with probability p \(i\)/(p0+p1).

int	rnd3 (double p0, double p1, double p2) const
	Return an integer \(i\) with probability p \(i\)/(p0+p1+p2).

int	rnd4 (double p0, double p1, double p2, double p3) const
	Return an integer/ \(i\) with probability p \(i\)(p0+p1+p2+p3).

long	irnd (long xu=2) const
	Return a simple flat random integrer number in the range [0,xu[.

long	irnd (long xl, long xu) const
	Return a simple flat random integrer number in the range [xl,xu[.

const StandardModelBase &	SM () const
	Return a reference to the object containing the standard model parameters for this run.

tSMPtr	standardModel () const
	Return a pointer to the object containing the standard model parameters for this run.

Public Member Functions inherited from ThePEG::Interfaced
virtual	~Interfaced ()
	Empty virtual destructor.

virtual bool	defaultInit ()
	Functions which are to be used during the actual event generation, after the setup is complete.

PPtr	getParticle (PID) const
	Create a new Particle instance given a id number.

PDPtr	getParticleData (PID) const
	Return a pointer to the ParticleData object corresponding to the given id number.

bool	used () const
	Returns true if this object has actally been used.

void	useMe () const
	Should be called to indicate that this object has actually been used.

tEGPtr	generator () const
	Return a pointer to the EventGenerator controlling the run.

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

Public Member Functions inherited from ThePEG::InterfacedBase
virtual	~InterfacedBase ()
	The virtual (empty) destructor;.

string	fullName () const
	Returns the full name of this object including its path, e.g.

string	name () const
	Returns the name of this object, without the path.

string	path () const
	Returns the path to this object including the trailing '/'.

string	comment () const
	Returns a comment assigned to this object.

void	setup (istream &is)
	Read setup info from a standard istream is.

void	update ()
	Calls the doupdate() function with recursion prevention.

void	init ()
	Calls the doinit() function with recursion prevention.

virtual bool	preInitialize () const
	Return true if this object needs to be initialized before all other objects (except those for which this function also returns true).

void	initrun ()
	Calls the doinitrun() function with recursion prevention.

void	finish ()
	Calls the dofinish() function with recursion prevention.

void	touch ()
	This function should be called every time something in this object has changed in a way that a sanity check with update() is needed.

void	reset ()
	Set the state of this object to uninitialized.

void	clear ()
	Calls reset() and unTouch().

InitState	state () const
	Return the state of initialization of this object.

bool	locked () const
	Return true if the BaseRepository is not allowed to change the state of this object.

bool	touched () const
	Return true if the state of this object has been changed since the last call to update().

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

Public Member Functions inherited from ThePEG::Base
virtual	~Base ()
	The virtual destructor.

void	debug () const
	Print out debugging information for this object on std::cerr.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType	referenceCount () const
	Return the reference count.

Public Member Functions inherited from ThePEG::Named
	Named (const string &newName=string())
	Constructor with name.

	Named (const Named &)=default
	Explicit default copy-constructor (too avoid compiler warnings)

const string &	name () const
	Return name.

bool	operator== (const Named &other) const
	Test for equality.

bool	operator< (const Named &other) const
	Lexicographical comparison.

Public Member Functions inherited from ThePEG::LastXCombInfo< XC >
const XC &	lastXComb () const
	Return a reference to the last selected XComb.

tXCPtr	lastXCombPtr () const
	Return a pointer to the last selected XComb.

const XC &	lastHeadXComb () const
	If the last selected XComb object belongs to a group of XComb's return a reference to the head XComb object for this group.

tXCPtr	lastHeadXCombPtr () const
	If the last selected XComb object belongs to a group of XComb's return a pointer to the head XComb object for this group.

const EventHandler &	lastEventHandler () const
	Return a reference to the currently used EventHandler.

tPExtrPtr	lastExtractor () const
	A pointer to the currently used parton extractor.

template<typename PDFT >
PDFT	pdf (tcPPtr parton) const
	Return the parton density used to extract the given parton.

const Cuts &	lastCuts () const
	A reference to the currently used kinematical cuts.

tCutsPtr	lastCutsPtr () const
	A pointer to the currently used kinematical cuts.

const PPair &	lastParticles () const
	Return the pair of incoming parton instances.

Energy2	lastS () const
	The last generated total energy squared of the incoming particles.

const PPair &	lastPartons () const
	Return the pair of incoming parton instances.

Energy2	lastSHat () const
	The last used interval in total parton-parton energy squared.

double	lastTau () const
	Return lastSHat()/lastS().

double	lastY () const
	The generated rapidity of the hard scattering sub-system.

double	lastP1 () const
	Log of one over the momentum fraction of the first incoming particle w.r.t.

double	lastP2 () const
	Log of one over the momentum fraction of the second incoming particle w.r.t.

double	lastL1 () const
	Log of one over the first incoming parton momentum fraction w.r.t.

double	lastL2 () const
	Log of one over the second incoming parton momentum fraction w.r.t.

double	lastX1 () const
	The first incoming parton momentum fraction w.r.t.

double	lastX2 () const
	The second incoming parton momentum fraction w.r.t.

double	lastE1 () const
	Return 1-lastX1() to highest possible precision for x \(\rightarrow\) 1.

double	lastE2 () const
	Return 1-lastX2() to highest possible precision for x \(\rightarrow\) 1.

double	lastFL1L2 () const
	The product of the parton density functions at the last generated phase-space point.

Energy2	lastScale () const
	The chosen scale of the hard scattering.

double	lastAlphaS () const
	Get the \(\alpha_S\) used in the hard scattering.

double	lastAlphaEM () const
	Get the \(\alpha_{EM}\) used in the hard scattering.

const vector< Lorentz5Momentum > &	meMomenta () const
	Return the momenta of the incoming and outgoing partons to be used by the matrix element object, in the order specified by the TreeDiagram objects given by the matrix element.

double	lastME2 () const
	Return the matrix element squared as calculated for the last phase space point.

double	lastPreweight () const
	Return the last preweight factor.

double	jacobian () const
	Get the last jacobian obtained when generating the kinematics for the call to dSigHatDR.

CrossSection	lastMECrossSection () const
	Return the partonic cross section as calculated for the last phase space point.

double	lastMEPDFWeight () const
	Return the PDF weight as calculated for the last phase space point, if the matrix element does supply PDF weights.

double	lastMECouplings () const
	Return the coupling weight as calculated for the last phase space point.

tSubProPtr	subProcess () const
	Return the SubProcess object corresponding to the last generated sub-process.

const cPDVector &	mePartonData () const
	Return the incoming and outgoing parton types to be used by the matrix element object, in the order specified by the TreeDiagram objects given by the matrix element.

Friends
class	EventHandler
	EventHandler is a friend.

Clone Methods.
Energy	theBeamEMaxA
	The maximum energy of the beam entering along the positive z-axis.

Energy	theBeamEMaxB
	The maximum energy of the beam entering along the negative z-axis.

static ClassDescription< LuminosityFunction >	initLuminosityFunction
	Describe an abstract class with persistent data.

virtual IBPtr	clone () const
	Make a simple clone of this object.

virtual IBPtr	fullclone () const
	Make a clone of this object, possibly modifying the cloned object to make it sane.

LuminosityFunction &	operator= (const LuminosityFunction &)=delete
	Private and non-existent assignment operator.

Simple access functions
Energy	beamEMaxA () const
	The maximum energy of the beam entering along the positive z-axis.

Energy	beamEMaxB () const
	The maximum energy of the beam entering along the negative z-axis.

void	beamEMaxA (Energy x)
	The maximum energy of the beam entering along the positive z-axis.

void	beamEMaxB (Energy x)
	The maximum energy of the beam entering along the negative z-axis.

Functions used by the persistent I/O system.
void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

void	select (tXCombPtr)
	Set information about the selected XComb.

static void	Init ()
	Standard Init function used to initialize the interface.

Additional Inherited Members
Public Types inherited from ThePEG::InterfacedBase
enum	InitState { initializing = -1 , uninitialized = 0 , initialized = 1 , runready = 2 }
	Enumeration reflecting the state of an InterfacedBase object. More...

Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int	CounterType
	The integer type used for counting.

Public Types inherited from ThePEG::LastXCombInfo< XC >
typedef ThePEG::Ptr< XC >::pointer	XCPtr
	Alias for a reference counted pointer to XC .

typedef ThePEG::Ptr< XC >::const_pointer	cXCPtr
	Alias for a reference counted pointer to a const XC .

typedef ThePEG::Ptr< XC >::transient_pointer	tXCPtr
	Alias for a transient pointer to XC .

typedef ThePEG::Ptr< XC >::transient_const_pointer	tcXCPtr
	Alias for a transient pointer to a const XC .

Static Public Member Functions inherited from ThePEG::HandlerBase
static void	Init ()
	Standard Init function used to initialize the interface.

Static Public Member Functions inherited from ThePEG::Interfaced
static void	Init ()
	Standard Init function.

Static Public Member Functions inherited from ThePEG::InterfacedBase
static void	Init ()
	Standard Init function.

Static Public Member Functions inherited from ThePEG::Base
static void	Init ()
	The standard Init function used to initialize the interfaces.

Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long	uniqueId
	The unique ID.

Protected Member Functions inherited from ThePEG::Interfaced
void	reporeg (IBPtr object, string name) const
	Register the given object in the Repository with the given name in a subdirectory with the same name as this object.

template<typename PtrT >
bool	setDefaultReference (PtrT &ptr, string classname, string objectname)
	If the pointer, ptr, to an object is not set, create an object of class classname and register it with the Repository with the given objectname in a sib-directory with the same name as this object.

	Interfaced ()
	Protected default constructor.

	Interfaced (const string &newName)
	Protected constructor taking a name as argument.

	Interfaced (const Interfaced &i)
	Protected copy-constructor.

void	setGenerator (tEGPtr generator)
	Protected function to reset the generator pointer, required for automatic decayer generation in Herwig++ BSM models.

Protected Member Functions inherited from ThePEG::InterfacedBase
virtual void	readSetup (istream &is)
	Read setup info from a standard istream is.

virtual void	doupdate ()
	Check sanity of the object during the setup phase.

virtual void	doinit ()
	Initialize this object after the setup phase before saving an EventGenerator to disk.

virtual void	doinitrun ()
	Initialize this object.

virtual void	dofinish ()
	Finalize this object.

virtual IVector	getReferences ()
	Return a vector of all pointers to Interfaced objects used in this object.

virtual void	rebind (const TranslationMap &)
	Rebind pointer to other Interfaced objects.

	InterfacedBase ()
	Protected default constructor.

	InterfacedBase (string newName)
	Protected constructor with the name given as argument.

	InterfacedBase (const InterfacedBase &i)
	Protected copy-constructor.

Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
	ReferenceCounted ()
	Default constructor.

	ReferenceCounted (const ReferenceCounted &)
	Copy-constructor.

ReferenceCounted &	operator= (const ReferenceCounted &)
	Assignment.

Protected Member Functions inherited from ThePEG::Named
const Named &	operator= (const Named &other)
	Assignment.

const string &	name (const string &newName)
	Set new name.

Static Protected Member Functions inherited from ThePEG::Interfaced
static void	registerRepository (IBPtr)
	Register an Interfaced object with the Repository.

static void	registerRepository (IBPtr, string newName)
	Register an Interfaced object with the Repository, giving it a name.

Protected Attributes inherited from ThePEG::LastXCombInfo< XC >
XCPtr	theLastXComb
	The pointer to the last selected XComb.

Detailed Description

The LuminosityFunction describes the momentum distribution of the incoming beams in an experiment.

This is used by a EventHandler to generate collisions in their CM system. The LuminosityFunction will be asked to produce a LorentzRotation giving the transformation to the laboratory system.

The LuminosityFunction inherits from the LastXCombInfo class to give easy access to the information of the generated primary sub-process in the selected XComb.

This base class implements simple fixed momentum beams with energies given by the BeamEMaxA and BeamEMaxB interfaces.

See also: The interfaces defined for LuminosityFunction.; XComb

Definition at line 39 of file LuminosityFunction.h.

Constructor & Destructor Documentation

◆ LuminosityFunction()

ThePEG::LuminosityFunction::LuminosityFunction	(	Energy	a = `45.6 *GeV`,
		Energy	b = `45.6 *GeV`
	)

Default constructor.

Optionally the maximum energy of beam a and b can be given.

Member Function Documentation

◆ beamEMaxA() [1/2]

Energy ThePEG::LuminosityFunction::beamEMaxA ( ) const

inline

The maximum energy of the beam entering along the positive z-axis.

Definition at line 114 of file LuminosityFunction.h.

References theBeamEMaxA.

◆ beamEMaxA() [2/2]

void ThePEG::LuminosityFunction::beamEMaxA ( Energy x )

inlineprotected

The maximum energy of the beam entering along the positive z-axis.

Definition at line 127 of file LuminosityFunction.h.

References theBeamEMaxA.

◆ beamEMaxB() [1/2]

Energy ThePEG::LuminosityFunction::beamEMaxB ( ) const

inline

The maximum energy of the beam entering along the negative z-axis.

Definition at line 119 of file LuminosityFunction.h.

References theBeamEMaxB.

◆ beamEMaxB() [2/2]

void ThePEG::LuminosityFunction::beamEMaxB ( Energy x )

inlineprotected

The maximum energy of the beam entering along the negative z-axis.

Definition at line 132 of file LuminosityFunction.h.

References theBeamEMaxB.

◆ canHandle()

virtual bool ThePEG::LuminosityFunction::canHandle ( const cPDPair & ) const

virtual

Return true if this luminosity function can actually handle a given pair of incoming particles.

Reimplemented in ThePEG::FixedTargetLuminosity.

◆ clone()

virtual IBPtr ThePEG::LuminosityFunction::clone ( ) const

protectedvirtual

Make a simple clone of this object.

Returns: a pointer to the new object.

Implements ThePEG::InterfacedBase.

Reimplemented in ThePEG::FixedCMSLuminosity, and ThePEG::FixedTargetLuminosity.

◆ fullclone()

virtual IBPtr ThePEG::LuminosityFunction::fullclone ( ) const

protectedvirtual

Make a clone of this object, possibly modifying the cloned object to make it sane.

Returns: a pointer to the new object.

Reimplemented from ThePEG::InterfacedBase.

Reimplemented in ThePEG::FixedCMSLuminosity, and ThePEG::FixedTargetLuminosity.

◆ generateLL()

virtual pair< double, double > ThePEG::LuminosityFunction::generateLL	(	const double *	r,
		double &	jacobian
	)		const

virtual

Generate energy fractions l1 and l2 ( \(l=\log(1/x)\)) given 'nDim()' random numbers in the range ]0,1[ given by the iterators.

The jacobian argument must be multiplied by the jacobian of the variable transformation to l1 and l2. The default version is just a delta function with a jacobian of 1.

◆ getBoost()

virtual LorentzRotation ThePEG::LuminosityFunction::getBoost ( ) const

virtual

Return the rotation needed to transform from the collision cm system to the labotatory system.

This default version returns the unit transformation.

Reimplemented in ThePEG::FixedTargetLuminosity.

◆ maximumCMEnergy()

virtual Energy ThePEG::LuminosityFunction::maximumCMEnergy ( ) const

virtual

Return the maximum possible center of mass energy for an event.

Reimplemented in ThePEG::FixedTargetLuminosity.

Referenced by ThePEG::FixedCMSLuminosity::energy().

◆ nDim()

virtual int ThePEG::LuminosityFunction::nDim ( const cPDPair & ) const

virtual

How many random numbers are needed to generate a phase space point? Default is zero in which means the energy of the incoming particles is fixed.

The only other reasonable values are 1 and 2.

◆ persistentInput()

void ThePEG::LuminosityFunction::persistentInput	(	PersistentIStream &	is,
		int	version
	)

Function used to read in object persistently.

Parameters

is	the persistent input stream read from.
version	the version number of the object when written.

◆ persistentOutput()

void ThePEG::LuminosityFunction::persistentOutput ( PersistentOStream & os ) const

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

◆ value()

virtual double ThePEG::LuminosityFunction::value	(	const cPDPair &	,
		double	l1,
		double	l2
	)		const

virtual

The value of the luminosity function for the given particle types for the given energy fractions l1 and l2 ( \(l=\log(1/x)\)).

The default version returns 1 if l1 and l2 are zero otherwize zero.

◆ Y()

virtual double ThePEG::LuminosityFunction::Y ( ) const

virtual

Return the rapidity of the colliding particles (at the maximum energy) in the laboratory system.

This default version assumes the CM system is the same as the lab system and returns zero.

Reimplemented in ThePEG::FixedTargetLuminosity.

Friends And Related Function Documentation

◆ EventHandler

friend class EventHandler

friend

EventHandler is a friend.

Definition at line 42 of file LuminosityFunction.h.

Member Data Documentation

◆ initLuminosityFunction

ClassDescription<LuminosityFunction> ThePEG::LuminosityFunction::initLuminosityFunction

staticprivate

Describe an abstract class with persistent data.

Definition at line 196 of file LuminosityFunction.h.

◆ theBeamEMaxA

Energy ThePEG::LuminosityFunction::theBeamEMaxA

private

The maximum energy of the beam entering along the positive z-axis.

Definition at line 184 of file LuminosityFunction.h.

Referenced by beamEMaxA().

◆ theBeamEMaxB

Energy ThePEG::LuminosityFunction::theBeamEMaxB

private

The maximum energy of the beam entering along the negative z-axis.

Definition at line 189 of file LuminosityFunction.h.

Referenced by beamEMaxB().

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

LuminosityFunction.h

Public Member Functions

Friends

Clone Methods.

Simple access functions

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LuminosityFunction()

Member Function Documentation

◆ beamEMaxA() [1/2]

◆ beamEMaxA() [2/2]

◆ beamEMaxB() [1/2]

◆ beamEMaxB() [2/2]

◆ canHandle()

◆ clone()

◆ fullclone()

◆ generateLL()

◆ getBoost()

◆ maximumCMEnergy()

◆ nDim()

◆ persistentInput()

◆ persistentOutput()

◆ value()

◆ Y()

Friends And Related Function Documentation

◆ EventHandler

Member Data Documentation

◆ initLuminosityFunction

◆ theBeamEMaxA

◆ theBeamEMaxB