herwig is hosted by Hepforge, IPPP Durham
Herwig  7.1.4

The GenericWidthGenerator class is designed to automatically calculate the running width for a given particle using information from the decayModes and the Decayers to construct the running width. More...

#include <GenericWidthGenerator.h>

Inheritance diagram for Herwig::GenericWidthGenerator:

Public Member Functions

 GenericWidthGenerator ()
 Default constructor.
 
virtual bool accept (const ParticleData &part) const
 Return true if this width generator can handle the given particle type. More...
 
virtual void dataBaseOutput (ofstream &output, bool header=true)
 Output the initialisation info for the database. More...
 
virtual Length lifeTime (const ParticleData &, Energy m, Energy w) const
 Given a particle type and a mass and a width of an instance of that particle type, generate a life time.
 
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...
 
Members to calculate the width and decay modes.
virtual Energy width (const ParticleData &part, Energy m) const
 Calculate the width. More...
 
virtual DecayMap rate (const ParticleData &part) const
 Initialize the given decay map for the given particle type. More...
 
virtual DecayMap rate (const Particle &part)
 Return a decay map for a given particle instance. More...
 
virtual Energy partialWidth (int iloc, Energy m) const
 The partial width for a given mode. More...
 
virtual pair< Energy, Energy > width (Energy, const ParticleData &) const
 Return the total width and the sum of the partial widths for modes which are used.
 
- Public Member Functions inherited from ThePEG::WidthGenerator
Energy width (const Particle &) const
 
Energy width (const Particle &) 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 used to initialize the interfaces.
 
- Static Public Member Functions inherited from ThePEG::WidthGenerator
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

Energy partial2BodyWidth (int iloc, Energy q) const
 The $1\to2$ width for on-shell particles. More...
 
virtual Energy partial2BodyWidth (int iloc, Energy m0, Energy m1, Energy m2) const
 The $1\to2$ width for outgoing particles which can be off-shell. More...
 
virtual void setupMode (tcDMPtr mode, tDecayIntegratorPtr decayer, unsigned int imode)
 Perform the set up for a mode in classes inheriting from this one. More...
 
tPDPtr particle () const
 Access to the particle dat for inheriting classes.
 
void particle (tPDPtr in)
 Set the particle.
 
int MEcode (int imode) const
 Matrix element code for a given mode. More...
 
double MEcoupling (int imode) const
 Coupling for a given mode. More...
 
Energy mass () const
 The on-shell mass of the particle.
 
bool initialize () const
 Access to the decay modes. More...
 
bool output () const
 Output option for use by the inheriting classes.
 
vector< tDMPtrdecayModes () const
 Access to the DecayModes.
 
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 and EventGenerator to disk. More...
 
virtual void dofinish ()
 Finalize this object. More...
 
virtual void rebind (const TranslationMap &trans)
 Rebind pointer to other Interfaced objects. More...
 
virtual IVector getReferences ()
 Return a vector of all pointers to Interfaced objects used in 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 doinitrun ()
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinitrun ()
 
- 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

void setParticle (string)
 Helper function for the interface.
 
string getParticle () const
 Helper function for the interface.
 
GenericWidthGeneratoroperator= (const GenericWidthGenerator &)
 Private and non-existent assignment operator.
 

Private Attributes

tPDPtr particle_
 The pointer to the ParticleData object for the particle for this width generator.
 
vector< tDMPtrdecayModes_
 The decaymodes.
 
vector< string > decayTags_
 The tags for the DecayMode s.
 
vector< Energy > minMass_
 The minimum mass of the decaying particle for which this decay mode is possible.
 
Energy mass_
 The on-shell mass of the particle.
 
double prefactor_
 Prefactor to get the on-shell width.
 
vector< int > MEtype_
 The type of ME, whether it is fixed, calculated by this class or interpolation.
 
vector< int > MEcode_
 The code for the matrix element.
 
vector< Energy > MEmass1_
 Mass of the first outgoing particle for the simple $1\to2$ ME's.
 
vector< Energy > MEmass2_
 Mass of the second outgoing particle for the simple $1\to2$ ME's.
 
vector< double > MEcoupling_
 the coupling for a given me
 
vector< bool > modeOn_
 is this mode used for the running width
 
vector< Energy > interMasses_
 storage of the massesto set up the interpolation tables
 
vector< Energy > interWidths_
 storage of the widths to set up the interpolation tables
 
vector< int > noOfEntries_
 the number of entries in the decay table for a particular mode
 
bool initialize_
 initialize the generator using the particle data object
 
bool output_
 Output the parameters.
 
bool BRnorm_
 normalise the terms so that the partial widths for an on-shell particle are correct
 
int npoints_
 number of points to use for interpolation tables
 
vector< Interpolator< Energy, Energy >::Ptr > interpolators_
 intepolators for the running width
 
double BRminimum_
 minimum branching ratio for the inclusion in the total running width
 
unsigned int intOrder_
 Order of the interpolation for the tables.
 
bool twoBodyOnly_
 Whether or not to only include 2 body modes in the running width calculation, higher modes flat.
 

Friends

class ModelGenerator
 ModelGenerator class as must be friend to set the particle.
 
class TwoBodyAllOnCalculator
 A friend class so the off-shell matrix elements can be integrated.
 

Additional Inherited Members

- Public Types inherited from ThePEG::WidthGenerator
typedef Selector< tDMPtrDecayMap
 
- 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 GenericWidthGenerator class is designed to automatically calculate the running width for a given particle using information from the decayModes and the Decayers to construct the running width.

It also gives us the option of selecting the decay modes for a particle based on the mass.

See also
WidthGenerator
DecayIntegrator
GenericMassGenerator

Definition at line 51 of file GenericWidthGenerator.h.

Member Function Documentation

◆ accept()

virtual bool Herwig::GenericWidthGenerator::accept ( const ParticleData part) const
inlinevirtual

Return true if this width generator can handle the given particle type.

Parameters
partThe particle data pointer of the particle.
Returns
True if this class can handle the particle and false otherwise

Implements ThePEG::WidthGenerator.

Definition at line 104 of file GenericWidthGenerator.h.

References ThePEG::ParticleData::CC(), and ThePEG::ParticleData::id().

◆ clone()

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

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

Reimplemented in Herwig::SMHiggsWidthGenerator, Herwig::BSMWidthGenerator, and Herwig::BaryonWidthGenerator.

Definition at line 213 of file GenericWidthGenerator.h.

◆ dataBaseOutput()

virtual void Herwig::GenericWidthGenerator::dataBaseOutput ( ofstream &  output,
bool  header = true 
)
virtual

Output the initialisation info for the database.

Parameters
outputThe stream to output the information to
headeroutput the header.

Reimplemented in Herwig::BaryonWidthGenerator.

◆ dofinish()

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

◆ doinit()

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

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

Exceptions
InitExceptionif object could not be initialized properly.

Reimplemented from ThePEG::InterfacedBase.

Reimplemented in Herwig::SMHiggsWidthGenerator, and Herwig::BaryonWidthGenerator.

◆ fullclone()

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

Reimplemented in Herwig::SMHiggsWidthGenerator, Herwig::BSMWidthGenerator, and Herwig::BaryonWidthGenerator.

Definition at line 219 of file GenericWidthGenerator.h.

◆ getReferences()

virtual IVector Herwig::GenericWidthGenerator::getReferences ( )
protectedvirtual

Return a vector of all pointers to Interfaced objects used in this object.

Returns
a vector of pointers.

Reimplemented from ThePEG::InterfacedBase.

◆ initialize()

bool Herwig::GenericWidthGenerator::initialize ( ) const
inlineprotected

Access to the decay modes.

Initialization option for use by the inheriting classes

Definition at line 284 of file GenericWidthGenerator.h.

◆ MEcode()

int Herwig::GenericWidthGenerator::MEcode ( int  imode) const
inlineprotected

Matrix element code for a given mode.

Parameters
imodeThe mode.

Definition at line 263 of file GenericWidthGenerator.h.

◆ MEcoupling()

double Herwig::GenericWidthGenerator::MEcoupling ( int  imode) const
inlineprotected

Coupling for a given mode.

Parameters
imodeThe mode.

Definition at line 269 of file GenericWidthGenerator.h.

◆ partial2BodyWidth() [1/2]

Energy Herwig::GenericWidthGenerator::partial2BodyWidth ( int  iloc,
Energy  q 
) const
inlineprotected

The $1\to2$ width for on-shell particles.

Parameters
qThe mass, or scale, for the calculation
ilocThe location of the mode in the list.
Returns
The partial width.

Definition at line 173 of file GenericWidthGenerator.h.

◆ partial2BodyWidth() [2/2]

virtual Energy Herwig::GenericWidthGenerator::partial2BodyWidth ( int  iloc,
Energy  m0,
Energy  m1,
Energy  m2 
) const
protectedvirtual

The $1\to2$ width for outgoing particles which can be off-shell.

Parameters
ilocThe location of the mode in the list.
m0The mass of the decaying particle.
m1The mass of the first outgoing particle.
m2The mass of the second outgoing particle.
Returns
The partial width.

Reimplemented in Herwig::BSMWidthGenerator, and Herwig::BaryonWidthGenerator.

◆ partialWidth()

virtual Energy Herwig::GenericWidthGenerator::partialWidth ( int  iloc,
Energy  m 
) const
virtual

The partial width for a given mode.

Parameters
mThe mass, or scale, for the calculation
ilocThe location of the mode in the list
Returns
The partial width for the mode.

Reimplemented in Herwig::SMHiggsWidthGenerator.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ rate() [1/2]

virtual DecayMap Herwig::GenericWidthGenerator::rate ( const ParticleData part) const
inlinevirtual

Initialize the given decay map for the given particle type.

Parameters
partThe particle data pointer of the particle.
Returns
The decay map

Implements ThePEG::WidthGenerator.

Reimplemented in Herwig::SMHiggsWidthGenerator.

Definition at line 125 of file GenericWidthGenerator.h.

References ThePEG::ParticleData::decaySelector().

◆ rate() [2/2]

virtual DecayMap Herwig::GenericWidthGenerator::rate ( const Particle part)
virtual

Return a decay map for a given particle instance.

This allows us to vary the branching ratios as a function of the particles mass.

Parameters
partThe particle instance
Returns
The decay map

Reimplemented from ThePEG::WidthGenerator.

Reimplemented in Herwig::SMHiggsWidthGenerator.

◆ rebind()

virtual void Herwig::GenericWidthGenerator::rebind ( const TranslationMap trans)
protectedvirtual

Rebind pointer to other Interfaced objects.

Called in the setup phase after all objects used in an EventGenerator has been cloned so that the pointers will refer to the cloned objects afterwards.

Parameters
transa TranslationMap relating the original objects to their respective clones.
Exceptions
RebindExceptionif no cloned object was found for a given pointer.

Reimplemented from ThePEG::InterfacedBase.

◆ setupMode()

virtual void Herwig::GenericWidthGenerator::setupMode ( tcDMPtr  mode,
tDecayIntegratorPtr  decayer,
unsigned int  imode 
)
protectedvirtual

Perform the set up for a mode in classes inheriting from this one.

Parameters
modeThe decay mode
decayerThe decayer for the mode.
imodeThe number of the mode.

Reimplemented in Herwig::BaryonWidthGenerator, and Herwig::BSMWidthGenerator.

◆ width()

virtual Energy Herwig::GenericWidthGenerator::width ( const ParticleData part,
Energy  m 
) const
virtual

Calculate the width.

Parameters
partThe particle data pointer of the particle.
mThe scale for the width calculation
Returns
The width at the mass given.

Implements ThePEG::WidthGenerator.

Reimplemented in Herwig::SMHiggsWidthGenerator.


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