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

This class is designed to store the particles in some model and then call the appropriate function to setup the model. More...

#include <ModelGenerator.h>

Inheritance diagram for Herwig::ModelGenerator:

Public Member Functions

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

Private Attributes

Width and Mass Generator variables.
PDVector offshell_
 The particles to create MassGenerator and WidthGenerators

 
int Offsel_
 Which particles to treat as off-shell.
 
bool BRnorm_
 Whether to normalise the partial widths to BR*Total width for an on-shell particle.
 
int Npoints_
 The number of points to include in the interpolation table.
 
unsigned int Iorder_
 The order for the interpolation.
 
int BWshape_
 The shape of the Breit-Wigner used in the mass generation.
 
double brMin_
 The minimum branching ratio to use.
 
bool twoBodyOnly_
 Whether to use only two-body or all modes for running width.
 
unsigned int decayOutput_
 Option for the outputs of the decays to a file.
 
double minWidth_
 Minimum fraction of particle's mass width can be for off-shell treatment.
 
double howOffShell_
 How much a particle is allowed to be offshell.
 

Clone Methods.

vector< HPConstructorPtr > hardProcessConstructors_
 Pointer to the TwoToTwoProcessConstructor.
 
DecayConstructorPtr _theDecayConstructor
 Pointer to DecayConstructor.
 
PDVector particles_
 Vector of ParticleData pointer.
 
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.
 
ModelGeneratoroperator= (const ModelGenerator &)=delete
 The assignment operator is private and must never be called.
 
void checkDecays (PDPtr parent)
 Check the decay modes a given particle type.
 
void writeDecayModes (ostream &ofs, tcPDPtr parent) const
 Write out the spectrum of masses and decay modes.
 
void createWidthGenerator (tPDPtr p)
 Create mass and width generators to simulate off-shell effects.
 

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.
 
virtual bool preInitialize () const
 Overloaded function from Interfaced.
 
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

This class is designed to store the particles in some model and then call the appropriate function to setup the model.

See also
The interfaces defined for ModelGenerator.
Interfaced

Definition at line 31 of file ModelGenerator.h.

Constructor & Destructor Documentation

◆ ModelGenerator()

Herwig::ModelGenerator::ModelGenerator ( )
inline

The default constructor.

Definition at line 38 of file ModelGenerator.h.

Member Function Documentation

◆ checkDecays()

void Herwig::ModelGenerator::checkDecays ( PDPtr  parent)
private

Check the decay modes a given particle type.

This checks whether the decay has quarks in the final state and that they can be put on mass-shell during the shower.

Parameters
parentThe parent particle

◆ clone()

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

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ createWidthGenerator()

void Herwig::ModelGenerator::createWidthGenerator ( tPDPtr  p)
private

Create mass and width generators to simulate off-shell effects.

Parameters
pA pointer to the ParticleData object to create the width and mass generators for.

◆ doinit()

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

◆ operator=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ preInitialize()

virtual bool Herwig::ModelGenerator::preInitialize ( ) const
inlinevirtual

Overloaded function from Interfaced.

Reimplemented from ThePEG::InterfacedBase.

Definition at line 74 of file ModelGenerator.h.

Member Data Documentation

◆ _theDecayConstructor

DecayConstructorPtr Herwig::ModelGenerator::_theDecayConstructor
private

Pointer to DecayConstructor.

Definition at line 147 of file ModelGenerator.h.

◆ brMin_

double Herwig::ModelGenerator::brMin_
private

The minimum branching ratio to use.

Definition at line 192 of file ModelGenerator.h.

◆ BRnorm_

bool Herwig::ModelGenerator::BRnorm_
private

Whether to normalise the partial widths to BR*Total width for an on-shell particle.

Definition at line 172 of file ModelGenerator.h.

◆ BWshape_

int Herwig::ModelGenerator::BWshape_
private

The shape of the Breit-Wigner used in the mass generation.

Definition at line 187 of file ModelGenerator.h.

◆ decayOutput_

unsigned int Herwig::ModelGenerator::decayOutput_
private

Option for the outputs of the decays to a file.

Definition at line 203 of file ModelGenerator.h.

◆ hardProcessConstructors_

vector<HPConstructorPtr> Herwig::ModelGenerator::hardProcessConstructors_
private

Pointer to the TwoToTwoProcessConstructor.

Definition at line 142 of file ModelGenerator.h.

◆ howOffShell_

double Herwig::ModelGenerator::howOffShell_
private

How much a particle is allowed to be offshell.

Definition at line 214 of file ModelGenerator.h.

◆ Iorder_

unsigned int Herwig::ModelGenerator::Iorder_
private

The order for the interpolation.

Definition at line 182 of file ModelGenerator.h.

◆ minWidth_

double Herwig::ModelGenerator::minWidth_
private

Minimum fraction of particle's mass width can be for off-shell treatment.

Definition at line 209 of file ModelGenerator.h.

◆ Npoints_

int Herwig::ModelGenerator::Npoints_
private

The number of points to include in the interpolation table.

Definition at line 177 of file ModelGenerator.h.

◆ Offsel_

int Herwig::ModelGenerator::Offsel_
private

Which particles to treat as off-shell.

1 treats all particles in particles_ vector as off-shell, 0 allows selection via offshell_ vector.

Definition at line 166 of file ModelGenerator.h.

◆ offshell_

PDVector Herwig::ModelGenerator::offshell_
private

The particles to create MassGenerator and WidthGenerators

Definition at line 159 of file ModelGenerator.h.

◆ particles_

PDVector Herwig::ModelGenerator::particles_
private

Vector of ParticleData pointer.

Definition at line 152 of file ModelGenerator.h.

◆ twoBodyOnly_

bool Herwig::ModelGenerator::twoBodyOnly_
private

Whether to use only two-body or all modes for running width.

Definition at line 197 of file ModelGenerator.h.


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