herwig is hosted by Hepforge, IPPP Durham
Herwig  7.1.5
Herwig::NBodyDecayConstructorBase Class Referenceabstract

This is the base class for NBodyDecayConstructors. More...

#include <NBodyDecayConstructorBase.h>

Inheritance diagram for Herwig::NBodyDecayConstructorBase:

Public Member Functions

 NBodyDecayConstructorBase ()
 The default constructor.
 
virtual void DecayList (const set< PDPtr > &particles)
 Function used to determine allowed decaymodes, to be implemented in derived class. More...
 
virtual unsigned int numBodies () const =0
 Number of outgoing lines. More...
 
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.
 
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 ()
 The standard Init function used to initialize the interfaces. More...
 
- 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 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. More...
 
void setDecayerInterfaces (string name) const
 Set the interfaces of the decayers depending on the flags stored. More...
 
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.
 
Standard Interfaced functions.
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk. 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 doinitrun ()
 
virtual void dofinish ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
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

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

Private Attributes

bool init_
 Whether to initialize decayers or not.
 
int iteration_
 Number of iterations if initializing (default 1)
 
int points_
 Number of points to do in initialization.
 
bool info_
 Whether to output information on the decayers.
 
bool createModes_
 Whether to create the DecayModes as well as the Decayer objects.
 
unsigned int removeOnShell_
 Whether or not to remove on-shell diagrams.
 
vector< VertexBasePtr > excludedVerticesVector_
 Excluded Vertices.
 
set< VertexBasePtr > excludedVerticesSet_
 Excluded Vertices.
 
vector< PDPtrexcludedParticlesVector_
 Excluded Particles.
 
set< PDPtrexcludedParticlesSet_
 Excluded Particles.
 
bool excludeEffective_
 Whether or not to exclude effective vertices.
 
tDecayConstructorPtr decayConstructor_
 A pointer to the DecayConstructor object.
 
double minReleaseFraction_
 The minimum energy release for a three-body decay as a fraction of the parent mass.
 
unsigned int maxBoson_
 Maximum number of EW gauge bosons.
 
unsigned int maxList_
 Maximum number of particles from the decaying particle list.
 
bool includeTopOnShell_
 Include on-shell for $t\to b W$.
 
bool removeFlavourChangingVertices_
 Remove flavour changing vertices ?
 
bool removeSmallVertices_
 Remove small vertices ?
 
double minVertexNorm_
 Minimum norm for vertex removal.
 

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

This is the base class for NBodyDecayConstructors.

An N-body decay constructor should inherit from this and implement the DecayList virtual funtcion to create the decays and decayers.

See also
The interfaces defined for NBodyDecayConstructor.

Definition at line 34 of file NBodyDecayConstructorBase.h.

Member Function Documentation

◆ DecayList()

virtual void Herwig::NBodyDecayConstructorBase::DecayList ( const set< PDPtr > &  particles)
virtual

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

Parameters
particlesvector of ParticleData pointers containing particles in model

Reimplemented in Herwig::TwoBodyDecayConstructor, Herwig::WeakCurrentDecayConstructor, Herwig::ThreeBodyDecayConstructor, and Herwig::FourBodyDecayConstructor.

◆ doinit()

virtual void Herwig::NBodyDecayConstructorBase::doinit ( )
protectedvirtual

Initialize this object after the setup phase before saving an EventGenerator to disk.

Exceptions
InitExceptionif object could not be initialized properly.

Reimplemented from ThePEG::InterfacedBase.

Reimplemented in Herwig::WeakCurrentDecayConstructor.

◆ Init()

static void Herwig::NBodyDecayConstructorBase::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::NBodyDecayConstructorBase::numBodies ( ) const
pure virtual

◆ operator=()

NBodyDecayConstructorBase& Herwig::NBodyDecayConstructorBase::operator= ( const NBodyDecayConstructorBase )
privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ setBranchingRatio()

void Herwig::NBodyDecayConstructorBase::setBranchingRatio ( tDMPtr  dm,
Energy  pwidth 
)
protected

Set the branching ratio of this mode.

This requires calculating a new width for the decaying particle and reweighting the current branching fractions.

Parameters
dmThe decaymode for which to set the branching ratio
pwidthThe calculated width of the mode

◆ setDecayerInterfaces()

void Herwig::NBodyDecayConstructorBase::setDecayerInterfaces ( string  name) const
protected

Set the interfaces of the decayers depending on the flags stored.

Parameters
nameFullname of the decayer in the EventGenerator including the path

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