herwig is hosted by Hepforge, IPPP Durham
Herwig 7.3.0
Herwig::DecayConstructor Class Reference

The DecayConstructor class is an interfaced class that stores a vector of NBodyDecayConstructor objects and calls the appropriate function to create the decayers and decaymodes. More...

#include <DecayConstructor.h>

Inheritance diagram for Herwig::DecayConstructor:

Public Member Functions

 DecayConstructor ()
 The default constructor.
 
- 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
 

Protected Member Functions

Standard Interfaced functions.
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 &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (const Named &other)
 
const string & name (const string &newName)
 

Clone Methods.

vector< NBodyDecayConstructorBasePtr > NBodyDecayConstructors_
 Vector of references to the objects that will construct the N-Body decays.
 
vector< string > _disableDMTags
 A list of DecayMode tags that are not to be created.
 
DecayRadiationGeneratorPtr QEDGenerator_
 The decay radiation generator to use for QED radiation.
 
double _minBR
 Minimum allowed branching ratio.
 
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.
 
DecayConstructoroperator= (const DecayConstructor &)=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.
 
void createDecayers (const vector< PDPtr > &particles, double minBR)
 Function to create decayers.
 
bool disableDecayMode (string tag) const
 Check whether the decay mode given is one that should not be created.
 
DecayRadiationGeneratorPtr QEDGenerator ()
 QED Generator.
 
const vector< NBodyDecayConstructorBasePtr > & decayConstructors ()
 Vector of references to the objects that will construct the N-Body decays.
 
double minimumBR () const
 Get minimum branching ratio.
 
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 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
 
- Static Protected Member Functions inherited from ThePEG::Interfaced
static void registerRepository (IBPtr)
 
static void registerRepository (IBPtr, string newName)
 

Detailed Description

The DecayConstructor class is an interfaced class that stores a vector of NBodyDecayConstructor objects and calls the appropriate function to create the decayers and decaymodes.

There is also an interface to add decay mode tags of the form a->b,c,...; which will not be created.

See also
The interfaces defined for DecayConstructor.
Interfaced

Definition at line 34 of file DecayConstructor.h.

Constructor & Destructor Documentation

◆ DecayConstructor()

Herwig::DecayConstructor::DecayConstructor ( )
inline

The default constructor.

Definition at line 41 of file DecayConstructor.h.

Member Function Documentation

◆ clone()

virtual IBPtr Herwig::DecayConstructor::clone ( ) const
protectedvirtual

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ createDecayers()

void Herwig::DecayConstructor::createDecayers ( const vector< PDPtr > &  particles,
double  minBR 
)

Function to create decayers.

Parameters
particlesvector of ParticleData pointers to particles contained in model
minBRminimum branching ratio for modes

◆ decayConstructors()

const vector< NBodyDecayConstructorBasePtr > & Herwig::DecayConstructor::decayConstructors ( )
inline

Vector of references to the objects that will construct the N-Body decays.

Definition at line 94 of file DecayConstructor.h.

References NBodyDecayConstructors_.

◆ disableDecayMode()

bool Herwig::DecayConstructor::disableDecayMode ( string  tag) const

Check whether the decay mode given is one that should not be created.

Parameters
tagThe decay mode tag, a->b,c,d,...;

◆ doinit()

virtual void Herwig::DecayConstructor::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.

◆ fullclone()

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

◆ minimumBR()

double Herwig::DecayConstructor::minimumBR ( ) const
inline

Get minimum branching ratio.

Definition at line 101 of file DecayConstructor.h.

References _minBR.

◆ operator=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ QEDGenerator()

DecayRadiationGeneratorPtr Herwig::DecayConstructor::QEDGenerator ( )
inline

QED Generator.

Definition at line 88 of file DecayConstructor.h.

References QEDGenerator_.

Member Data Documentation

◆ _disableDMTags

vector<string> Herwig::DecayConstructor::_disableDMTags
private

A list of DecayMode tags that are not to be created.

Definition at line 151 of file DecayConstructor.h.

◆ _minBR

double Herwig::DecayConstructor::_minBR
private

Minimum allowed branching ratio.

Definition at line 161 of file DecayConstructor.h.

Referenced by minimumBR().

◆ NBodyDecayConstructors_

vector<NBodyDecayConstructorBasePtr> Herwig::DecayConstructor::NBodyDecayConstructors_
private

Vector of references to the objects that will construct the N-Body decays.

Definition at line 146 of file DecayConstructor.h.

Referenced by decayConstructors().

◆ QEDGenerator_

DecayRadiationGeneratorPtr Herwig::DecayConstructor::QEDGenerator_
private

The decay radiation generator to use for QED radiation.

Definition at line 156 of file DecayConstructor.h.

Referenced by QEDGenerator().


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