herwig is hosted by Hepforge, IPPP Durham
Herwig  7.1.4
Herwig::UEBase Class Referenceabstract

Abstract base class used to minimize the dependence between MPIHandler and all Shower classes. More...

#include <UEBase.h>

Inheritance diagram for Herwig::UEBase:

Public Member Functions

Virtual functions used for the generation of additional

interactions .

virtual void initialize ()
 Some initialization code eventually.
 
virtual bool beamOK () const =0
 Return true or false depending on the generator setup.
 
virtual bool softInt () const
 Return true or false depending on whether soft interactions are enabled.
 
virtual Energy Ptmin () const =0
 Return the value of the pt cutoff.
 
virtual InvEnergy2 beta () const
 Return the slope of the soft pt spectrum. More...
 
virtual void finalize ()
 Some finalize code eventually.
 
virtual void clean ()
 Clean up method called after each event.
 
virtual unsigned int additionalHardProcs () const
 Return the number of different hard processes. More...
 
virtual unsigned int multiplicity (unsigned int i=0)=0
 return the hard multiplicity of process i. More...
 
virtual tStdXCombPtr generate (unsigned int sel=0)=0
 Generate a additional interaction for ProcessHandler sel. More...
 
virtual int Algorithm () const =0
 Return the type of algorithm.
 
virtual Energy PtForVeto () const =0
 Return the value of the hard Process pt cutoff for vetoing.
 
virtual double colourDisrupt () const
 Return the fraction of colour disrupted subprocesses. More...
 
virtual unsigned int softMultiplicity () const
 Return the soft multiplicity. 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 ()
 

Private Member Functions

UEBaseoperator= (const UEBase &)
 The assignment operator is private and must never be called. More...
 

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
 
- 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 doinit ()
 
virtual void doinitrun ()
 
virtual void dofinish ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
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 &)
 
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (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

Abstract base class used to minimize the dependence between MPIHandler and all Shower classes.

Author
Manuel B"ahr
See also
The interfaces defined for UEBase.

Definition at line 25 of file UEBase.h.

Member Function Documentation

◆ additionalHardProcs()

virtual unsigned int Herwig::UEBase::additionalHardProcs ( ) const
inlinevirtual

Return the number of different hard processes.

Use 0 as default to not require implementation.

Reimplemented in Herwig::MPIHandler.

Definition at line 80 of file UEBase.h.

References Herwig::RandomHelpers::generate().

◆ beta()

virtual InvEnergy2 Herwig::UEBase::beta ( ) const
inlinevirtual

Return the slope of the soft pt spectrum.

Only necessary when the soft part is modelled.

Reimplemented in Herwig::MPIHandler.

Definition at line 64 of file UEBase.h.

References ZERO.

◆ colourDisrupt()

virtual double Herwig::UEBase::colourDisrupt ( ) const
inlinevirtual

Return the fraction of colour disrupted subprocesses.

Use default 0 so that it is not required to implement.

Reimplemented in Herwig::MPIHandler.

Definition at line 110 of file UEBase.h.

◆ generate()

virtual tStdXCombPtr Herwig::UEBase::generate ( unsigned int  sel = 0)
pure virtual

Generate a additional interaction for ProcessHandler sel.

Method can't be const because it saves the state of the underlying XComb object on it's way.

Implemented in Herwig::MPIHandler.

◆ Init()

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

◆ multiplicity()

virtual unsigned int Herwig::UEBase::multiplicity ( unsigned int  i = 0)
pure virtual

return the hard multiplicity of process i.

Can't be constant in my case because drawing from the probability distribution also specifies the soft multiplicity that has to be stored....

Implemented in Herwig::MPIHandler.

◆ operator=()

UEBase& Herwig::UEBase::operator= ( const UEBase )
private

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ softMultiplicity()

virtual unsigned int Herwig::UEBase::softMultiplicity ( ) const
inlinevirtual

Return the soft multiplicity.

Use 0 as default to not require implementation.

Reimplemented in Herwig::MPIHandler.

Definition at line 116 of file UEBase.h.


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