This class implements the TVirtualMCDecayer interface.

The TPythia6 singleton object is used to decay particles. Note, that since this class modifies common blocks (global variables) it is defined as a singleton.

Definition at line 31 of file TPythia6Decayer.h.

Public Types
enum	EDecayType { kSemiElectronic , kDiElectron , kSemiMuonic , kDiMuon , kBJpsiDiMuon , kBJpsiDiElectron , kBPsiPrimeDiMuon , kBPsiPrimeDiElectron , kPiToMu , kKaToMu , kNoDecay , kHadronicD , kOmega , kPhiKK , kAll , kNoDecayHeavy , kHardMuons , kBJpsi , kWToMuon , kWToCharm , kWToCharmToMuon , kZDiMuon , kMaxDecay }

Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Public Member Functions
	TPythia6Decayer ()
	Constructor.

virtual	~TPythia6Decayer ()

virtual void	Decay (Int_t idpart, TLorentzVector *p)
	Decay a particle of type IDPART (PDG code) and momentum P.

virtual void	ForceDecay ()
	Force a particle decay mode.

void	ForceParticleDecay (Int_t particle, Int_t products, Int_t mult, Int_t npart)
	Force decay of particle into products with multiplicity mult.

void	ForceParticleDecay (Int_t particle, Int_t product, Int_t mult)
	Force decay of particle into products with multiplicity mult.

virtual Float_t	GetLifetime (Int_t kf)
	Get the life-time of a particle of type KF (a PDG code).

virtual Float_t	GetPartialBranchingRatio (Int_t ipart)
	Get the partial branching ratio for a particle of type IPART (a PDG code).

virtual Int_t	ImportParticles (TClonesArray *particles)
	Get the decay products into the passed PARTICLES TClonesArray of TParticles.

virtual void	Init ()
	Initialize the decayer.

virtual TClass *	IsA () const

virtual void	ReadDecayTable ()
	Read in particle data from an ASCII file.

virtual void	SetDecayTableFile (const char *name)

virtual void	SetForceDecay (EDecayType type)

virtual void	SetForceDecay (Int_t type)
	Force a particular decay type.

virtual void	Streamer (TBuffer &)
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	WriteDecayTable ()
	write particle data to an ASCII file.

Public Member Functions inherited from TVirtualMCDecayer
	TVirtualMCDecayer ()

virtual	~TVirtualMCDecayer ()

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual const char *	GetName () const
	Returns name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

virtual ULong_t	Hash () const
	Return hash value for this object.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	Operator delete [].

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static TPythia6Decayer *	Instance ()
	Get the singleton object.

Static Public Member Functions inherited from TVirtualMCDecayer
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Protected Member Functions
Int_t	CountProducts (Int_t channel, Int_t particle)
	Count number of decay products.

void	ForceHadronicD ()
	Force golden D decay modes.

void	ForceOmega ()
	Force Omega -> Lambda K- Decay.

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

Protected Attributes
TArrayF	fBraPart

EDecayType	fDecay

TString	fDecayTableFile

Static Protected Attributes
static TPythia6Decayer *	fgInstance = 0
	Branching ratios.

Additional Inherited Members
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

#include <TPythia6Decayer.h>

Inheritance diagram for TPythia6Decayer:

[legend]

Member Enumeration Documentation

◆ EDecayType

enum TPythia6Decayer::EDecayType

Enumerator
kSemiElectronic
kDiElectron
kSemiMuonic
kDiMuon
kBJpsiDiMuon
kBJpsiDiElectron
kBPsiPrimeDiMuon
kBPsiPrimeDiElectron
kPiToMu
kKaToMu
kNoDecay
kHadronicD
kOmega
kPhiKK
kAll
kNoDecayHeavy
kHardMuons
kBJpsi
kWToMuon
kWToCharm
kWToCharmToMuon
kZDiMuon
kMaxDecay

Definition at line 35 of file TPythia6Decayer.h.

Constructor & Destructor Documentation

◆ TPythia6Decayer()

TPythia6Decayer::TPythia6Decayer ( )

Constructor.

Definition at line 45 of file TPythia6Decayer.cxx.

◆ ~TPythia6Decayer()

virtual TPythia6Decayer::~TPythia6Decayer ( )

inlinevirtual

Definition at line 75 of file TPythia6Decayer.h.

Member Function Documentation

◆ Class()

static TClass * TPythia6Decayer::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TPythia6Decayer::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TPythia6Decayer::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 94 of file TPythia6Decayer.h.

◆ CountProducts()

Int_t TPythia6Decayer::CountProducts	(	Int_t	channel,
		Int_t	particle
	)

protected

Count number of decay products.

Definition at line 489 of file TPythia6Decayer.cxx.

◆ Decay()

void TPythia6Decayer::Decay	(	Int_t	idpart,
		TLorentzVector *	p
	)

virtual

Decay a particle of type IDPART (PDG code) and momentum P.

Implements TVirtualMCDecayer.

Definition at line 66 of file TPythia6Decayer.cxx.

◆ DeclFileName()

static const char * TPythia6Decayer::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 94 of file TPythia6Decayer.h.

◆ ForceDecay()

void TPythia6Decayer::ForceDecay ( )

virtual

Force a particle decay mode.

Implements TVirtualMCDecayer.

Definition at line 97 of file TPythia6Decayer.cxx.

◆ ForceHadronicD()

void TPythia6Decayer::ForceHadronicD ( )

protected

Force golden D decay modes.

Definition at line 500 of file TPythia6Decayer.cxx.

◆ ForceOmega()

void TPythia6Decayer::ForceOmega ( )

protected

Force Omega -> Lambda K- Decay.

Definition at line 613 of file TPythia6Decayer.cxx.

◆ ForceParticleDecay() [1/2]

void TPythia6Decayer::ForceParticleDecay	(	Int_t	particle,
		Int_t *	products,
		Int_t *	mult,
		Int_t	npart
	)

Force decay of particle into products with multiplicity mult.

Definition at line 585 of file TPythia6Decayer.cxx.

◆ ForceParticleDecay() [2/2]

void TPythia6Decayer::ForceParticleDecay	(	Int_t	particle,
		Int_t	product,
		Int_t	mult
	)

Force decay of particle into products with multiplicity mult.

Definition at line 558 of file TPythia6Decayer.cxx.

◆ GetLifetime()

Float_t TPythia6Decayer::GetLifetime ( Int_t kf )

virtual

Get the life-time of a particle of type KF (a PDG code).

Implements TVirtualMCDecayer.

Definition at line 286 of file TPythia6Decayer.cxx.

◆ GetPartialBranchingRatio()

Float_t TPythia6Decayer::GetPartialBranchingRatio ( Int_t ipart )

virtual

Get the partial branching ratio for a particle of type IPART (a PDG code).

Implements TVirtualMCDecayer.

Definition at line 276 of file TPythia6Decayer.cxx.

◆ ImportParticles()

Int_t TPythia6Decayer::ImportParticles ( TClonesArray * particles )

virtual

Get the decay products into the passed PARTICLES TClonesArray of TParticles.

Implements TVirtualMCDecayer.

Definition at line 77 of file TPythia6Decayer.cxx.

◆ Init()

void TPythia6Decayer::Init ( )

virtual

Initialize the decayer.

Implements TVirtualMCDecayer.

Definition at line 55 of file TPythia6Decayer.cxx.

◆ Instance()

TPythia6Decayer * TPythia6Decayer::Instance ( )

static

Get the singleton object.

Definition at line 36 of file TPythia6Decayer.cxx.

◆ IsA()

virtual TClass * TPythia6Decayer::IsA ( ) const

inlinevirtual

Returns: TClass describing current object

Reimplemented from TVirtualMCDecayer.

Definition at line 94 of file TPythia6Decayer.h.

◆ ReadDecayTable()

void TPythia6Decayer::ReadDecayTable ( )

virtual

Read in particle data from an ASCII file.

The file name must previously have been set using the member function SetDecayTableFile.

Implements TVirtualMCDecayer.

Definition at line 297 of file TPythia6Decayer.cxx.

◆ SetDecayTableFile()

void TPythia6Decayer::SetDecayTableFile ( const char * name )

inlinevirtual

Definition at line 97 of file TPythia6Decayer.h.

◆ SetForceDecay() [1/2]

virtual void TPythia6Decayer::SetForceDecay ( EDecayType type )

inlinevirtual

Definition at line 90 of file TPythia6Decayer.h.

◆ SetForceDecay() [2/2]

void TPythia6Decayer::SetForceDecay ( Int_t type )

virtual

Force a particular decay type.

Implements TVirtualMCDecayer.

Definition at line 85 of file TPythia6Decayer.cxx.

◆ Streamer()

virtual void TPythia6Decayer::Streamer ( TBuffer & R__b )

virtual

Stream an object of class TObject.

Reimplemented from TVirtualMCDecayer.

◆ StreamerNVirtual()

void TPythia6Decayer::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 94 of file TPythia6Decayer.h.

◆ WriteDecayTable()

void TPythia6Decayer::WriteDecayTable ( )

virtual

write particle data to an ASCII file.

The file name must previously have been set using the member function SetDecayTableFile.

Users can use this function to make an initial decay list file, which then can be edited by hand, and re-loaded into the decayer using ReadDecayTable.

The file syntax is

particle_list : partcle_data
              | particle_list particle_data
             ;
particle_data : particle_info
              | particle_info '\n' decay_list
              ;
particle_info : See below
              ;
decay_list    : decay_entry
              | decay_list decay_entry
              ;
decay_entry   : See below

The particle_info consists of 13 fields:

PDG code             int
Name                 string
Anti-particle name   string  if there's no anti-particle,
                             then this field must be the
                             empty string
Electic charge       int     in units of |e|/3
Color charge         int     in units of quark color charges
Have anti-particle   int     1 of there's an anti-particle
                             to this particle, or 0
                             otherwise
Mass                 float   in units of GeV
Resonance width      float
Max broadning        float
Lifetime             float
MWID                 int     ??? (some sort of flag)
Decay                int     1 if it decays. 0 otherwise

The format to write these entries in are

" %9  %-16s  %-16s%3d%3d%3d%12.5f%12.5f%12.5f%13.gf%3d%d\n"

The decay_entry consists of 8 fields:

On/Off               int     1 for on, -1 for off
Matrix element type  int
Branching ratio      float
Product 1            int     PDG code of decay product 1
Product 2            int     PDG code of decay product 2
Product 3            int     PDG code of decay product 3
Product 4            int     PDG code of decay product 4
Product 5            int     PDG code of decay product 5

The format for these lines are

" %5d%5d%12.5f%10d%10d%10d%10d%10d\n"

Definition at line 473 of file TPythia6Decayer.cxx.

Member Data Documentation

◆ fBraPart

TArrayF TPythia6Decayer::fBraPart

protected

Definition at line 64 of file TPythia6Decayer.h.

◆ fDecay

EDecayType TPythia6Decayer::fDecay

protected

Definition at line 63 of file TPythia6Decayer.h.

◆ fDecayTableFile

TString TPythia6Decayer::fDecayTableFile

protected

Definition at line 62 of file TPythia6Decayer.h.

◆ fgInstance

TPythia6Decayer * TPythia6Decayer::fgInstance = 0

staticprotected

Branching ratios.

Definition at line 66 of file TPythia6Decayer.h.

montecarlo/pythia6/inc/TPythia6Decayer.h

montecarlo/pythia6/src/TPythia6Decayer.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ EDecayType

Constructor & Destructor Documentation

◆ TPythia6Decayer()

◆ ~TPythia6Decayer()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ CountProducts()

◆ Decay()

◆ DeclFileName()

◆ ForceDecay()

◆ ForceHadronicD()

◆ ForceOmega()

◆ ForceParticleDecay() [1/2]

◆ ForceParticleDecay() [2/2]

◆ GetLifetime()

◆ GetPartialBranchingRatio()

◆ ImportParticles()

◆ Init()

◆ Instance()

◆ IsA()

◆ ReadDecayTable()

◆ SetDecayTableFile()

◆ SetForceDecay() [1/2]

◆ SetForceDecay() [2/2]

◆ Streamer()

◆ StreamerNVirtual()

◆ WriteDecayTable()

Member Data Documentation

◆ fBraPart

◆ fDecay

◆ fDecayTableFile

◆ fgInstance