herwig is hosted by Hepforge, IPPP Durham
Herwig  7.1.5
Herwig::HwDecayHandler Class Reference

The HwDecayHandler is the Herwig decay handler which administers the decays of unstable particles in Herwig. More...

#include <HwDecayHandler.h>

Inheritance diagram for Herwig::HwDecayHandler:

Public Member Functions

 HwDecayHandler ()
 Default constructor.
 
virtual void handle (EventHandler &eh, const tPVector &tagged, const Hint &hint)
 Look through all tagged particled and decay all unstable ones. More...
 
virtual void performDecay (tPPtr parent, Step &s) const
 Perform the decay of one unstable particle. More...
 
void addDecayedParticle (tPPtr parent, Step &s) const
 add the decay products of in intermediate particle produced in a decay More...
 
Functions used by the persistent I/O system.
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- Public Member Functions inherited from ThePEG::DecayHandler
void performDecay (tPPtr parent, Step &s) const
 
long maxLoop () const
 
Length maxLifeTime () const
 
bool lifeTimeOption () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
- Public Member Functions inherited from ThePEG::StepHandler
tEHPtr eventHandler () const
 
void eventHandler (tEHPtr)
 
tStepPtr newStep ()
 
tStepPtr currentStep ()
 
tEHPtr eventHandler () const
 
void eventHandler (tEHPtr)
 
tStepPtr newStep ()
 
tStepPtr currentStep ()
 
- Public Member Functions inherited from HandlerBaseT< UseRandom >
double rnd () const
 
double rnd (double xu) const
 
double rnd (double xl, double xu) const
 
bool rndbool () const
 
bool rndbool (double p) const
 
bool rndbool (double p1, double p2) const
 
int rndsign (double p1, double p2, double p3) const
 
int rnd2 (double p0, double p1) const
 
int rnd3 (double p0, double p1, double p2) const
 
int rnd4 (double p0, double p1, double p2, double p3) const
 
long irnd (long xu=2) const
 
long irnd (long xl, long xu) const
 
const StandardModelBase & SM () const
 
tSMPtr standardModel () const
 
- Public Member Functions inherited from ThePEG::Interfaced
virtual bool defaultInit ()
 
PPtr getParticle (PID) const
 
PDPtr getParticleData (PID) const
 
bool used () const
 
void useMe () const
 
tEGPtr generator () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
PPtr getParticle (PID) const
 
PDPtr getParticleData (PID) const
 
bool used () const
 
void useMe () const
 
tEGPtr generator () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
- Public Member Functions inherited from ThePEG::InterfacedBase
string fullName () const
 
string name () const
 
string path () const
 
string comment () const
 
void setup (istream &is)
 
virtual void debugme () const
 
void update ()
 
void init ()
 
virtual bool preInitialize () const
 
void initrun ()
 
void finish ()
 
void touch ()
 
void reset ()
 
void clear ()
 
InitState state () const
 
bool locked () const
 
bool touched () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
void update ()
 
void init ()
 
virtual bool preInitialize () const
 
void initrun ()
 
void finish ()
 
void touch ()
 
void reset ()
 
void clear ()
 
InitState state () const
 
bool locked () const
 
bool touched () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
- Public Member Functions inherited from ThePEG::Base
void debug () const
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 
const string & name () const
 
bool operator== (const Named &other) const
 
bool operator< (const Named &other) const
 

Static Public Member Functions

static void Init ()
 Standard Init function.
 
- Static Public Member Functions inherited from ThePEG::DecayHandler
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::StepHandler
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::HandlerBase
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::Interfaced
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::InterfacedBase
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::Base
static void Init ()
 

Protected Member Functions

void develop (tPPtr particle) const
 Develop a stable particle.
 
Clone Methods.
virtual IBPtr clone () const
 Make a simple clone of this object. More...
 
virtual IBPtr fullclone () const
 Make a clone of this object, possibly modifying the cloned object to make it sane. More...
 
Standard Interfaced functions.
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk. More...
 
- Protected Member Functions inherited from ThePEG::StepHandler
void createNewStep ()
 
- Protected Member Functions inherited from ThePEG::Interfaced
void reporeg (IBPtr object, string name) const
 
bool setDefaultReference (PtrT &ptr, string classname, string objectname)
 
 Interfaced (const string &newName)
 
 Interfaced (const Interfaced &i)
 
void setGenerator (tEGPtr generator)
 
- Protected Member Functions inherited from ThePEG::InterfacedBase
 InterfacedBase (string newName)
 
 InterfacedBase (const InterfacedBase &i)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinitrun ()
 
virtual void dofinish ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinitrun ()
 
virtual void dofinish ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (const Named &other)
 
const string & name (const string &newName)
 

Private Member Functions

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

Private Attributes

bool _newstep
 Option for adding particles in a new Step.
 
set< tcPDPtr_excluded
 Particles which should not be decayed.
 
vector< PDPtr_excludedVector
 Vector to fill the set as an interface.
 

Static Private Attributes

static ClassDescription< HwDecayHandlerinitHwDecayHandler
 Describe a concrete class with persistent date/.
 

Additional Inherited Members

- Public Types inherited from ThePEG::InterfacedBase
enum  InitState
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 
- Public Attributes inherited from ThePEG::InterfacedBase
 initializing
 
 uninitialized
 
 initialized
 
 runready
 
- Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long uniqueId
 
- Static Protected Member Functions inherited from ThePEG::Interfaced
static void registerRepository (IBPtr)
 
static void registerRepository (IBPtr, string newName)
 

Detailed Description

The HwDecayHandler is the Herwig decay handler which administers the decays of unstable particles in Herwig.

It is derived from ThePEG::DecayHandler and includes a different handle method in order to simulate decays including spin correlations.

The handle method decays all particles in the current step, including spin correlations. Another feature of the DecayHandler is that it correctly handles mutlistep decays where a Decayer supplys intermediate decay products in addition to the outgoing particles.

See also
ThePEG::StepHandler
ThePEG::CollisionHandler
ThePEG::SubProcessHandler
ThePEG::DecayHandler

Definition at line 39 of file HwDecayHandler.h.

Member Function Documentation

◆ addDecayedParticle()

void Herwig::HwDecayHandler::addDecayedParticle ( tPPtr  parent,
Step s 
) const

add the decay products of in intermediate particle produced in a decay

Parameters
parentthe particle which has been decayed.
sthe Step where decay products are inserted.
Exceptions
Vetoif the Handler requires the current step to be discarded.
Exceptionif something goes wrong.

◆ clone()

virtual IBPtr Herwig::HwDecayHandler::clone ( ) const
inlineprotectedvirtual

Make a simple clone of this object.

Returns
a pointer to the new object.

Reimplemented from ThePEG::DecayHandler.

Definition at line 113 of file HwDecayHandler.h.

◆ doinit()

virtual void Herwig::HwDecayHandler::doinit ( )
protectedvirtual

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

Exceptions
InitExceptionif object could not be initialized properly.

Reimplemented from ThePEG::InterfacedBase.

◆ fullclone()

virtual IBPtr Herwig::HwDecayHandler::fullclone ( ) const
inlineprotectedvirtual

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

Definition at line 119 of file HwDecayHandler.h.

◆ handle()

virtual void Herwig::HwDecayHandler::handle ( EventHandler eh,
const tPVector tagged,
const Hint hint 
)
virtual

Look through all tagged particled and decay all unstable ones.

Parameters
ehthe EventHandler in charge of the generation.
taggedthe vector of particles to consider. If empty, all final state particles in the current Step is considered.
hinta possible Hint which is ignored in this implementation.

Reimplemented from ThePEG::DecayHandler.

◆ performDecay()

virtual void Herwig::HwDecayHandler::performDecay ( tPPtr  parent,
Step s 
) const
virtual

Perform the decay of one unstable particle.

Parameters
parentthe particle to be decayed.
sthe Step where decay products are inserted.
Exceptions
Vetoif the Handler requires the current step to be discarded.
Exceptionif something goes wrong.

◆ persistentInput()

void Herwig::HwDecayHandler::persistentInput ( PersistentIStream is,
int  version 
)

Function used to read in object persistently.

Parameters
isthe persistent input stream read from.
versionthe version number of the object when written.

◆ persistentOutput()

void Herwig::HwDecayHandler::persistentOutput ( PersistentOStream os) const

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

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