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

#include <WeakCurrent.h>

Inheritance diagram for Herwig::WeakCurrent:

[legend]

Public Member Functions
	WeakCurrent ()
	Default constructor.

Methods for the construction of the phase space integrator.
virtual bool	createMode (int icharge, tcPDPtr resonance, FlavourInfo flavour, unsigned int imode, PhaseSpaceModePtr mode, unsigned int iloc, int ires, PhaseSpaceChannel phase, Energy upp)=0
	Complete the construction of the decay mode for integration.classes inheriting from this one.

virtual tPDVector	particles (int icharge, unsigned int imode, int iq, int ia)=0
	The particles produced by the current.

unsigned int	numberOfModes () const
	Return the number of modes handled by this current.

virtual vector< LorentzPolarizationVectorE >	current (tcPDPtr resonance, FlavourInfo flavour, const int imode, const int ichan, Energy &scale, const tPDVector &outgoing, const vector< Lorentz5Momentum > &momenta, DecayIntegrator::MEOption meopt) const =0
	Hadronic current.

virtual void	constructSpinInfo (ParticleVector decay) const
	Construct the SpinInfo for the decay products.

virtual bool	accept (vector< int > id)=0
	Accept the decay.

virtual unsigned int	decayMode (vector< int > id)=0
	Return the decay mode number for a given set of particles in the current.

void	decayModeInfo (unsigned int imode, int &iq, int &ia) const
	Information on a decay mode.

virtual void	dataBaseOutput (ofstream &os, bool header, bool create) const
	Output the setup information for the particle database.

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

Public Member Functions inherited from ThePEG::InterfacedBase
string	fullName () const

string	name () const

string	path () const

string	comment () const

void	setup (istream &is)

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

virtual IBPtr	fullclone () const

void	persistentOutput (PersistentOStream &os) const

void	persistentInput (PersistentIStream &is, int version)

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

virtual IBPtr	fullclone () const

Public Member Functions inherited from ThePEG::Base
void	debug () const

virtual void	debugme () 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

Functions used by the persistent I/O system.
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.

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

static void	Init ()
	Standard Init function used to initialize the interfaces.

void	addDecayMode (int iq, int ia)
	Add a decay mode to the list.

void	setInitialModes (unsigned int nmodes)
	Set initial number of modes.

WeakCurrent &	operator= (const WeakCurrent &)=delete
	Private and non-existent assignment operator.

Additional Inherited Members
Public Types inherited from ThePEG::InterfacedBase
enum	InitState

Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int	CounterType

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 ()

Public Attributes inherited from ThePEG::InterfacedBase
	initializing

	uninitialized

	initialized

	runready

Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long	uniqueId

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 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 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 &)

Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
	ReferenceCounted (const ReferenceCounted &)

ReferenceCounted &	operator= (const ReferenceCounted &)

Protected Member Functions inherited from ThePEG::Named
const Named &	operator= (const Named &other)

const string &	name (const string &newName)

Static Protected Member Functions inherited from ThePEG::Interfaced
static void	registerRepository (IBPtr)

static void	registerRepository (IBPtr, string newName)

Detailed Description

The WeakCurrent 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 PhaseSpaceChannel 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 PhaseSpaceMode. This method will then construct the PhaseSpaceMode 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 WeakCurrent can be reconstructed by the Herwig particle properties database.

See also: Interfaced.

Definition at line 59 of file WeakCurrent.h.

Constructor & Destructor Documentation

◆ WeakCurrent()

Herwig::WeakCurrent::WeakCurrent ( )

inline

Default constructor.

Definition at line 66 of file WeakCurrent.h.

Member Function Documentation

◆ accept()

virtual bool Herwig::WeakCurrent::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

id	The id's of the particles in the current.

Returns: Can this current have the external particles specified.

Implemented in Herwig::EtaOmegaCurrent, Herwig::EtaPhiCurrent, Herwig::EtaPhotonCurrent, Herwig::EtaPiPiCurrent, Herwig::EtaPiPiDefaultCurrent, Herwig::EtaPrimePiPiCurrent, Herwig::FivePionCurrent, Herwig::FourPionCzyzCurrent, Herwig::FourPionNovosibirskCurrent, Herwig::KKPiCurrent, Herwig::KPiCurrent, Herwig::KPiKStarCurrent, Herwig::LeptonNeutrinoCurrent, Herwig::OmegaPionSNDCurrent, Herwig::OmegaPiPiCurrent, Herwig::OneKaonTwoPionCurrent, Herwig::OneKaonTwoPionDefaultCurrent, Herwig::PhiPiCurrent, Herwig::PionPhotonCurrent, Herwig::ScalarMesonCurrent, Herwig::ThreePionCLEOCurrent, Herwig::ThreePionCzyzCurrent, Herwig::ThreePionDefaultCurrent, Herwig::TwoKaonCzyzCurrent, Herwig::TwoKaonOnePionCurrent, Herwig::TwoKaonOnePionDefaultCurrent, Herwig::TwoPionCzyzCurrent, Herwig::TwoPionPhotonCurrent, Herwig::TwoPionPhotonSNDCurrent, Herwig::TwoPionRhoCurrent, Herwig::VectorMesonCurrent, and Herwig::WeakBaryonCurrent.

◆ addDecayMode()

void Herwig::WeakCurrent::addDecayMode	(	int	iq,
		int	ia
	)

inlineprotected

Add a decay mode to the list.

Parameters

iq	The PDG code for the quark.
ia	The PDG code for the antiquark.

Definition at line 211 of file WeakCurrent.h.

References antiquark_, and quark_.

Referenced by Herwig::LeptonNeutrinoCurrent::LeptonNeutrinoCurrent().

◆ constructSpinInfo()

virtual void Herwig::WeakCurrent::constructSpinInfo ( ParticleVector decay ) const

virtual

Construct the SpinInfo for the decay products.

Reimplemented in Herwig::EtaOmegaCurrent, Herwig::EtaPhiCurrent, Herwig::EtaPhotonCurrent, Herwig::LeptonNeutrinoCurrent, Herwig::OmegaPionSNDCurrent, Herwig::OmegaPiPiCurrent, Herwig::PhiPiCurrent, Herwig::PionPhotonCurrent, Herwig::TwoPionPhotonCurrent, Herwig::TwoPionPhotonSNDCurrent, Herwig::VectorMesonCurrent, and Herwig::WeakBaryonCurrent.

◆ createMode()

virtual bool Herwig::WeakCurrent::createMode	(	int	icharge,
		tcPDPtr	resonance,
		FlavourInfo	flavour,
		unsigned int	imode,
		PhaseSpaceModePtr	mode,
		unsigned int	iloc,
		int	ires,
		PhaseSpaceChannel	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 WeakCurrent.

Parameters

icharge	The total charge of the outgoing particles in the current.
resonance	If specified only include terms with this particle
flavour	Information on the required flavours of the quarks
imode	The mode in the current being asked for.
mode	The phase space mode for the integration
iloc	The location of the of the first particle from the current in the list of outgoing particles.
ires	The location of the first intermediate for the current.
phase	The prototype phase space channel for the integration.
upp	The maximum possible mass the particles in the current are allowed to have.

Returns: Whether the current was sucessfully constructed.

Implemented in Herwig::EtaOmegaCurrent, Herwig::EtaPhiCurrent, Herwig::EtaPhotonCurrent, Herwig::EtaPiPiCurrent, Herwig::EtaPiPiDefaultCurrent, Herwig::EtaPrimePiPiCurrent, Herwig::FivePionCurrent, Herwig::FourPionCzyzCurrent, Herwig::FourPionNovosibirskCurrent, Herwig::KKPiCurrent, Herwig::KPiCurrent, Herwig::KPiKStarCurrent, Herwig::LeptonNeutrinoCurrent, Herwig::OmegaPionSNDCurrent, Herwig::OmegaPiPiCurrent, Herwig::OneKaonTwoPionCurrent, Herwig::OneKaonTwoPionDefaultCurrent, Herwig::PhiPiCurrent, Herwig::PionPhotonCurrent, Herwig::ScalarMesonCurrent, Herwig::ThreePionCLEOCurrent, Herwig::ThreePionCzyzCurrent, Herwig::ThreePionDefaultCurrent, Herwig::TwoKaonCzyzCurrent, Herwig::TwoKaonOnePionCurrent, Herwig::TwoKaonOnePionDefaultCurrent, Herwig::TwoPionCzyzCurrent, Herwig::TwoPionPhotonCurrent, Herwig::TwoPionPhotonSNDCurrent, Herwig::TwoPionRhoCurrent, Herwig::VectorMesonCurrent, and Herwig::WeakBaryonCurrent.

◆ current()

virtual vector< LorentzPolarizationVectorE > Herwig::WeakCurrent::current	(	tcPDPtr	resonance,
		FlavourInfo	flavour,
		const int	imode,
		const int	ichan,
		Energy &	scale,
		const tPDVector &	outgoing,
		const vector< Lorentz5Momentum > &	momenta,
		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

resonance	If specified only include terms with this particle
flavour	Information on the required flavours of the quarks
imode	The mode
ichan	The phase-space channel the current is needed for.
scale	The invariant mass of the particles in the current.
outgoing	The particles produced in the decay
momenta	The momenta of the particles produced in the decay
meopt	Option for the calculation of the matrix element

Returns: The current.

Implemented in Herwig::EtaOmegaCurrent, Herwig::EtaPhiCurrent, Herwig::EtaPhotonCurrent, Herwig::EtaPiPiCurrent, Herwig::EtaPiPiDefaultCurrent, Herwig::EtaPrimePiPiCurrent, Herwig::FivePionCurrent, Herwig::FourPionCzyzCurrent, Herwig::FourPionNovosibirskCurrent, Herwig::KKPiCurrent, Herwig::KPiCurrent, Herwig::KPiKStarCurrent, Herwig::LeptonNeutrinoCurrent, Herwig::OmegaPionSNDCurrent, Herwig::OmegaPiPiCurrent, Herwig::OneKaonTwoPionCurrent, Herwig::OneKaonTwoPionDefaultCurrent, Herwig::PhiPiCurrent, Herwig::PionPhotonCurrent, Herwig::ScalarMesonCurrent, Herwig::ThreePionCLEOCurrent, Herwig::ThreePionCzyzCurrent, Herwig::ThreePionDefaultCurrent, Herwig::TwoKaonCzyzCurrent, Herwig::TwoKaonOnePionCurrent, Herwig::TwoKaonOnePionDefaultCurrent, Herwig::TwoPionCzyzCurrent, Herwig::TwoPionPhotonCurrent, Herwig::TwoPionPhotonSNDCurrent, Herwig::TwoPionRhoCurrent, Herwig::VectorMesonCurrent, and Herwig::WeakBaryonCurrent.

◆ dataBaseOutput()

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

virtual

Output the setup information for the particle database.

Parameters

os	The stream to output the information to
header	Whether or not to output the information for MySQL
create	Whether or not to add a statement creating the object

Reimplemented in Herwig::EtaOmegaCurrent, Herwig::EtaPhiCurrent, Herwig::EtaPhotonCurrent, Herwig::EtaPiPiCurrent, Herwig::EtaPiPiDefaultCurrent, Herwig::EtaPrimePiPiCurrent, Herwig::FivePionCurrent, Herwig::FourPionCzyzCurrent, Herwig::FourPionNovosibirskCurrent, Herwig::KKPiCurrent, Herwig::KPiCurrent, Herwig::KPiKStarCurrent, Herwig::LeptonNeutrinoCurrent, Herwig::OmegaPionSNDCurrent, Herwig::OmegaPiPiCurrent, Herwig::OneKaonTwoPionCurrent, Herwig::OneKaonTwoPionDefaultCurrent, Herwig::PhiPiCurrent, Herwig::PionPhotonCurrent, Herwig::ScalarMesonCurrent, Herwig::ThreePionCLEOCurrent, Herwig::ThreePionCzyzCurrent, Herwig::ThreePionDefaultCurrent, Herwig::TwoKaonCzyzCurrent, Herwig::TwoKaonOnePionCurrent, Herwig::TwoKaonOnePionDefaultCurrent, Herwig::TwoPionCzyzCurrent, Herwig::TwoPionPhotonCurrent, Herwig::TwoPionPhotonSNDCurrent, Herwig::TwoPionRhoCurrent, Herwig::VectorMesonCurrent, and Herwig::WeakBaryonCurrent.

◆ decayMode()

virtual unsigned int Herwig::WeakCurrent::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

id	The id's of the particles in the current.

Returns: The number of the mode

Implemented in Herwig::EtaOmegaCurrent, Herwig::EtaPhiCurrent, Herwig::EtaPhotonCurrent, Herwig::EtaPiPiCurrent, Herwig::EtaPiPiDefaultCurrent, Herwig::EtaPrimePiPiCurrent, Herwig::FivePionCurrent, Herwig::FourPionCzyzCurrent, Herwig::FourPionNovosibirskCurrent, Herwig::KKPiCurrent, Herwig::KPiCurrent, Herwig::KPiKStarCurrent, Herwig::LeptonNeutrinoCurrent, Herwig::OmegaPionSNDCurrent, Herwig::OmegaPiPiCurrent, Herwig::OneKaonTwoPionCurrent, Herwig::OneKaonTwoPionDefaultCurrent, Herwig::PhiPiCurrent, Herwig::PionPhotonCurrent, Herwig::ScalarMesonCurrent, Herwig::ThreePionCLEOCurrent, Herwig::ThreePionCzyzCurrent, Herwig::ThreePionDefaultCurrent, Herwig::TwoKaonCzyzCurrent, Herwig::TwoKaonOnePionCurrent, Herwig::TwoKaonOnePionDefaultCurrent, Herwig::TwoPionCzyzCurrent, Herwig::TwoPionPhotonCurrent, Herwig::TwoPionPhotonSNDCurrent, Herwig::TwoPionRhoCurrent, Herwig::VectorMesonCurrent, and Herwig::WeakBaryonCurrent.

◆ decayModeInfo()

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

inline

Information on a decay mode.

Parameters

imode	The mode
iq	The PDG code of the quark.
ia	The PDG code of the antiquark.

Definition at line 162 of file WeakCurrent.h.

References antiquark_, and quark_.

◆ numberOfModes()

unsigned int Herwig::WeakCurrent::numberOfModes ( ) const

inline

Return the number of modes handled by this current.

Definition at line 111 of file WeakCurrent.h.

References quark_.

◆ particles()

virtual tPDVector Herwig::WeakCurrent::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

icharge	The total charge of the particles in the current.
imode	The mode for which the particles are being requested
iq	The PDG code for the quark
ia	The PDG code for the antiquark

Returns: The external particles for the current.

Implemented in Herwig::EtaOmegaCurrent, Herwig::EtaPhiCurrent, Herwig::EtaPhotonCurrent, Herwig::EtaPiPiCurrent, Herwig::EtaPiPiDefaultCurrent, Herwig::EtaPrimePiPiCurrent, Herwig::FivePionCurrent, Herwig::FourPionCzyzCurrent, Herwig::FourPionNovosibirskCurrent, Herwig::KKPiCurrent, Herwig::KPiCurrent, Herwig::KPiKStarCurrent, Herwig::LeptonNeutrinoCurrent, Herwig::OmegaPionSNDCurrent, Herwig::OmegaPiPiCurrent, Herwig::OneKaonTwoPionCurrent, Herwig::OneKaonTwoPionDefaultCurrent, Herwig::PhiPiCurrent, Herwig::PionPhotonCurrent, Herwig::ScalarMesonCurrent, Herwig::ThreePionCLEOCurrent, Herwig::ThreePionCzyzCurrent, Herwig::ThreePionDefaultCurrent, Herwig::TwoKaonCzyzCurrent, Herwig::TwoKaonOnePionCurrent, Herwig::TwoKaonOnePionDefaultCurrent, Herwig::TwoPionCzyzCurrent, Herwig::TwoPionPhotonCurrent, Herwig::TwoPionPhotonSNDCurrent, Herwig::TwoPionRhoCurrent, Herwig::VectorMesonCurrent, and Herwig::WeakBaryonCurrent.

◆ persistentInput()

void Herwig::WeakCurrent::persistentInput	(	PersistentIStream &	is,
		int	version
	)

Function used to read in object persistently.

Parameters

is	the persistent input stream read from.
version	the version number of the object when written.

◆ persistentOutput()

void Herwig::WeakCurrent::persistentOutput ( PersistentOStream & os ) const

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

◆ setInitialModes()

void Herwig::WeakCurrent::setInitialModes ( unsigned int nmodes )

inlineprotected

Set initial number of modes.

Parameters

nmodes The number of modes.

Definition at line 220 of file WeakCurrent.h.

References numberModes_.

Referenced by Herwig::LeptonNeutrinoCurrent::LeptonNeutrinoCurrent().

Member Data Documentation

◆ antiquark_

vector<int> Herwig::WeakCurrent::antiquark_

private

The PDG codes for the antiquarks contained in the current.

Definition at line 239 of file WeakCurrent.h.

Referenced by addDecayMode(), and decayModeInfo().

◆ numberModes_

unsigned int Herwig::WeakCurrent::numberModes_

private

The initial number of modes.

Definition at line 244 of file WeakCurrent.h.

Referenced by setInitialModes().

◆ quark_

vector<int> Herwig::WeakCurrent::quark_

private

The PDG codes for the quarks contained in the current.

Definition at line 234 of file WeakCurrent.h.

Referenced by addDecayMode(), decayModeInfo(), and numberOfModes().

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

WeakCurrent.h

Public Member Functions

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WeakCurrent()

Member Function Documentation

◆ accept()

◆ addDecayMode()

◆ constructSpinInfo()

◆ createMode()

◆ current()

◆ dataBaseOutput()

◆ decayMode()

◆ decayModeInfo()

◆ numberOfModes()

◆ particles()

◆ persistentInput()

◆ persistentOutput()

◆ setInitialModes()

Member Data Documentation

◆ antiquark_

◆ numberModes_

◆ quark_