herwig is hosted by Hepforge, IPPP Durham
Herwig  7.2.1
Herwig::MamboDecayer Class Reference

The MamboDecayer class inherits from the Decayer class in ThePEG and implements the algorithm of R.Kleiss and W.J.Stirling NPB 385 (1992) 413-432 for massive multi-particle phase-space decays. More...

#include <MamboDecayer.h>

Inheritance diagram for Herwig::MamboDecayer:

Public Member Functions

 MamboDecayer ()
 The default constructor.
 
virtual bool accept (tcPDPtr parent, const tPDVector &children) const
 Check if this decayer can perfom the decay for a particular mode. More...
 
virtual ParticleVector decay (const Particle &parent, const tPDVector &children) const
 Perform the decay of the particle to the specified decay products. More...
 
virtual void dataBaseOutput (ofstream &os, bool header) const
 Output the setup information for the particle database. 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 Herwig::HwDecayerBase
 HwDecayerBase ()
 The default constructor.
 
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...
 
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...
 
bool initialize () const
 Access to the initialize variable.
 
bool databaseOutput () const
 Access the database output variable.
 
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 (PPtr parent, PPtr progenitor, const bool &fs, const Energy &highestpT, const vector< tcPDPtr > &ids, const double &z, const Energy &scale, const Energy &pT)
 Apply the soft matrix element correction. More...
 
virtual RealEmissionProcessPtr generateHardest (RealEmissionProcessPtr)
 Apply the POWHEG style correction.
 
- 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 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())
 
 Named (const Named &)=default
 
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 Herwig::HwDecayerBase
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

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 doinitrun ()
 Initialize this object. More...
 
- Protected Member Functions inherited from Herwig::HwDecayerBase
void fixRho (RhoDMatrix &) const
 Set rho to be diagonal if no correlations.
 
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
 InterfacedBase (string newName)
 
 InterfacedBase (const InterfacedBase &i)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinit ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinit ()
 
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

MamboDecayeroperator= (const MamboDecayer &)=delete
 The assignment operator is private and must never be called. More...
 
double calculateMomentum (vector< Lorentz5Momentum > &mom, Energy comEn) const
 Set array of mometum to particles. More...
 
void colourConnections (const Particle &parent, ParticleVector &out) const
 Set up the colour connections for the decay. More...
 
Bessel Functions.
void BesselFns (const long double x, long double &f, long double &fp) const
 Compute the values $K_0(x)/K_1(x)$ and it's derivative using asymptotic expansion for large x values. More...
 
void BesselIExpand (const long double x, long double &f, long double &fp) const
 Compute the values $I_0(x)/I_1(x)$ and it's derivative using asymptotic expansion. More...
 
long double BesselI0 (const long double x) const
 Modified Bessel function of first kind $I_0(x)$. More...
 
long double BesselI1 (const long double x) const
 Modified Bessel function of first kind $I_1(x)$. More...
 
long double BesselK0 (const long double x) const
 Modified Bessel function of second kind $K_0(x)$. More...
 
long double BesselK1 (const long double x) const
 Modified Bessel function of second kind $K_1(x)$. More...
 

Private Attributes

double _maxweight
 Maximum weight.
 
vector< double > _a0
 Store coefficents for aysymptotic expansion of $\frac{I_0}{I_1}$.
 
vector< double > _a1
 Store data for aysymptotic expansion of the first derivative $\frac{I_0}{I_1}$.
 

Additional Inherited Members

- Public Types inherited from Herwig::HwDecayerBase
enum  POWHEGType { No, ISR, FSR, Both }
 Virtual members to be overridden by inheriting classes which implement hard corrections. More...
 
- 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 MamboDecayer class inherits from the Decayer class in ThePEG and implements the algorithm of R.Kleiss and W.J.Stirling NPB 385 (1992) 413-432 for massive multi-particle phase-space decays.

Definition at line 27 of file MamboDecayer.h.

Member Function Documentation

◆ accept()

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

Check if this decayer can perfom the decay for a particular mode.

Parameters
parentThe decaying particle
childrenThe decay products
Returns
true If this decayer can handle the given mode, otherwise false.

Implements Herwig::HwDecayerBase.

◆ BesselFns()

void Herwig::MamboDecayer::BesselFns ( const long double  x,
long double &  f,
long double &  fp 
) const
inlineprivate

Compute the values $K_0(x)/K_1(x)$ and it's derivative using asymptotic expansion for large x values.

Parameters
xThe argument
fThe value of the ratio
fpThe value of the derivative ratio

Definition at line 151 of file MamboDecayer.h.

References sqr().

◆ BesselI0()

long double Herwig::MamboDecayer::BesselI0 ( const long double  x) const
inlineprivate

Modified Bessel function of first kind $I_0(x)$.

Parameters
xArgument of Bessel Function

Definition at line 184 of file MamboDecayer.h.

References sqr(), and sqrt().

◆ BesselI1()

long double Herwig::MamboDecayer::BesselI1 ( const long double  x) const
inlineprivate

Modified Bessel function of first kind $I_1(x)$.

Parameters
xArgument of Bessel Function

Definition at line 204 of file MamboDecayer.h.

References sqr(), and sqrt().

◆ BesselIExpand()

void Herwig::MamboDecayer::BesselIExpand ( const long double  x,
long double &  f,
long double &  fp 
) const
inlineprivate

Compute the values $I_0(x)/I_1(x)$ and it's derivative using asymptotic expansion.

Parameters
xThe argument
fThe value of the ratio
fpThe value of the derivative ratio

Definition at line 169 of file MamboDecayer.h.

◆ BesselK0()

long double Herwig::MamboDecayer::BesselK0 ( const long double  x) const
inlineprivate

Modified Bessel function of second kind $K_0(x)$.

Parameters
xArgument of Bessel Function

Definition at line 224 of file MamboDecayer.h.

References sqrt().

◆ BesselK1()

long double Herwig::MamboDecayer::BesselK1 ( const long double  x) const
inlineprivate

Modified Bessel function of second kind $K_1(x)$.

Parameters
xArgument of Bessel Function

Definition at line 245 of file MamboDecayer.h.

References sqrt().

◆ calculateMomentum()

double Herwig::MamboDecayer::calculateMomentum ( vector< Lorentz5Momentum > &  mom,
Energy  comEn 
) const
private

Set array of mometum to particles.

Parameters
momMomentum set to be distributed over phase-space
comEnThe mass of the decaying particle
Returns
The weight of the configuration

◆ clone()

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

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

Definition at line 95 of file MamboDecayer.h.

◆ colourConnections()

void Herwig::MamboDecayer::colourConnections ( const Particle parent,
ParticleVector out 
) const
private

Set up the colour connections for the decay.

Parameters
parentThe incoming particle
outThe decay products

◆ dataBaseOutput()

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

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

Implements Herwig::HwDecayerBase.

◆ decay()

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

Perform the decay of the particle to the specified decay products.

Parameters
parentThe decaying particle
childrenThe decay products
Returns
a ParticleVector containing the decay products.

Implements Herwig::HwDecayerBase.

◆ doinitrun()

virtual void Herwig::MamboDecayer::doinitrun ( )
protectedvirtual

Initialize this object.

Called in the run phase just before a run begins.

Reimplemented from ThePEG::InterfacedBase.

◆ fullclone()

virtual IBPtr Herwig::MamboDecayer::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::InterfacedBase.

Definition at line 101 of file MamboDecayer.h.

◆ Init()

static void Herwig::MamboDecayer::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=()

MamboDecayer& Herwig::MamboDecayer::operator= ( const MamboDecayer )
privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

void Herwig::MamboDecayer::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::MamboDecayer::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: