Herwig 7 is hosted by Hepforge, IPPP Durham
Herwig  7.1.4
Herwig::GeneralThreeBodyDecayer Class Reference

Here is the documentation of the GeneralThreeBodyDecayer class. More...

#include <GeneralThreeBodyDecayer.h>

Inheritance diagram for Herwig::GeneralThreeBodyDecayer:

Public Types

typedef pair< tcPDPtr, Energy > PMPair
 A ParticleData ptr and (possible) mass pair. More...
 
- Public Types inherited from Herwig::DecayIntegrator
enum  MEOption { Initialize, Calculate, Terminate }
 Enum for the matrix element option.
 
- 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 Member Functions

 GeneralThreeBodyDecayer ()
 The default constructor.
 
bool setDecayInfo (PDPtr incoming, vector< PDPtr > outgoing, const vector< TBDiagram > &process, double symfac)
 Set the diagrams.
 
Virtual functions required by the Decayer class.
virtual ParticleVector decay (const Particle &parent, const tPDVector &children) const
 For a given decay mode and a given particle instance, perform the decay and return the decay products. More...
 
virtual int modeNumber (bool &cc, tcPDPtr parent, const tPDVector &children) const
 Which of the possible decays is required. More...
 
virtual double threeBodyMatrixElement (const int imode, const Energy2 q2, const Energy2 s3, const Energy2 s2, const Energy2 s1, const Energy m1, const Energy m2, const Energy m3) const
 The matrix element to be integrated for the three-body decays as a function of the invariant masses of pairs of the outgoing particles. More...
 
virtual Energy partialWidth (PMPair inpart, PMPair outa, PMPair outb, PMPair outc) const
 Function to return partial Width. More...
 
virtual double brat (const DecayMode &dm, const Particle &p, double oldbrat) const
 An overidden member to calculate a branching ratio for a certain 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...
 
- Public Member Functions inherited from Herwig::DecayIntegrator
 DecayIntegrator ()
 Default constructor.
 
virtual bool accept (tcPDPtr parent, const tPDVector &children) const
 Check if this decayer can perfom the decay for a particular mode. More...
 
int imode () const
 The mode being used for this decay.
 
void addMode (DecayPhaseSpaceModePtr mode, double maxwgt, const vector< double > wgts) const
 Add a phase-space mode to the list. More...
 
virtual double me2 (const int ichan, const Particle &part, const ParticleVector &decay, MEOption opt) const =0
 Return the matrix element squared for a given mode and phase-space channel. More...
 
DecayMEPtr ME () const
 The helicity amplitude matrix element for spin correlations.
 
virtual bool twoBodyMEcode (const DecayMode &, int &mecode, double &coupling) const
 Specify the $1\to2$ matrix element to be used in the running width calculation. More...
 
virtual WidthCalculatorBasePtr threeBodyMEIntegrator (const DecayMode &dm) const
 Method to return an object to calculate the 3 (or higher body) partial width. More...
 
virtual InvEnergy threeBodydGammads (const int imode, const Energy2 q2, const Energy2 s, const Energy m1, const Energy m2, const Energy m3) const
 The differential three body decay rate with one integral performed. More...
 
void setPartialWidth (const DecayMode &dm, int imode)
 Set the code for the partial width. More...
 
int findMode (const DecayMode &dm)
 Finds the phase-space mode corresponding to a given decay mode. More...
 
virtual void dataBaseOutput (ofstream &os, bool header) const
 Output the setup information for the particle database. More...
 
ParticleVector generatePhotons (const Particle &p, ParticleVector children)
 Members for the generation of QED radiation in the decays. More...
 
bool canGeneratePhotons ()
 check if photons can be generated in the decay
 
virtual double oneLoopVirtualME (unsigned int imode, const Particle &part, const ParticleVector &products)
 The one-loop virtual correction. More...
 
bool hasOneLoopME ()
 Whether or not the one loop matrix element is implemented.
 
virtual InvEnergy2 realEmissionME (unsigned int imode, const Particle &part, ParticleVector &products, unsigned int iemitter, double ctheta, double stheta, const LorentzRotation &rot1, const LorentzRotation &rot2)
 The real emission matrix element. More...
 
bool hasRealEmissionME ()
 Whether or not the real emission matrix element is implemented.
 
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 (ShowerProgenitorPtr initial, ShowerParticlePtr parent, Branching br)
 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 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 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 Herwig::DecayIntegrator
static void Init ()
 Standard Init function used to initialize the interfaces.
 
- 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

const vector< TBDiagram > & getProcessInfo () const
 Access the TBDiagrams that store the required information to create the diagrams.
 
PDPtr incoming () const
 Incoming particle.
 
const vector< PDPtr > & outgoing () const
 Outgoing particles.
 
unsigned int numberOfFlows () const
 Number of colour flows.
 
bool setColourFactors (double symfac)
 Set up the colour factors.
 
const vector< DVector > & getColourFactors () const
 Return the matrix of colour factors.
 
const vector< DVector > & getLargeNcColourFactors () const
 Return the matrix of colour factors.
 
const vector< unsigned int > & diagramMap () const
 Get the mapping between the phase-space channel and the diagram.
 
unsigned int widthOption () const
 Option for the handling of the widths of the intermediate particles.
 
void colourConnections (const Particle &parent, const ParticleVector &out) const
 Set colour connections. More...
 
void constructIntegratorChannels (vector< int > &intype, vector< Energy > &inmass, vector< Energy > &inwidth, vector< double > &inpow, vector< double > &inweights) const
 Method to construct the channels for the integrator to give the partial width. More...
 
void colourFlow (unsigned int flow) const
 Set the colour flow. More...
 
unsigned int const & colourFlow () const
 Set the colour flow.
 
double relativeError () const
 Relative error for GQ integration.
 
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 Herwig::DecayIntegrator
ParticleVector generate (bool inter, bool cc, const unsigned int &imode, const Particle &inpart) const
 Generate the momenta for the decay. More...
 
void imode (int in)
 Set the mode being use for this decay.
 
void ME (DecayMEPtr in) const
 Set the helicity matrix element for the decay.
 
void resetIntermediate (tcPDPtr part, Energy mass, Energy width)
 Reset the properities of all intermediates. More...
 
unsigned int numberModes () const
 Number of decay modes.
 
tDecayPhaseSpaceModePtr mode (unsigned int)
 Pointer to a mode.
 
tcDecayPhaseSpaceModePtr mode (unsigned int) const
 Pointer to a mode.
 
bool generateIntermediates () const
 Get whether or not the intermediates are included.
 
void generateIntermediates (bool in)
 Set whether or not the intermediates are included.
 
Energy initializePhaseSpaceMode (unsigned int imode, bool init, bool onShell=false) const
 Initialize the phase-space mode. More...
 
void hasOneLoopME (bool in)
 Whether or not the one loop matrix element is implemented.
 
void hasRealEmissionME (bool in)
 Whether or not the real emission matrix element is implemented.
 
virtual void doinitrun ()
 Initialize this object to the begining of the run phase.
 
- Protected Member Functions inherited from Herwig::HwDecayerBase
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 IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
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

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

Private Attributes

PDPtr _incoming
 Store the incoming particle.
 
vector< PDPtr_outgoing
 Outgoing particles.
 
vector< TBDiagram_diagrams
 Store the diagrams for the decay.
 
vector< unsigned int > _diagmap
 Map between the diagrams and the phase-space channels.
 
vector< DVector_colour
 Store colour factors for ME calc.
 
vector< DVector_colourLargeNC
 Store cololur factors for ME calc at large N_c.
 
unsigned int _nflow
 The number of colourflows.
 
WidthCalculatorBasePtr _widthcalc
 Reference to object to calculate the partial width.
 
unsigned int _widthopt
 Option for the treatment of the widths.
 
string _reftag
 Store a decay tag for this mode that can be tested when trying to determine whether it can be generated by this Decayer.
 
string _reftagcc
 Store a decay tag for the cc-mode that can be tested when trying to determine whether it can be generated by this Decayer.
 
unsigned int _iflow
 The colour flow.
 
unsigned int _intOpt
 Option for the construction of the gaussian integrator.
 
double _relerr
 Relative error for GQ integration of partial width.
 

Static Private Attributes

static AbstractClassDescription< GeneralThreeBodyDecayerinitGeneralThreeBodyDecayer
 The static object used to initialize the description of this class. More...
 

Additional Inherited Members

- 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

Here is the documentation of the GeneralThreeBodyDecayer class.

See also
The interfaces defined for GeneralThreeBodyDecayer.

Definition at line 21 of file GeneralThreeBodyDecayer.h.

Member Typedef Documentation

◆ PMPair

A ParticleData ptr and (possible) mass pair.

Definition at line 26 of file GeneralThreeBodyDecayer.h.

Member Function Documentation

◆ brat()

virtual double Herwig::GeneralThreeBodyDecayer::brat ( const DecayMode dm,
const Particle p,
double  oldbrat 
) const
virtual

An overidden member to calculate a branching ratio for a certain particle instance.

Parameters
dmThe DecayMode of the particle
pThe particle object
oldbratThe branching fraction given in the DecayMode object

Reimplemented from ThePEG::Decayer.

◆ colourConnections()

void Herwig::GeneralThreeBodyDecayer::colourConnections ( const Particle parent,
const ParticleVector out 
) const
protected

Set colour connections.

Parameters
parentParent particle
outParticle vector containing particles to connect colour lines

◆ colourFlow()

void Herwig::GeneralThreeBodyDecayer::colourFlow ( unsigned int  flow) const
inlineprotected

Set the colour flow.

Parameters
flowThe value for the colour flow

Definition at line 222 of file GeneralThreeBodyDecayer.h.

◆ constructIntegratorChannels()

void Herwig::GeneralThreeBodyDecayer::constructIntegratorChannels ( vector< int > &  intype,
vector< Energy > &  inmass,
vector< Energy > &  inwidth,
vector< double > &  inpow,
vector< double > &  inweights 
) const
protected

Method to construct the channels for the integrator to give the partial width.

Parameters
intypeTypes of the channels
inmassMass for the channels
inwidthWidth for the channels
inpowPower for the channels
inweightsWeights for the channels

◆ decay()

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

For a given decay mode and a given particle instance, perform the decay and return the decay products.

As this is the base class this is not implemented.

Returns
The vector of particles produced in the decay.

Reimplemented from Herwig::DecayIntegrator.

◆ doinit()

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

Reimplemented in Herwig::FtoFVVDecayer, Herwig::StoSFFDecayer, Herwig::VtoFFVDecayer, Herwig::StoFFVDecayer, and Herwig::FtoFFFDecayer.

◆ Init()

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

◆ modeNumber()

virtual int Herwig::GeneralThreeBodyDecayer::modeNumber ( bool &  cc,
tcPDPtr  parent,
const tPDVector children 
) const
virtual

Which of the possible decays is required.

Parameters
ccIs this mode the charge conjugate
parentThe decaying particle
childrenThe decay products

Implements Herwig::DecayIntegrator.

◆ operator=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ partialWidth()

virtual Energy Herwig::GeneralThreeBodyDecayer::partialWidth ( PMPair  inpart,
PMPair  outa,
PMPair  outb,
PMPair  outc 
) const
virtual

Function to return partial Width.

Parameters
inpartThe decaying particle.
outaFirst decay product.
outbSecond decay product.
outcThird decay product.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ threeBodyMatrixElement()

virtual double Herwig::GeneralThreeBodyDecayer::threeBodyMatrixElement ( const int  imode,
const Energy2  q2,
const Energy2  s3,
const Energy2  s2,
const Energy2  s1,
const Energy  m1,
const Energy  m2,
const Energy  m3 
) const
virtual

The matrix element to be integrated for the three-body decays as a function of the invariant masses of pairs of the outgoing particles.

Parameters
imodeThe mode for which the matrix element is needed.
q2The scale, i.e. the mass squared of the decaying particle.
s3The invariant mass squared of particles 1 and 2, $s_3=m^2_{12}$.
s2The invariant mass squared of particles 1 and 3, $s_2=m^2_{13}$.
s1The invariant mass squared of particles 2 and 3, $s_1=m^2_{23}$.
m1The mass of the first outgoing particle.
m2The mass of the second outgoing particle.
m3The mass of the third outgoing particle.
Returns
The matrix element

Reimplemented from Herwig::DecayIntegrator.

Member Data Documentation

◆ initGeneralThreeBodyDecayer

AbstractClassDescription<GeneralThreeBodyDecayer> Herwig::GeneralThreeBodyDecayer::initGeneralThreeBodyDecayer
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 240 of file GeneralThreeBodyDecayer.h.


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