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

#include <VtoFFVDecayer.h>

Inheritance diagram for Herwig::VtoFFVDecayer:

[legend]

Public Member Functions
double	me2 (const int ichan, const Particle &part, const tPDVector &outgoing, const vector< Lorentz5Momentum > &momenta, MEOption meopt) const
	Return the matrix element squared for a given mode and phase-space channel.

virtual void	constructSpinInfo (const Particle &part, ParticleVector outgoing) const
	Construct the SpinInfos for the particles produced in the decay.

virtual WidthCalculatorBasePtr	threeBodyMEIntegrator (const DecayMode &dm) const
	Method to return an object to calculate the 3 (or higher body) partial width.

Public Member Functions inherited from Herwig::GeneralThreeBodyDecayer
	GeneralThreeBodyDecayer ()
	The default constructor.

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.

virtual int	modeNumber (bool &cc, tcPDPtr parent, const tPDVector &children) const
	Which of the possible decays is required.

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.

virtual Energy	partialWidth (PMPair inpart, PMPair outa, PMPair outb, PMPair outc) const
	Function to return partial Width.

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.

bool	setDecayInfo (PDPtr incoming, vector< PDPtr > outgoing, const vector< TBDiagram > &process, double symfac)
	Set the diagrams.

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.

Public Member Functions inherited from Herwig::DecayIntegrator
	DecayIntegrator ()
	The default constructor.

virtual bool	accept (tcPDPtr parent, const tPDVector &children) const
	Check if this decayer can perfom the decay for a particular mode.

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.

virtual int	modeNumber (bool &cc, tcPDPtr parent, const tPDVector &children) const =0
	Which of the possible decays is required.

int	imode () const
	The mode being used for this decay.

void	addMode (PhaseSpaceModePtr mode) const
	Add a phase-space mode to the list.

virtual double	me2 (const int ichan, const Particle &part, const tPDVector &outgoing, const vector< Lorentz5Momentum > &momenta, MEOption meopt) const =0
	Return the matrix element squared for a given mode and phase-space channel.

virtual void	constructSpinInfo (const Particle &part, ParticleVector outgoing) const =0
	Construct the SpinInfos for the particles produced in the decay.

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

void	setPartialWidth (const DecayMode &dm, int imode)
	Set the code for the partial width.

virtual bool	twoBodyMEcode (const DecayMode &, int &mecode, double &coupling) const
	Specify the \(1\to2\) matrix element to be used in the running width calculation.

virtual WidthCalculatorBasePtr	threeBodyMEIntegrator (const DecayMode &dm) const
	Method to return an object to calculate the 3 (or higher body) partial width.

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.

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.

int	findMode (const DecayMode &dm)
	Finds the phase-space mode corresponding to a given decay mode.

ParticleVector	generatePhotons (const Particle &p, ParticleVector children)
	Members for the generation of QED radiation in the decays.

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.

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.

bool	hasRealEmissionME ()
	Whether or not the real emission matrix element is implemented.

bool	warnings () const

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.

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.

virtual ParticleVector	decay (const DecayMode &dm, const Particle &p) const
	Perform a decay for a given DecayMode and a given Particle instance.

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 (PPtr parent, PPtr progenitor, const bool &fs, const Energy &highestpT, const vector< tcPDPtr > &ids, const double &z, const Energy &scale, const Energy &pT)
	Apply the soft matrix element correction.

virtual RealEmissionProcessPtr	generateHardest (RealEmissionProcessPtr)
	Apply the POWHEG style correction.

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.

bool	initialize () const
	Access to the initialize variable.

bool	databaseOutput () const
	Access the database output variable.

Public Member Functions inherited from ThePEG::Decayer
void	persistentOutput (PersistentOStream &os) const

void	persistentInput (PersistentIStream &is, int version)

virtual bool	accept (const DecayMode &dm) const=0

virtual bool	needsFullStep () const

virtual ParticleVector	decay (const DecayMode &dm, const Particle &p) const=0

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 double	brat (const DecayMode &dm, const Particle &p, 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

Ptr< Amplitude >::pointer	amplitude () const

Public Member Functions inherited from ThePEG::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

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

Clone Methods.
vector< pair< AbstractVVSVertexPtr, AbstractFFSVertexPtr > >	sca_
	Store the vertices for scalar intrermediate.

vector< pair< AbstractFFVVertexPtr, AbstractFFVVertexPtr > >	fer_
	Store the vertices for fermion intrermediate.

vector< pair< AbstractVVVVertexPtr, AbstractFFVVertexPtr > >	vec_
	Store the vertices for vector intrermediate.

vector< pair< AbstractVVTVertexPtr, AbstractFFTVertexPtr > >	ten_
	Store the vertices for vector intrermediate.

RhoDMatrix	rho_
	Spinr density matrix.

vector< VectorWaveFunction >	inVector_
	Polarization vectors for the decaying particle.

ScalarWaveFunction	swave_
	Scalar wavefunction for the decay products.

vector< VectorWaveFunction >	outVector_
	Polarization vectors for the decay products.

pair< vector< SpinorWaveFunction >, vector< SpinorBarWaveFunction > >	outspin_ [3]
	Spinors for the decay products.

virtual IBPtr	clone () const
	Make a simple clone of this object.

virtual IBPtr	fullclone () const
	Make a clone of this object, possibly modifying the cloned object to make it sane.

virtual void	setupDiagrams (bool checkKinematics)
	Set up the diagrams etc.

VtoFFVDecayer &	operator= (const VtoFFVDecayer &)=delete
	The assignment operator is private and must never be called.

Functions used by the persistent I/O system.
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 ()
	The standard Init function used to initialize the interfaces.

Additional Inherited Members
Public Types inherited from Herwig::GeneralThreeBodyDecayer
typedef pair< tcPDPtr, Energy >	PMPair
	A ParticleData ptr and (possible) mass pair.

Public Types inherited from Herwig::DecayIntegrator
enum	MEOption { Initialize , Calculate , Terminate }
	Enum for the matrix element option. More...

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

Static Public Member Functions inherited from Herwig::GeneralThreeBodyDecayer
static void	Init ()
	The standard Init function used to initialize the interfaces.

Static Public Member Functions inherited from Herwig::DecayIntegrator
static void	Init ()
	The 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.

Static Public Member Functions inherited from ThePEG::Decayer
static void	Init ()

static ParticleVector	DecayParticle (tPPtr parent, Step &step, long maxtry=1000)

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

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 Herwig::GeneralThreeBodyDecayer
virtual void	doinit ()
	Initialize this object after the setup phase before saving an EventGenerator to disk.

virtual void	doinitrun ()
	Initialize this object.

const vector< TBDiagram > &	getProcessInfo () const
	Access the TBDiagrams that store the required information to create the diagrams.

PDPtr	incoming () const
	Incoming particle.

const vector< tPDPtr > &	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.

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.

void	colourFlow (unsigned int flow) const
	Set the colour flow.

unsigned int const &	colourFlow () const
	Set the colour flow.

double	relativeError () const
	Relative error for GQ integration.

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.

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.

DecayMEPtr	ME () const
	The helicity amplitude matrix element for spin correlations.

void	resetIntermediate (tcPDPtr part, Energy mass, Energy width)
	Reset the properities of all intermediates.

Energy	initializePhaseSpaceMode (unsigned int imode, bool init, bool onShell=false) const
	Initialize the phase-space mode.

void	generateIntermediates (bool in)
	Methods to set variables in inheriting classes.

bool	generateIntermediates () const
	Set whether or not the intermediates are included.

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.

void	epsilonPS (Energy in)
	Set the epsilon parameter.

void	clearModes ()
	Clear the models.

unsigned int	numberModes () const
	Number of decay modes.

tPhaseSpaceModePtr	mode (unsigned int ix)
	Pointer to a mode.

tcPhaseSpaceModePtr	mode (unsigned int ix) const
	Pointer to a mode.

Protected Member Functions inherited from Herwig::HwDecayerBase
virtual void	dofinish ()
	Finalize this object.

void	fixRho (RhoDMatrix &) const
	Set rho to be diagonal if no correlations.

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

Here is the documentation of the VtoFFVDecayer class.

See also: The interfaces defined for VtoFFVDecayer.

Definition at line 25 of file VtoFFVDecayer.h.

Member Function Documentation

◆ clone()

virtual IBPtr Herwig::VtoFFVDecayer::clone ( ) const

protectedvirtual

Make a simple clone of this object.

Returns: a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ constructSpinInfo()

virtual void Herwig::VtoFFVDecayer::constructSpinInfo	(	const Particle &	part,
		ParticleVector	outgoing
	)		const

virtual

Construct the SpinInfos for the particles produced in the decay.

Implements Herwig::DecayIntegrator.

◆ fullclone()

virtual IBPtr Herwig::VtoFFVDecayer::fullclone ( ) const

protectedvirtual

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.

◆ Init()

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

◆ me2()

double Herwig::VtoFFVDecayer::me2	(	const int	ichan,
		const Particle &	part,
		const tPDVector &	outgoing,
		const vector< Lorentz5Momentum > &	momenta,
		MEOption	meopt
	)		const

virtual

Return the matrix element squared for a given mode and phase-space channel.

Parameters

ichan	The channel we are calculating the matrix element for.
part	The decaying Particle.
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 matrix element squared for the phase-space configuration.

Implements Herwig::DecayIntegrator.

◆ operator=()

VtoFFVDecayer & Herwig::VtoFFVDecayer::operator= ( const VtoFFVDecayer & )

privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

◆ setupDiagrams()

virtual void Herwig::VtoFFVDecayer::setupDiagrams ( bool checkKinematics )

protectedvirtual

Set up the diagrams etc.

Reimplemented from Herwig::GeneralThreeBodyDecayer.

◆ threeBodyMEIntegrator()

virtual WidthCalculatorBasePtr Herwig::VtoFFVDecayer::threeBodyMEIntegrator ( const DecayMode & dm ) const

virtual

Method to return an object to calculate the 3 (or higher body) partial width.

Parameters

dm	The DecayMode

Returns: A pointer to a WidthCalculatorBase object capable of calculating the width

Reimplemented from Herwig::DecayIntegrator.

Member Data Documentation

◆ fer_

vector<pair<AbstractFFVVertexPtr, AbstractFFVVertexPtr> > Herwig::VtoFFVDecayer::fer_

private

Store the vertices for fermion intrermediate.

Definition at line 125 of file VtoFFVDecayer.h.

◆ inVector_

vector<VectorWaveFunction> Herwig::VtoFFVDecayer::inVector_

mutableprivate

Polarization vectors for the decaying particle.

Definition at line 145 of file VtoFFVDecayer.h.

◆ outspin_

pair<vector<SpinorWaveFunction>,vector<SpinorBarWaveFunction> > Herwig::VtoFFVDecayer::outspin_[3]

mutableprivate

Spinors for the decay products.

Definition at line 160 of file VtoFFVDecayer.h.

◆ outVector_

vector<VectorWaveFunction> Herwig::VtoFFVDecayer::outVector_

mutableprivate

Polarization vectors for the decay products.

Definition at line 155 of file VtoFFVDecayer.h.

◆ rho_

RhoDMatrix Herwig::VtoFFVDecayer::rho_

mutableprivate

Spinr density matrix.

Definition at line 140 of file VtoFFVDecayer.h.

◆ sca_

vector<pair<AbstractVVSVertexPtr, AbstractFFSVertexPtr> > Herwig::VtoFFVDecayer::sca_

private

Store the vertices for scalar intrermediate.

Definition at line 120 of file VtoFFVDecayer.h.

◆ swave_

ScalarWaveFunction Herwig::VtoFFVDecayer::swave_

mutableprivate

Scalar wavefunction for the decay products.

Definition at line 150 of file VtoFFVDecayer.h.

◆ ten_

vector<pair<AbstractVVTVertexPtr, AbstractFFTVertexPtr> > Herwig::VtoFFVDecayer::ten_

private

Store the vertices for vector intrermediate.

Definition at line 135 of file VtoFFVDecayer.h.

◆ vec_

vector<pair<AbstractVVVVertexPtr, AbstractFFVVertexPtr> > Herwig::VtoFFVDecayer::vec_

private

Store the vertices for vector intrermediate.

Definition at line 130 of file VtoFFVDecayer.h.

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

VtoFFVDecayer.h

Public Member Functions

Clone Methods.

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ constructSpinInfo()

◆ fullclone()

◆ Init()

◆ me2()

◆ operator=()

◆ persistentInput()

◆ persistentOutput()

◆ setupDiagrams()

◆ threeBodyMEIntegrator()

Member Data Documentation

◆ fer_

◆ inVector_

◆ outspin_

◆ outVector_

◆ rho_

◆ sca_

◆ swave_

◆ ten_

◆ vec_