The DecayHandler is the base class of all handlers implementing the administration of decays of unstable particles. More...

#include <DecayHandler.h>

Inheritance diagram for ThePEG::DecayHandler:

[legend]

Public Member Functions
Standard constructors and destructors.
	DecayHandler ()
	Default constructor.

virtual	~DecayHandler ()
	Destructor.

Virtual functions required by the StepHandler class.
virtual void	handle (EventHandler &eh, const tPVector &tagged, const Hint &hint)
	Look through all tagged particled and decay all unstable ones.

void	performDecay (tPPtr parent, Step &s) const
	Perform the decay of one unstable particle.

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

tEHPtr	eventHandler () const
	Get a pointer to the EventHandler which made the last call to handle().

void	eventHandler (tEHPtr)
	Set a pointer to the EventHandler which made the last call to handle().

tStepPtr	newStep ()
	Return a pointer to a new step.

tStepPtr	currentStep ()
	If a new step has been created, return it, otherwise return the current step from the eventHandler().

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.

Clone Methods.
long	theMaxLoop
	The maximum number of failed decay attempts allowed for each particle.

Length	theMaxLifeTime
	The maximum lifetime above which a particle is not decayed.

bool	theLifeTimeOption
	Option for how theMaxLifeTime should be interpreted.

static ClassDescription< DecayHandler >	initDecayHandler
	Describe a concrete 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.

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

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.

long	maxLoop () const
	The maximum number of failed decay attempts allowed for each particle.

Length	maxLifeTime () const
	Get the maximum lifetime above which a particle is not decayed.

bool	lifeTimeOption () const
	Option for whether the maximum lifetime should be applied to the mean lifetime of the particle species or the lifetime of the particle instance.

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.

Static Public Member Functions inherited from ThePEG::StepHandler
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 Member Functions inherited from ThePEG::StepHandler
void	createNewStep ()
	Use the collision handler to create a new step.

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.

Detailed Description

The DecayHandler is the base class of all handlers implementing the administration of decays of unstable particles.

It is derived from the more general StepHandler class, and overrides the handle() method. This base class simply decays all unstable particle in the current step.

See also: The interfaces defined for DecayHandler.; StepHandler; EventHandler; SubProcessHandler

Definition at line 31 of file DecayHandler.h.

Constructor & Destructor Documentation

◆ DecayHandler()

ThePEG::DecayHandler::DecayHandler ( )

inline

Default constructor.

Definition at line 40 of file DecayHandler.h.

Member Function Documentation

◆ clone()

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

protectedvirtual

Make a simple clone of this object.

Returns: a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ fullclone()

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

◆ handle()

virtual void ThePEG::DecayHandler::handle	(	EventHandler &	eh,
		const tPVector &	tagged,
		const Hint &	hint
	)

virtual

Look through all tagged particled and decay all unstable ones.

Parameters

eh	the EventHandler in charge of the generation.
tagged	the vector of particles to consider. If empty, all final state particles in the current Step is considered.
hint	a possible Hint which is ignored in this implementation.

Implements ThePEG::StepHandler.

◆ lifeTimeOption()

bool ThePEG::DecayHandler::lifeTimeOption ( ) const

inline

Option for whether the maximum lifetime should be applied to the mean lifetime of the particle species or the lifetime of the particle instance.

Definition at line 109 of file DecayHandler.h.

References theLifeTimeOption.

◆ maxLifeTime()

Length ThePEG::DecayHandler::maxLifeTime ( ) const

inline

Get the maximum lifetime above which a particle is not decayed.

Definition at line 102 of file DecayHandler.h.

References theMaxLifeTime.

◆ maxLoop()

long ThePEG::DecayHandler::maxLoop ( ) const

inline

The maximum number of failed decay attempts allowed for each particle.

Definition at line 97 of file DecayHandler.h.

References theMaxLoop.

◆ performDecay()

void ThePEG::DecayHandler::performDecay	(	tPPtr	parent,
		Step &	s
	)		const

Perform the decay of one unstable particle.

Parameters

parent	the particle to be decayed.
s	the Step where decay products are inserted.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

Member Data Documentation

◆ initDecayHandler

ClassDescription<DecayHandler> ThePEG::DecayHandler::initDecayHandler

staticprivate

Describe a concrete class with persistent data.

Definition at line 151 of file DecayHandler.h.

◆ theLifeTimeOption

bool ThePEG::DecayHandler::theLifeTimeOption

private

Option for how theMaxLifeTime should be interpreted.

Definition at line 144 of file DecayHandler.h.

Referenced by lifeTimeOption().

◆ theMaxLifeTime

Length ThePEG::DecayHandler::theMaxLifeTime

private

The maximum lifetime above which a particle is not decayed.

Definition at line 139 of file DecayHandler.h.

Referenced by maxLifeTime().

◆ theMaxLoop

long ThePEG::DecayHandler::theMaxLoop

private

The maximum number of failed decay attempts allowed for each particle.

Definition at line 134 of file DecayHandler.h.

Referenced by maxLoop().

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

DecayHandler.h

Public Member Functions

Clone Methods.

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DecayHandler()

Member Function Documentation

◆ clone()

◆ fullclone()

◆ handle()

◆ lifeTimeOption()

◆ maxLifeTime()

◆ maxLoop()

◆ performDecay()

◆ persistentInput()

◆ persistentOutput()

Member Data Documentation

◆ initDecayHandler

◆ theLifeTimeOption

◆ theMaxLifeTime

◆ theMaxLoop