herwig is hosted by Hepforge, IPPP Durham
Herwig  7.1.4
Herwig::WeakDecayCurrent Class Referenceabstract

The WeakDecayCurrent class is the base class for the hadronic currents produced in weak decays. More...

#include <WeakDecayCurrent.h>

Inheritance diagram for Herwig::WeakDecayCurrent:

Public Member Functions

 WeakDecayCurrent ()
 Default constructor.
 
unsigned int numberOfModes () const
 Return the number of modes handled by this current.
 
virtual vector< LorentzPolarizationVectorEcurrent (const int imode, const int ichan, Energy &scale, const ParticleVector &decay, DecayIntegrator::MEOption meopt) const =0
 Hadronic current. More...
 
virtual bool accept (vector< int > id)=0
 Accept the decay. More...
 
virtual unsigned int decayMode (vector< int > id)=0
 Return the decay mode number for a given set of particles in the current. More...
 
void decayModeInfo (unsigned int imode, int &iq, int &ia) const
 Information on a decay mode. More...
 
virtual void dataBaseOutput (ofstream &os, bool header, bool create) const
 Output the setup information for the particle database. More...
 
Methods for the construction of the phase space integrator.
virtual bool createMode (int icharge, unsigned int imode, DecayPhaseSpaceModePtr mode, unsigned int iloc, unsigned int ires, DecayPhaseSpaceChannelPtr phase, Energy upp)=0
 Complete the construction of the decay mode for integration.classes inheriting from this one. More...
 
virtual tPDVector particles (int icharge, unsigned int imode, int iq, int ia)=0
 The particles produced by the current. 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 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 ()
 Standard Init function used to initialize the interfaces.
 
- 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

void addDecayMode (int iq, int ia)
 Add a decay mode to the list. More...
 
void setInitialModes (unsigned int nmodes)
 Set initial number of modes. 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 void dofinish ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinit ()
 
virtual void doinitrun ()
 
virtual void dofinish ()
 
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

WeakDecayCurrentoperator= (const WeakDecayCurrent &)
 Private and non-existent assignment operator.
 

Private Attributes

vector< int > _quark
 The PDG codes for the quarks contained in the current.
 
vector< int > _antiquark
 The PDG codes for the antiquarks contained in the current.
 
unsigned int _numbermodes
 The initial number of modes.
 

Static Private Attributes

static AbstractClassDescription< WeakDecayCurrentinitWeakDecayCurrent
 Describe an abstract base class with persistent data.
 

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 WeakDecayCurrent class is the base class for the hadronic currents produced in weak decays.

This is designed so it can be used in any weak decay. In general the currents which are implemented are either simple one meson production or taken from tau decay.

In classes inheriting from this one a number of member functions must be implemented

  • createMode which takes a vector of partially completed DecayPhaseSpaceChannel and adds the extra information required for the current. This method should assume that the particles from the current are the last ones specified in the DecayPhaseSpaceMode. This method will then construct the DecayPhaseSpaceMode for the decay.
  • particles() which returns the external particles produced by the current.
  • current() which given the decay products calculates the decay current
  • accept() which uses the PDG codes for the particles in the current to decide if a given mode is allowed.
  • decayMode() which uses the PDG codes for the particles in the current to workout which modes is being performed.
  • dataBaseOutput() which should output the information on all the Interfaces so that the WeakDecayCurrent can be reconstructed by the Herwig particle properties database.
See also
Interfaced.

Definition at line 57 of file WeakDecayCurrent.h.

Member Function Documentation

◆ accept()

virtual bool Herwig::WeakDecayCurrent::accept ( vector< int >  id)
pure virtual

Accept the decay.

This method is purely virtual and must be implemented in any class inheriting from this one.

Parameters
idThe id's of the particles in the current.
Returns
Can this current have the external particles specified.

Implemented in Herwig::TwoPionPhotonCurrent, Herwig::FourPionNovosibirskCurrent, Herwig::ScalarMesonCurrent, Herwig::VectorMesonCurrent, Herwig::TwoMesonRhoKStarCurrent, Herwig::LeptonNeutrinoCurrent, Herwig::ThreeMesonCurrentBase, Herwig::KPiCurrent, and Herwig::FivePionCurrent.

◆ addDecayMode()

void Herwig::WeakDecayCurrent::addDecayMode ( int  iq,
int  ia 
)
inlineprotected

Add a decay mode to the list.

Parameters
iqThe PDG code for the quark.
iaThe PDG code for the antiquark.

Definition at line 193 of file WeakDecayCurrent.h.

◆ createMode()

virtual bool Herwig::WeakDecayCurrent::createMode ( int  icharge,
unsigned int  imode,
DecayPhaseSpaceModePtr  mode,
unsigned int  iloc,
unsigned int  ires,
DecayPhaseSpaceChannelPtr  phase,
Energy  upp 
)
pure virtual

Complete the construction of the decay mode for integration.classes inheriting from this one.

This method is purely virtual and must be implemented in the classes inheriting from WeakDecayCurrent.

Parameters
ichargeThe total charge of the outgoing particles in the current.
imodeThe mode in the current being asked for.
modeThe phase space mode for the integration
ilocThe location of the of the first particle from the current in the list of outgoing particles.
iresThe location of the first intermediate for the current.
phaseThe prototype phase space channel for the integration.
uppThe maximum possible mass the particles in the current are allowed to have.
Returns
Whether the current was sucessfully constructed.

Implemented in Herwig::ThreePionCLEOCurrent, Herwig::TwoPionPhotonCurrent, Herwig::ThreeMesonDefaultCurrent, Herwig::FourPionNovosibirskCurrent, Herwig::ScalarMesonCurrent, Herwig::VectorMesonCurrent, Herwig::TwoMesonRhoKStarCurrent, Herwig::LeptonNeutrinoCurrent, Herwig::KaonThreeMesonCurrent, Herwig::KPiCurrent, and Herwig::FivePionCurrent.

◆ current()

virtual vector<LorentzPolarizationVectorE> Herwig::WeakDecayCurrent::current ( const int  imode,
const int  ichan,
Energy &  scale,
const ParticleVector decay,
DecayIntegrator::MEOption  meopt 
) const
pure virtual

Hadronic current.

This method is purely virtual and must be implemented in all classes inheriting from this one.

Parameters
imodeThe mode
ichanThe phase-space channel the current is needed for.
scaleThe invariant mass of the particles in the current.
decayThe decay products
meoptOption for the calculation of the matrix element
Returns
The current.

Implemented in Herwig::TwoPionPhotonCurrent, Herwig::FourPionNovosibirskCurrent, Herwig::ScalarMesonCurrent, Herwig::VectorMesonCurrent, Herwig::TwoMesonRhoKStarCurrent, Herwig::LeptonNeutrinoCurrent, Herwig::ThreeMesonCurrentBase, Herwig::KPiCurrent, and Herwig::FivePionCurrent.

◆ dataBaseOutput()

virtual void Herwig::WeakDecayCurrent::dataBaseOutput ( ofstream &  os,
bool  header,
bool  create 
) 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
createWhether or not to add a statement creating the object

Reimplemented in Herwig::ThreePionCLEOCurrent, Herwig::TwoPionPhotonCurrent, Herwig::FourPionNovosibirskCurrent, Herwig::ScalarMesonCurrent, Herwig::VectorMesonCurrent, Herwig::TwoMesonRhoKStarCurrent, Herwig::ThreeMesonCurrentBase, Herwig::LeptonNeutrinoCurrent, Herwig::ThreeMesonDefaultCurrent, Herwig::KPiCurrent, Herwig::FivePionCurrent, and Herwig::KaonThreeMesonCurrent.

◆ decayMode()

virtual unsigned int Herwig::WeakDecayCurrent::decayMode ( vector< int >  id)
pure virtual

Return the decay mode number for a given set of particles in the current.

This method is purely virtual and must be implemented in any class inheriting from this one.

Parameters
idThe id's of the particles in the current.
Returns
The number of the mode

Implemented in Herwig::TwoPionPhotonCurrent, Herwig::FourPionNovosibirskCurrent, Herwig::ScalarMesonCurrent, Herwig::VectorMesonCurrent, Herwig::TwoMesonRhoKStarCurrent, Herwig::LeptonNeutrinoCurrent, Herwig::ThreeMesonCurrentBase, Herwig::KPiCurrent, and Herwig::FivePionCurrent.

◆ decayModeInfo()

void Herwig::WeakDecayCurrent::decayModeInfo ( unsigned int  imode,
int &  iq,
int &  ia 
) const
inline

Information on a decay mode.

Parameters
imodeThe mode
iqThe PDG code of the quark.
iaThe PDG code of the antiquark.

Definition at line 144 of file WeakDecayCurrent.h.

◆ particles()

virtual tPDVector Herwig::WeakDecayCurrent::particles ( int  icharge,
unsigned int  imode,
int  iq,
int  ia 
)
pure virtual

The particles produced by the current.

This method is purely virtual and must be implemented in classes inheriting from this one.

Parameters
ichargeThe total charge of the particles in the current.
imodeThe mode for which the particles are being requested
iqThe PDG code for the quark
iaThe PDG code for the antiquark
Returns
The external particles for the current.

Implemented in Herwig::TwoPionPhotonCurrent, Herwig::ThreeMesonCurrentBase, Herwig::FourPionNovosibirskCurrent, Herwig::ScalarMesonCurrent, Herwig::VectorMesonCurrent, Herwig::TwoMesonRhoKStarCurrent, Herwig::LeptonNeutrinoCurrent, Herwig::KPiCurrent, and Herwig::FivePionCurrent.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ setInitialModes()

void Herwig::WeakDecayCurrent::setInitialModes ( unsigned int  nmodes)
inlineprotected

Set initial number of modes.

Parameters
nmodesThe number of modes.

Definition at line 202 of file WeakDecayCurrent.h.


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