herwig is hosted by Hepforge, IPPP Durham
Herwig  7.1.4

The HwDecayerBase class is the base class for Decayers in Herwig. More...

#include <HwDecayerBase.h>

Inheritance diagram for Herwig::HwDecayerBase:

Public Member Functions

 HwDecayerBase ()
 The default constructor.
 
Virtual functions required by the Decayer class.
virtual bool accept (const DecayMode &dm) const
 Check if this decayer can perfom the decay specified by the given decay mode. More...
 
virtual ParticleVector decay (const DecayMode &dm, const Particle &p) const
 Perform a decay for a given DecayMode and a given Particle instance. 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...
 
virtual void dataBaseOutput (ofstream &os, bool header) const =0
 Functions for the Herwig decayer. More...
 
bool initialize () const
 Access to the initialize variable.
 
bool databaseOutput () const
 Access the database output variable.
 
- Public Member Functions inherited from ThePEG::Decayer
Ptr< Amplitude >::pointer amplitude () const
 
virtual bool needsFullStep () const
 
virtual ParticleVector decay (const DecayMode &dm, const Particle &p, Step &step) const
 
virtual double brat (const DecayMode &dm, const ParticleData &pd, double oldbrat) const
 
virtual double brat (const DecayMode &dm, const Particle &p, double oldbrat) const
 
virtual ParticleVector getChildren (const DecayMode &dm, const Particle &parent) const
 
virtual void finalBoost (const Particle &parent, const ParticleVector &children) const
 
virtual void setScales (const Particle &parent, const ParticleVector &children) const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
virtual bool needsFullStep () const
 
virtual ParticleVector decay (const DecayMode &dm, const Particle &p, Step &step) const
 
virtual double brat (const DecayMode &dm, const ParticleData &pd, double oldbrat) const
 
virtual double brat (const DecayMode &dm, const Particle &p, double oldbrat) const
 
virtual ParticleVector getChildren (const DecayMode &dm, const Particle &parent) const
 
virtual void finalBoost (const Particle &parent, const ParticleVector &children) const
 
virtual void setScales (const Particle &parent, const ParticleVector &children) const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
- 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 IBPtr fullclone () const
 
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 ()
 The standard Init function used to initialize the interfaces. More...
 
- Static Public Member Functions inherited from ThePEG::Decayer
static ParticleVector DecayParticle (tPPtr parent, Step &step, long maxtry=1000)
 
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

Virtual functions to replaced those from the Decayer class.

This is so that the decay and accept members of this class can handle all the more complicated features of the DecayMode class

virtual bool accept (tcPDPtr parent, const tPDVector &children) const =0
 Check if this decayer can perfom the decay for a particular mode. More...
 
virtual ParticleVector decay (const Particle &parent, const tPDVector &children) const =0
 Perform the decay of the particle to the specified decay products. More...
 
Standard Interfaced functions.
virtual void dofinish ()
 Finalize this object. More...
 
- 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
virtual IBPtr clone () const=0
 
 InterfacedBase (string newName)
 
 InterfacedBase (const InterfacedBase &i)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinit ()
 
virtual void doinitrun ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinit ()
 
virtual void doinitrun ()
 
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

HwDecayerBaseoperator= (const HwDecayerBase &)
 The assignment operator is private and must never be called. More...
 

Private Attributes

bool _initialize
 perform initialisation
 
bool _dbOutput
 Print out database.
 

Static Private Attributes

static AbstractClassDescription< HwDecayerBaseinitHwDecayerBase
 The static object used to initialize the description of this class. More...
 
enum  POWHEGType { No, ISR, FSR, Both }
 Virtual members to be overridden by inheriting classes which implement hard corrections. More...
 
virtual POWHEGType hasPOWHEGCorrection ()
 Has a POWHEG style correction.
 
virtual bool hasMECorrection ()
 Has an old fashioned ME correction.
 
virtual void initializeMECorrection (RealEmissionProcessPtr, double &, double &)
 Initialize the ME correction.
 
virtual RealEmissionProcessPtr applyHardMatrixElementCorrection (RealEmissionProcessPtr)
 Apply the hard matrix element correction to a given hard process or decay.
 
virtual bool softMatrixElementVeto (ShowerProgenitorPtr initial, ShowerParticlePtr parent, Branching br)
 Apply the soft matrix element correction. More...
 
virtual RealEmissionProcessPtr generateHardest (RealEmissionProcessPtr)
 Apply the POWHEG style correction.
 

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 HwDecayerBase class is the base class for Decayers in Herwig.

It inherits from the Decayer class of ThePEG and implements additional functionality for the output of the results to the particle database and initialization of the datbase.

It also provide the option of specifying a class based on the DecayRadiationGenerator which should be used to generate QED radiation in the decay

See also
The interfaces defined for HwDecayerBase.

Definition at line 39 of file HwDecayerBase.h.

Member Enumeration Documentation

◆ POWHEGType

Virtual members to be overridden by inheriting classes which implement hard corrections.

Type of POWHEG correction

Definition at line 78 of file HwDecayerBase.h.

Member Function Documentation

◆ accept() [1/2]

virtual bool Herwig::HwDecayerBase::accept ( const DecayMode dm) const
virtual

Check if this decayer can perfom the decay specified by the given decay mode.

Parameters
dmthe DecayMode describing the decay.
Returns
true if this decayer can handle the given mode, otherwise false.

Implements ThePEG::Decayer.

◆ accept() [2/2]

virtual bool Herwig::HwDecayerBase::accept ( tcPDPtr  parent,
const tPDVector children 
) const
protectedpure virtual

◆ dataBaseOutput()

virtual void Herwig::HwDecayerBase::dataBaseOutput ( ofstream &  os,
bool  header 
) const
pure virtual

Functions for the Herwig decayer.

Output the setup information for the particle database

Parameters
osThe stream to output the information to
headerWhether or not to output the information for MySQL

Implemented in Herwig::DecayIntegrator, Herwig::a1ThreePionCLEODecayer, Herwig::a1ThreePionDecayer, Herwig::VectorMeson3PionDecayer, Herwig::SMTopDecayer, Herwig::EtaPiGammaGammaDecayer, Herwig::EtaPiPiGammaDecayer, Herwig::PScalarPScalarVectorDecayer, Herwig::PScalarVectorFermionsDecayer, Herwig::VectorMesonPScalarFermionsDecayer, Herwig::SMWDecayer, Herwig::OniumToOniumPiPiDecayer, Herwig::TensorMesonVectorVectorDecayer, Herwig::SMZDecayer, Herwig::EtaPiPiPiDecayer, Herwig::Baryon1MesonDecayerBase, Herwig::VectorMeson2MesonDecayer, Herwig::VectorMesonVectorVectorDecayer, Herwig::TauDecayer, Herwig::VectorMesonVectorPScalarDecayer, Herwig::TensorMesonVectorPScalarDecayer, Herwig::PScalarVectorVectorDecayer, Herwig::TensorMeson2PScalarDecayer, Herwig::VectorMeson2FermionDecayer, Herwig::SMHiggsWWDecayer, Herwig::a1SimpleDecayer, Herwig::SU3BaryonOctetOctetPhotonDecayer, Herwig::ScalarMesonFactorizedDecayer, Herwig::WeakPartonicDecayer, Herwig::QuarkoniumDecayer, Herwig::ScalarVectorVectorDecayer, Herwig::SU3BaryonOctetOctetScalarDecayer, Herwig::PartonicDecayerBase, Herwig::ScalarMesonTensorScalarDecayer, Herwig::ScalarScalarScalarDecayer, Herwig::SemiLeptonicScalarDecayer, Herwig::SU3BaryonSingletOctetPhotonDecayer, Herwig::HeavyDecayer, Herwig::PScalar4FermionsDecayer, Herwig::PVectorMesonVectorPScalarDecayer, Herwig::VectorMesonVectorScalarDecayer, Herwig::SU3BaryonOctetDecupletScalarDecayer, Herwig::SMHiggsFermionsDecayer, Herwig::BaryonFactorizedDecayer, Herwig::PScalarLeptonNeutrinoDecayer, Herwig::SU3BaryonSingletOctetScalarDecayer, Herwig::Hw64Decayer, Herwig::VectorMesonPVectorPScalarDecayer, Herwig::SU3BaryonDecupletOctetPhotonDecayer, Herwig::DtoKPiPiCLEO, Herwig::SU3BaryonDecupletOctetScalarDecayer, Herwig::DtoKPiPiMarkIII, Herwig::DtoKPiPiE691, Herwig::SemiLeptonicBaryonDecayer, Herwig::RadiativeHeavyBaryonDecayer, Herwig::MamboDecayer, Herwig::BtoSGammaDecayer, Herwig::NonLeptonicHyperonDecayer, Herwig::KornerKramerCharmDecayer, Herwig::NonLeptonicOmegaDecayer, Herwig::RadiativeHyperonDecayer, Herwig::OmegaXiStarPionDecayer, and Herwig::StrongHeavyBaryonDecayer.

◆ decay() [1/2]

virtual ParticleVector Herwig::HwDecayerBase::decay ( const DecayMode dm,
const Particle p 
) const
virtual

Perform a decay for a given DecayMode and a given Particle instance.

Parameters
dmthe DecayMode describing the decay.
pthe Particle instance to be decayed.
Returns
a ParticleVector containing the decay products.

Implements ThePEG::Decayer.

Reimplemented in Herwig::PartonicDecayerBase.

◆ decay() [2/2]

virtual ParticleVector Herwig::HwDecayerBase::decay ( const Particle parent,
const tPDVector children 
) const
protectedpure virtual

◆ dofinish()

virtual void Herwig::HwDecayerBase::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.

◆ Init()

static void Herwig::HwDecayerBase::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.

◆ operator=()

HwDecayerBase& Herwig::HwDecayerBase::operator= ( const HwDecayerBase )
private

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

void Herwig::HwDecayerBase::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::HwDecayerBase::persistentOutput ( PersistentOStream os) const

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ softMatrixElementVeto()

virtual bool Herwig::HwDecayerBase::softMatrixElementVeto ( ShowerProgenitorPtr  initial,
ShowerParticlePtr  parent,
Branching  br 
)
virtual

Apply the soft matrix element correction.

Parameters
initialThe particle from the hard process which started the shower
parentThe initial particle in the current branching
brThe branching struct
Returns
If true the emission should be vetoed

Reimplemented in Herwig::SMWDecayer, Herwig::SMTopDecayer, and Herwig::SMZDecayer.

Member Data Documentation

◆ initHwDecayerBase

AbstractClassDescription<HwDecayerBase> Herwig::HwDecayerBase::initHwDecayerBase
staticprivate

The static object used to initialize the description of this class.

Indicates that this is an abstract class with persistent data.

Definition at line 213 of file HwDecayerBase.h.


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