Herwig 7 is hosted by Hepforge, IPPP Durham
Herwig  7.1.0
Herwig::BaryonWidthGenerator Class Reference

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

#include <BaryonWidthGenerator.h>

Inheritance diagram for Herwig::BaryonWidthGenerator:

Public Member Functions

virtual void dataBaseOutput (ofstream &output, bool header=true)
 Output the initialisation info for the database. 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...
 
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::GenericWidthGenerator
 GenericWidthGenerator ()
 Default constructor.
 
virtual bool accept (const ParticleData &part) const
 Return true if this width generator can handle the given particle type. 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.
 
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 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 ()
 The standard Init function used to initialize the interfaces. More...
 
- Static Public Member Functions inherited from Herwig::GenericWidthGenerator
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

virtual void setupMode (tcDMPtr mode, tDecayIntegratorPtr decayer, unsigned int imode)
 Perform the set up for a mode, this is called by the base class. More...
 
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...
 
- Protected Member Functions inherited from Herwig::GenericWidthGenerator
Energy partial2BodyWidth (int iloc, Energy q) const
 The $1\to2$ width for on-shell particles. 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.
 
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

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

Private Attributes

vector< Baryon1MesonDecayerBasePtr > _baryondecayers
 vector of pointers to the decayers
 
vector< int > _modeloc
 Location of the decay mode in the decayer.
 

Static Private Attributes

static ClassDescription< BaryonWidthGeneratorinitBaryonWidthGenerator
 The static object used to initialize the description of this class. More...
 

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 BaryonWidthGenerator class is designed to automatically calculate the running width for a given particle using information from the decayModes and the Baryon1MesonDecayer to construct the running width.

It inherits from the GenericWidthGenerator.

See also
GenericWidthGenerator
GenericMassGenerator

Definition at line 26 of file BaryonWidthGenerator.h.

Member Function Documentation

◆ clone()

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

Make a simple clone of this object.

Returns
a pointer to the new object.

Reimplemented from Herwig::GenericWidthGenerator.

Definition at line 92 of file BaryonWidthGenerator.h.

◆ dataBaseOutput()

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

◆ doinit()

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

◆ fullclone()

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

Definition at line 98 of file BaryonWidthGenerator.h.

◆ Init()

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

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ partial2BodyWidth()

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

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

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ setupMode()

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

Perform the set up for a mode, this is called by the base class.

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

Reimplemented from Herwig::GenericWidthGenerator.

Member Data Documentation

◆ initBaryonWidthGenerator

ClassDescription<BaryonWidthGenerator> Herwig::BaryonWidthGenerator::initBaryonWidthGenerator
staticprivate

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

Indicates that this is a concrete class with persistent data.

Definition at line 120 of file BaryonWidthGenerator.h.


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