FlavourGenerator is an abstract base class to be used to implement models describing the quark content of hadrons. More...

#include <FlavourGenerator.h>

Inheritance diagram for ThePEG::FlavourGenerator:

[legend]

Public Member Functions
Virtual functions to be overridden by subclasses.
virtual tcPDPair	generateHadron (tcPDPtr quark) const =0
	Generate a hadron from a quark.

tcPDPair	alwaysGenerateHadron (tcPDPtr quark) const
	Same as generateHadron(tcPDPtr), but throws an exception if no hadron could be produced.

virtual tcPDPtr	getHadron (tcPDPtr q1, tcPDPtr q2) const
	Get hadron from flavours.

virtual tcPDPtr	getHadron (long iq1, long iq2) const
	Get hadron from flavours.

tcPDPtr	alwaysGetHadron (tcPDPtr q1, tcPDPtr q2) const
	Same as getHadron(tcPDPtr, tcPDPtr) but thows an exception if no hadron could be produced.

tcPDPtr	alwaysGetHadron (long iq1, long iq2) const
	Same as getHadron(long, long) but thows an exception if no hadron could be produced.

virtual tcPDPtr	getBaryon (tcPDPtr q1, tcPDPtr q2, tcPDPtr q3) const
	Return a baryon with the flavour content given by the (anti)quarks in the argument.

virtual tcPDPtr	getBaryon (long q1, long q2, long q3) const
	Return a baryon with the flavour content given by the (anti)quarks in the argument.

tcPDPtr	alwaysGetBaryon (tcPDPtr q1, tcPDPtr q2, tcPDPtr q3) const
	Same as getBaryon(tcPDPtr, tcPDPtr, tcPDPtr), but throws an exception if no baryon could be produced.

tcPDPtr	alwaysGetBaryon (long q1, long q2, long q3) const
	Same as getBaryon(long, long, long), but throws an exception if no baryon could be produced.

virtual long	selectQuark () const =0
	Generate a random quark flavour.

virtual long	selectFlavour () const =0
	Generate a random (di)quark flavour.

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().

virtual IBPtr	fullclone () const
	Return a full clone of this object possibly doing things to the clone to make it sane.

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.

Functions used by the persistent I/O system.
static AbstractNoPIOClassDescription< FlavourGenerator >	initFlavourGenerator
	Describe aa abstract class without persistent data.

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 ()
	Standard Init function used to initialize the interface.

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

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

virtual IBPtr	clone () const =0
	Return a simple clone of this object.

	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.

Detailed Description

FlavourGenerator is an abstract base class to be used to implement models describing the quark content of hadrons.

FlavourGenerator inherits from the HandlerBase class.

The interface is based on the flavour generation implementation in Pythia but is general enough to be used in other situations. The main virtual functions to be overridden in subclasses are generateHadron(tcPDPtr), getHadron(tcPDPtr, tcPDPtr), getHadron(long, long) getBaryon(tcPDPtr, tcPDPtr, tcPDPtr), getBaryon(long, long, long), selectQuark() and selectFlavour(). In this base class the getHadron(tcPDPtr, tcPDPtr) and getHadron(long, long) are implemented to call eachother, so a subclass must implement at least one of them. The same thing is true for getBaryon(tcPDPtr, tcPDPtr, tcPDPtr) and getBaryon(long, long, long)

See also: The interfaces defined for FlavourGenerator.; HandlerBase

Definition at line 39 of file FlavourGenerator.h.

Member Function Documentation

◆ generateHadron()

virtual tcPDPair ThePEG::FlavourGenerator::generateHadron ( tcPDPtr quark ) const

pure virtual

Generate a hadron from a quark.

Given a quark(antiquark, diquark or antidiquark), choose a quark-antiquark (or antidiquark-diquark) pair. Return (first) a hadron formed by the original quark and the antiquark together with (second) the generated quark. Returns null pointers if the generation failed.

Parameters

quark a quark, antiquark, diquark or antidiquark.

Returns: a pair of ParticleData pointers. The first is the hadron produced and the second is the anti-partner of the (anti-)(di-)quark generated to form the hadron.

Implemented in ThePEG::SimpleFlavour.

◆ getBaryon() [1/2]

virtual tcPDPtr ThePEG::FlavourGenerator::getBaryon	(	long	q1,
		long	q2,
		long	q3
	)		const

virtual

Return a baryon with the flavour content given by the (anti)quarks in the argument.

The arguments are given as particle data pointers. The default versions will call getBaryon(tcPDPtr, tcPDPtr, tcPDPtr). If no corresponding hadron was formed it should return the null pointer.

Parameters

q1	the PDG code of the first flavour.
q2	the PDG code of the second flavour.
q3	the PDG code of the third flavour.

Returns: the corresponding baryon type or null if none could be generated.

Reimplemented in ThePEG::SimpleFlavour, and ThePEG::SimpleFlavour.

◆ getBaryon() [2/2]

virtual tcPDPtr ThePEG::FlavourGenerator::getBaryon	(	tcPDPtr	q1,
		tcPDPtr	q2,
		tcPDPtr	q3
	)		const

virtual

Return a baryon with the flavour content given by the (anti)quarks in the argument.

The arguments are given as particle data pointers. The default versions will call getBaryon(long, long, long). If no corresponding hadron was formed it should return the null pointer.

Parameters

q1	the first flavour.
q2	the second flavour.
q3	the third flavour.

Returns: the corresponding baryon type or null if none could be generated.

Reimplemented in ThePEG::SimpleFlavour.

◆ getHadron() [1/2]

virtual tcPDPtr ThePEG::FlavourGenerator::getHadron	(	long	iq1,
		long	iq2
	)		const

virtual

Get hadron from flavours.

Return a hadron with the flavour content given by the (anti-)(di-)quarks in the argument. The arguments are given as PDG codes. The default versions will call the getHadron(tcPDPtr, tcPDPtr).

Parameters

iq1	the PDG code of the first flavour.
iq2	the PDG code of the second flavour.

Returns: the corresponding hadron type or null if none could be generated.

Reimplemented in ThePEG::SimpleFlavour, and ThePEG::SimpleFlavour.

◆ getHadron() [2/2]

virtual tcPDPtr ThePEG::FlavourGenerator::getHadron	(	tcPDPtr	q1,
		tcPDPtr	q2
	)		const

virtual

Get hadron from flavours.

Return a hadron with the flavour content given by the (anti-)(di-)quarks in the argument. The arguments are given as ParticleData pointers. The default versions will call the getHadron(long, long).

Parameters

q1	the first flavour.
q2	the second flavour.

Returns: the corresponding hadron type or null if none could be generated.

Reimplemented in ThePEG::SimpleFlavour.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

◆ selectFlavour()

virtual long ThePEG::FlavourGenerator::selectFlavour ( ) const

pure virtual

Generate a random (di)quark flavour.

Implemented in ThePEG::SimpleFlavour.

◆ selectQuark()

virtual long ThePEG::FlavourGenerator::selectQuark ( ) const

pure virtual

Generate a random quark flavour.

Implemented in ThePEG::SimpleFlavour.

Member Data Documentation

◆ initFlavourGenerator

AbstractNoPIOClassDescription<FlavourGenerator> ThePEG::FlavourGenerator::initFlavourGenerator

staticprivate

Describe aa abstract class without persistent data.

Definition at line 179 of file FlavourGenerator.h.

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

FlavourGenerator.h

Public Member Functions

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ generateHadron()

◆ getBaryon() [1/2]

◆ getBaryon() [2/2]

◆ getHadron() [1/2]

◆ getHadron() [2/2]

◆ persistentInput()

◆ persistentOutput()

◆ selectFlavour()

◆ selectQuark()

Member Data Documentation

◆ initFlavourGenerator