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

#include <FourBodyDecayConstructor.h>

Inheritance diagram for Herwig::FourBodyDecayConstructor:

[legend]

Public Member Functions
	FourBodyDecayConstructor ()
	The default constructor.

virtual void	DecayList (const set< PDPtr, MassOrdering > &particles)
	Function used to determine allowed decaymodes, to be implemented in derived class.

virtual unsigned int	numBodies () const
	Number of outgoing lines.

void	createDecayMode (vector< NBDiagram > &, bool, double)
	Create a decay mode.

GeneralFourBodyDecayerPtr	createDecayer (vector< NBDiagram > &diagrams, bool inter, double symfac) const
	Create the decayer.

string	DecayerClassName (tcPDPtr incoming, const OrderedParticles &outgoing, string &objname) const
	Contruct the classname and object name for the Decayer.

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

virtual void	DecayList (const set< PDPtr, MassOrdering > &particles)
	Function used to determine allowed decaymodes, to be implemented in derived class.

virtual unsigned int	numBodies () const =0
	Number of outgoing lines.

void	decayConstructor (tDecayConstructorPtr d)
	Set the pointer to the DecayConstrcutor.

bool	removeFlavourChangingVertices () const
	Remove flavour changing vertices ?

bool	removeSmallVertices () const
	Remove small vertices ?

double	minVertexNorm () const
	Minimum norm for vertex removal.

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 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.
unsigned int	interOpt_
	Option for the inclusion of intermediates.

unsigned int	widthOpt_
	How to treat the widths of the intermediate particles.

vector< PDPtr >	particles_
	Particles to override the default list.

bool	particleType_
	Types of particles.

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.

FourBodyDecayConstructor &	operator= (const FourBodyDecayConstructor &)=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 ThePEG::InterfacedBase
enum	InitState

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

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

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::NBodyDecayConstructorBase
virtual void	createDecayMode (vector< NBDiagram > &mode, bool possibleOnShell, double symfac)
	Method to set up the decay mode, should be overidden in inheriting class.

void	setBranchingRatio (tDMPtr dm, Energy pwidth)
	Set the branching ratio of this mode.

void	setDecayerInterfaces (string name) const
	Set the interfaces of the decayers depending on the flags stored.

bool	initialize () const
	Whether to initialize decayers or not.

int	iteration () const
	Number of iterations if initializing (default 1)

int	points () const
	Number of points to do in initialization.

bool	info () const
	Whether to output information on the decayers.

bool	createDecayModes () const
	Whether to create the DecayModes as well as the Decayer objects.

unsigned int	maximumGaugeBosons () const
	Maximum number of electroweak gauge bosons.

unsigned int	maximumList () const
	Maximum number of particles from the list whose decays we are calculating.

double	minimumReleaseFraction () const
	Minimum energy release fraction.

tDecayConstructorPtr	decayConstructor () const
	Get the pointer to the DecayConstructor object.

unsigned int	removeOnShell () const
	Option for on-shell particles.

bool	excluded (VertexBasePtr vertex) const
	Check if a vertex is excluded.

virtual void	doinit ()
	Initialize this object after the setup phase before saving an EventGenerator to disk.

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 FourBodyDecayConstructor class.

See also: The interfaces defined for FourBodyDecayConstructor.

Definition at line 24 of file FourBodyDecayConstructor.h.

Constructor & Destructor Documentation

◆ FourBodyDecayConstructor()

Herwig::FourBodyDecayConstructor::FourBodyDecayConstructor ( )

inline

The default constructor.

Definition at line 31 of file FourBodyDecayConstructor.h.

Member Function Documentation

◆ clone()

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

protectedvirtual

Make a simple clone of this object.

Returns: a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ createDecayer()

GeneralFourBodyDecayerPtr Herwig::FourBodyDecayConstructor::createDecayer	(	vector< NBDiagram > &	diagrams,
		bool	inter,
		double	symfac
	)		const

Create the decayer.

Parameters

diagrams	The diagrams for the decay
inter	Option for intermediates

◆ createDecayMode()

void Herwig::FourBodyDecayConstructor::createDecayMode	(	vector< NBDiagram > &	,
		bool	,
		double
	)

virtual

Create a decay mode.

Reimplemented from Herwig::NBodyDecayConstructorBase.

◆ DecayerClassName()

string Herwig::FourBodyDecayConstructor::DecayerClassName	(	tcPDPtr	incoming,
		const OrderedParticles &	outgoing,
		string &	objname
	)		const

Contruct the classname and object name for the Decayer.

Parameters

incoming	The incoming particle
outgoing	The decay products
objname	a string containing the default path of the Decayer object

◆ DecayList()

virtual void Herwig::FourBodyDecayConstructor::DecayList ( const set< PDPtr, MassOrdering > & particles )

virtual

Function used to determine allowed decaymodes, to be implemented in derived class.

Parameters

particles vector of ParticleData pointers containing particles in model

Reimplemented from Herwig::NBodyDecayConstructorBase.

◆ fullclone()

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

◆ numBodies()

virtual unsigned int Herwig::FourBodyDecayConstructor::numBodies ( ) const

inlinevirtual

Number of outgoing lines.

Required for correct ordering.

Implements Herwig::NBodyDecayConstructorBase.

Definition at line 45 of file FourBodyDecayConstructor.h.

◆ operator=()

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

privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

Member Data Documentation

◆ interOpt_

unsigned int Herwig::FourBodyDecayConstructor::interOpt_

private

Option for the inclusion of intermediates.

Definition at line 125 of file FourBodyDecayConstructor.h.

◆ particles_

vector<PDPtr> Herwig::FourBodyDecayConstructor::particles_

private

Particles to override the default list.

Definition at line 135 of file FourBodyDecayConstructor.h.

◆ particleType_

bool Herwig::FourBodyDecayConstructor::particleType_

private

Types of particles.

Definition at line 140 of file FourBodyDecayConstructor.h.

◆ widthOpt_

unsigned int Herwig::FourBodyDecayConstructor::widthOpt_

private

How to treat the widths of the intermediate particles.

Definition at line 130 of file FourBodyDecayConstructor.h.

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

FourBodyDecayConstructor.h

Public Member Functions

Clone Methods.

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FourBodyDecayConstructor()

Member Function Documentation

◆ clone()

◆ createDecayer()

◆ createDecayMode()

◆ DecayerClassName()

◆ DecayList()

◆ fullclone()

◆ Init()

◆ numBodies()

◆ operator=()

◆ persistentInput()

◆ persistentOutput()

Member Data Documentation

◆ interOpt_

◆ particles_

◆ particleType_

◆ widthOpt_