The LHAPDF class inherits from PDFBase and implements an interface to the LHAPDF library of parton density function parameterizations. More...

#include <LHAPDF6.h>

Inheritance diagram for ThePEG::LHAPDF:

[legend]

Public Member Functions
Standard constructors and destructors.
	LHAPDF ()
	The default constructor.

	LHAPDF (const LHAPDF &)
	The copy constructor.

Virtual functions to be overridden by sub-classes.
virtual bool	canHandleParticle (tcPDPtr particle) const
	Return true if this PDF can handle the extraction of partons from the given particle.

virtual cPDVector	partons (tcPDPtr particle) const
	Return the partons which this PDF may extract from the given particle.

virtual double	xfx (tcPDPtr particle, tcPDPtr parton, Energy2 partonScale, double x, double eps=0.0, Energy2 particleScale=ZERO) const
	The density.

virtual double	xfvl (tcPDPtr particle, tcPDPtr parton, Energy2 partonScale, double l, Energy2 particleScale=ZERO) const
	The valence density.

virtual double	xfvx (tcPDPtr particle, tcPDPtr parton, Energy2 partonScale, double x, double eps=0.0, Energy2 particleScale=ZERO) const
	The valence density.

virtual double	xfsx (tcPDPtr particle, tcPDPtr parton, Energy2 partonScale, double x, double eps=0.0, Energy2 particleScale=ZERO) const
	The sea density.

Simple access function.
const string &	PDFName () const
	The name if the PDF set to be used.

int	member () const
	The chosen member of the selected PDF set.

int	maxFlav () const
	The maximum number of flavours for which non-zero densities are reported.

Public Member Functions inherited from ThePEG::PDFBase
	PDFBase ()
	Default constructor.

	PDFBase (const PDFBase &)
	Copy-constructor.

virtual	~PDFBase ()
	Destructor.

virtual bool	canHandle (tcPDPtr particle) const
	Return true if canHandleParticle() and if the corresponding method for remnantHandler() returns true for the given particle.

virtual bool	hasPoleIn1 (tcPDPtr particle, tcPDPtr parton) const
	Return true if this PDF has a pole at $x=1$ for the given particle and parton.

virtual double	xfl (tcPDPtr particle, tcPDPtr parton, Energy2 partonScale, double l, Energy2 particleScale=ZERO) const
	The density.

virtual double	xfsl (tcPDPtr particle, tcPDPtr parton, Energy2 partonScale, double l, Energy2 particleScale=ZERO) const
	The sea density.

virtual double	flattenL (tcPDPtr particle, tcPDPtr parton, const PDFCuts &cut, double z, double &jacobian) const
	Generate a momentum fraction.

virtual double	flattenScale (tcPDPtr particle, tcPDPtr parton, const PDFCuts &cut, double l, double z, double &jacobian) const
	Generate scale (as a fraction of the maximum scale).

tcRemHPtr	remnantHandler () const
	Pointer to the remnant handler to handle remnant when extracting partons according to these densities.

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::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.

Protected Member Functions
Internal helper functions.
void	initPDFptr ()
	Initialize the LHAPDF library for the chosen PDF set if it has not been done before.

void	setPDFName (string name)
	Used by the interface to select a set according to a file name.

void	setPDFMember (int n)
	Used by the interface to select a member in the current set.

string	doTest (string input)
	Interface for simple tests.

Clone Methods.
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.

Protected Member Functions inherited from ThePEG::PDFBase
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 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.

Standard Interfaced functions.
::LHAPDF::PDF *	thePDF
	LHAPDF member object.

string	thePDFName
	The name of the selected PDF set.

int	theMember
	The chosen member of the selected PDF set.

int	theMaxFlav
	The maximum number of flavours for which non-zero densities are reported.

double	xMin
	The minimum $x$-value for the current PDF set.

double	xMax
	The maximum $x$-value for the current PDF set.

Energy2	Q2Min
	The minimum $Q^2$-value for the current PDF set.

Energy2	Q2Max
	The maximum $Q^2$-value for the current PDF set.

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.

LHAPDF &	operator= (const LHAPDF &)=delete
	The assignment operator is private and must never be called.

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.

static void	Init ()
	The standard Init function used to initialize the interfaces.

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.

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

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 Types inherited from ThePEG::PDFBase
enum	RangeException { rangeFreeze , rangeZero , rangeThrow }
	Indicate how to deal with x and Q2 which are out of range. More...

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::PDFBase
RemHPtr	theRemnantHandler
	A remnant handler which can generate remnants for the parton extracted withfor this PDF.

RangeException	rangeException
	Indicate to subclasses how to deal with x and Q2 which are out of range.

Detailed Description

The LHAPDF class inherits from PDFBase and implements an interface to the LHAPDF library of parton density function parameterizations.

This class is available even if LHAPDF was not properly installed when ThePEG was installed, but will then produce an error in the initialization.

Note that the valence densities from the xfvx() and xfvl() function will only work properly for nucleons. All other particles will have zero valence densities.

See also: The interfaces defined for LHAPDF.

Definition at line 37 of file LHAPDF6.h.

Member Function Documentation

◆ canHandleParticle()

virtual bool ThePEG::LHAPDF::canHandleParticle ( tcPDPtr particle ) const

virtual

Return true if this PDF can handle the extraction of partons from the given particle.

Implements ThePEG::PDFBase.

◆ clone()

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

protectedvirtual

Make a simple clone of this object.

Returns: a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ dofinish()

virtual void ThePEG::LHAPDF::dofinish ( )

protectedvirtual

Finalize this object.

Called in the run phase just after a run has ended. Used eg. to write out statistics.

Reimplemented from ThePEG::InterfacedBase.

◆ doinit()

virtual void ThePEG::LHAPDF::doinit ( )

protectedvirtual

Initialize this object after the setup phase before saving an EventGenerator to disk.

Exceptions

InitException if object could not be initialized properly.

Reimplemented from ThePEG::PDFBase.

◆ doinitrun()

virtual void ThePEG::LHAPDF::doinitrun ( )

protectedvirtual

Initialize this object.

Called in the run phase just before a run begins.

Reimplemented from ThePEG::InterfacedBase.

◆ fullclone()

virtual IBPtr ThePEG::LHAPDF::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.

◆ Init()

static void ThePEG::LHAPDF::Init ( )

static

The standard Init function used to initialize the interfaces.

Called exactly once for each class by the class description system before the main function starts or when this class is dynamically loaded.

◆ maxFlav()

int ThePEG::LHAPDF::maxFlav ( ) const

inline

The maximum number of flavours for which non-zero densities are reported.

The actual number of flavours may be less depending on the chosen PDF set.

Definition at line 136 of file LHAPDF6.h.

References theMaxFlav.

◆ member()

int ThePEG::LHAPDF::member ( ) const

inline

The chosen member of the selected PDF set.

Definition at line 129 of file LHAPDF6.h.

References theMember.

◆ operator=()

LHAPDF & ThePEG::LHAPDF::operator= ( const LHAPDF & )

privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ partons()

virtual cPDVector ThePEG::LHAPDF::partons ( tcPDPtr particle ) const

virtual

Return the partons which this PDF may extract from the given particle.

Implements ThePEG::PDFBase.

◆ PDFName()

const string & ThePEG::LHAPDF::PDFName ( ) const

inline

The name if the PDF set to be used.

The full name including the .LHpdf or .LHgrid suffix.

Definition at line 124 of file LHAPDF6.h.

References thePDFName.

◆ persistentInput()

void ThePEG::LHAPDF::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::LHAPDF::persistentOutput ( PersistentOStream & os ) const

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

◆ xfsx()

virtual double ThePEG::LHAPDF::xfsx	(	tcPDPtr	particle,
		tcPDPtr	parton,
		Energy2	partonScale,
		double	x,
		double	eps = `0.0`,
		Energy2	particleScale = `ZERO`
	)		const

virtual

The sea density.

Return the pdf for the given cvalence parton inside the given particle for the virtuality partonScale and momentum fraction x. The particle is assumed to have a virtuality particleScale. If not overidden by a sub class this implementation will assume that the difference between a quark and anti-quark distribution is due do valense quarks.

Reimplemented from ThePEG::PDFBase.

◆ xfvl()

virtual double ThePEG::LHAPDF::xfvl	(	tcPDPtr	particle,
		tcPDPtr	parton,
		Energy2	partonScale,
		double	l,
		Energy2	particleScale = `ZERO`
	)		const

virtual

The valence density.

Return the pdf for the given cvalence parton inside the given particle for the virtuality partonScale and logarithmic momentum fraction l. The particle is assumed to have a virtuality particleScale. This will only work properly for nucleons. All other particles will have zero valence densities

Reimplemented from ThePEG::PDFBase.

◆ xfvx()

virtual double ThePEG::LHAPDF::xfvx	(	tcPDPtr	particle,
		tcPDPtr	parton,
		Energy2	partonScale,
		double	x,
		double	eps = `0.0`,
		Energy2	particleScale = `ZERO`
	)		const

virtual

The valence density.

Return the pdf for the given cvalence parton inside the given particle for the virtuality partonScale and momentum fraction x (with x = 1-eps). The particle is assumed to have a virtuality particleScale. This will only work properly for nucleons. All other particles will have zero valence densities

Reimplemented from ThePEG::PDFBase.

◆ xfx()

virtual double ThePEG::LHAPDF::xfx	(	tcPDPtr	particle,
		tcPDPtr	parton,
		Energy2	partonScale,
		double	x,
		double	eps = `0.0`,
		Energy2	particleScale = `ZERO`
	)		const

virtual

The density.

Return the pdf for the given parton inside the given particle for the virtuality partonScale and momentum fraction x (with x = 1-eps). The particle is assumed to have a virtuality particleScale.

Reimplemented from ThePEG::PDFBase.

Member Data Documentation

◆ Q2Max

Energy2 ThePEG::LHAPDF::Q2Max

private

The maximum $Q^2$-value for the current PDF set.

Definition at line 285 of file LHAPDF6.h.

◆ Q2Min

Energy2 ThePEG::LHAPDF::Q2Min

private

The minimum $Q^2$-value for the current PDF set.

Definition at line 280 of file LHAPDF6.h.

◆ theMaxFlav

int ThePEG::LHAPDF::theMaxFlav

private

The maximum number of flavours for which non-zero densities are reported.

The actual number of flavours may be less depending on the chosen PDF set.

Definition at line 265 of file LHAPDF6.h.

Referenced by maxFlav().

◆ theMember

int ThePEG::LHAPDF::theMember

private

The chosen member of the selected PDF set.

Definition at line 258 of file LHAPDF6.h.

Referenced by member().

◆ thePDF

::LHAPDF::PDF* ThePEG::LHAPDF::thePDF

private

LHAPDF member object.

Definition at line 248 of file LHAPDF6.h.

◆ thePDFName

string ThePEG::LHAPDF::thePDFName

private

The name of the selected PDF set.

Definition at line 253 of file LHAPDF6.h.

Referenced by PDFName().

◆ xMax

double ThePEG::LHAPDF::xMax

private

The maximum $x$-value for the current PDF set.

Definition at line 275 of file LHAPDF6.h.

◆ xMin

double ThePEG::LHAPDF::xMin

private

The minimum $x$-value for the current PDF set.

Definition at line 270 of file LHAPDF6.h.

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

LHAPDF6.h

Public Member Functions

Protected Member Functions

Standard Interfaced functions.

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ canHandleParticle()

◆ clone()

◆ dofinish()

◆ doinit()

◆ doinitrun()

◆ fullclone()

◆ Init()

◆ maxFlav()

◆ member()

◆ operator=()

◆ partons()

◆ PDFName()

◆ persistentInput()

◆ persistentOutput()

◆ xfsx()

◆ xfvl()

◆ xfvx()

◆ xfx()

Member Data Documentation

◆ Q2Max

◆ Q2Min

◆ theMaxFlav

◆ theMember

◆ thePDF

◆ thePDFName

◆ xMax

◆ xMin