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

This class is the main driver of the shower: it is responsible for the proper handling of all other specific collaborating classes and for the storing of the produced particles in the event record. More...

#include <ShowerHandler.h>

Inheritance diagram for Herwig::ShowerHandler:

Classes

struct  ExtraScatterVeto
 struct that is used to catch exceptions which are thrown due to energy conservation issues of additional scatters More...
 
struct  ParticleOrdering
 A struct to order the particles in the same way as in the DecayMode's. More...
 
struct  ShowerTriesVeto
 struct that is used to catch exceptions which are thrown due to fact that the Shower has been invoked more than a defined threshold on a certain configuration More...
 

Public Types

typedef pair< tRemPPtr, tRemPPtr > RemPair
 Typedef for a pair of ThePEG::RemnantParticle pointers.
 
typedef multiset< tcPDPtr, ParticleOrderingOrderedParticles
 A container for ordered particles required for constructing tags for decay mode lookup.
 
- Public Types inherited from ThePEG::InterfacedBase
enum  InitState
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 
- Public Types inherited from ThePEG::LastXCombInfo< typename XC >
typedef ThePEG::Ptr< XC >::pointer XCPtr
 
typedef ThePEG::Ptr< XC >::const_pointer cXCPtr
 
typedef ThePEG::Ptr< XC >::transient_pointer tXCPtr
 
typedef ThePEG::Ptr< XC >::transient_const_pointer tcXCPtr
 

Public Member Functions

 ShowerHandler ()
 Default constructor.
 
virtual ~ShowerHandler ()
 Destructor.
 
virtual void cascade ()
 The main method which manages the multiple interactions and starts the shower by calling cascade(sub, lastXC).
 
virtual bool showerHardProcessVeto () const
 Hook to allow vetoing of event after showering hard sub-process as in e.g.
 
virtual bool isReshuffling () const
 Return true, if this cascade handler will perform reshuffling from hard process masses.
 
virtual bool retConstituentMasses () const
 Return true, if this cascade handler will put the final state particles to their constituent mass.
 
virtual bool canHandleMatchboxTrunc () const
 Return true, if the shower handler can generate a truncated shower for POWHEG style events generated using Matchbox.
 
Energy pdfFreezingScale () const
 Get the PDF freezing scale.
 
PDFPtr getPDFA () const
 Get the local PDFs.
 
PDFPtr getPDFB () const
 Get the local PDFs.
 
bool firstInteraction () const
 Return true if currently the primary subprocess is showered.
 
tHwRemDecPtr remnantDecayer () const
 Return the remnant decayer.
 
void splitHardProcess (tPVector tagged, PerturbativeProcessPtr &hard, DecayProcessMap &decay) const
 Split the hard process into production and decays.
 
bool doesSplitHardProcess () const
 Information if the Showerhandler splits the hard process.
 
tDMPtr decay (PerturbativeProcessPtr, DecayProcessMap &decay, bool radPhotons=false) const
 Decay a particle.
 
tDMPtr findDecayMode (const string &tag) const
 Cached lookup of decay modes.
 
Switches for initial- and final-state radiation
bool doRadiation () const
 Switch for any radiation.
 
bool doFSR () const
 Switch on or off final state radiation.
 
bool doISR () const
 Switch on or off initial state radiation.
 
Switches for scales
bool hardScaleIsMuF () const
 Return true if maximum pt should be deduced from the factorization scale.
 
double factorizationScaleFactor () const
 The factorization scale factor.
 
double renFac () const
 The renormalization scale factor.
 
double facFac () const
 The factorization scale factor.
 
double renormalizationScaleFactor () const
 The renormalization scale factor.
 
double hardScaleFactor () const
 The scale factor for the hard scale.
 
bool restrictPhasespace () const
 Return true, if the phase space restrictions of the dipole shower should be applied.
 
Ptr< HardScaleProfile >::tptr profileScales () const
 Return profile scales.
 
virtual Energy hardScale () const
 Return the relevant hard scale to be used in the profile scales.
 
virtual int showerPhaseSpaceOption () const
 Return information about shower phase space choices.
 
map< string, ShowerVariation > & showerVariations ()
 Access the shower variations.
 
const map< string, ShowerVariation > & showerVariations () const
 Return the shower variations.
 
map< string, double > & currentWeights ()
 Access the current Weights.
 
const map< string, double > & currentWeights () const
 Return the current Weights.
 
void reweight (double w)
 Change the current reweighting factor.
 
double reweight () const
 Return the current reweighting factor.
 
unsigned int spinCorrelations () const
 Access to switches for spin correlations.
 
virtual bool correlations () const
 Any correlations.
 
- Public Member Functions inherited from ThePEG::CascadeHandler
virtual void handle (EventHandler &eh, const tPVector &tagged, const Hint &hint)
 
virtual void cascade ()=0
 
virtual double reweightCKKW (int minMult, int maxMult)
 
const tPVectortagged () const
 
const Hinthint () const
 
const PDFfirstPDF () const
 
const PDFsecondPDF () const
 
const pair< PDF, PDF > & pdfs () const
 
void resetPDFs (const pair< tcPDFPtr, tcPDFPtr > &pdfpair)
 
void resetPDFs (const pair< tcPDFPtr, tcPDFPtr > &pdfpair, PBPair ppair)
 
void setXComb (tXCombPtr xc)
 
virtual bool isReshuffling () const
 
bool didRunCascade () const
 
virtual void handle (EventHandler &eh, const tPVector &tagged, const Hint &hint)
 
virtual void cascade ()=0
 
virtual double reweightCKKW (int minMult, int maxMult)
 
- Public Member Functions inherited from ThePEG::StepHandler
virtual void handle (EventHandler &eh, const tPVector &tagged, const Hint &hint)=0
 
tEHPtr eventHandler () const
 
void eventHandler (tEHPtr)
 
tStepPtr newStep ()
 
tStepPtr currentStep ()
 
virtual void handle (EventHandler &eh, const tPVector &tagged, const Hint &hint)=0
 
- Public Member Functions inherited from ThePEG::HandlerBaseT< UseRandom >
double rnd () const
 
double rnd (double xu) const
 
double rnd (double xl, double xu) const
 
bool rndbool () const
 
bool rndbool (double p) const
 
bool rndbool (double p1, double p2) const
 
int rndsign (double p1, double p2, double p3) const
 
int rnd2 (double p0, double p1) const
 
int rnd3 (double p0, double p1, double p2) const
 
int rnd4 (double p0, double p1, double p2, double p3) const
 
long irnd (long xu=2) const
 
long irnd (long xl, long xu) const
 
const StandardModelBaseSM () const
 
tSMPtr standardModel () const
 
- 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
 
- Public Member Functions inherited from ThePEG::LastXCombInfo< typename XC >
const XC & lastXComb () const
 
tXCPtr lastXCombPtr () const
 
const XC & lastHeadXComb () const
 
tXCPtr lastHeadXCombPtr () const
 
const EventHandlerlastEventHandler () const
 
tPExtrPtr lastExtractor () const
 
PDFT pdf (tcPPtr parton) const
 
const CutslastCuts () const
 
tCutsPtr lastCutsPtr () const
 
const PPairlastParticles () const
 
Energy2 lastS () const
 
const PPairlastPartons () const
 
Energy2 lastSHat () const
 
double lastTau () const
 
double lastY () const
 
double lastP1 () const
 
double lastP2 () const
 
double lastL1 () const
 
double lastL2 () const
 
double lastX1 () const
 
double lastX2 () const
 
double lastE1 () const
 
double lastE2 () const
 
double lastFL1L2 () const
 
Energy2 lastScale () const
 
double lastAlphaS () const
 
double lastAlphaEM () const
 
const vector< Lorentz5Momentum > & meMomenta () const
 
double lastME2 () const
 
double lastPreweight () const
 
double jacobian () const
 
CrossSection lastMECrossSection () const
 
double lastMEPDFWeight () const
 
double lastMECouplings () const
 
tSubProPtr subProcess () const
 
const cPDVectormePartonData () const
 
const XC & lastXComb () const
 
tXCPtr lastXCombPtr () const
 
const XC & lastHeadXComb () const
 
tXCPtr lastHeadXCombPtr () const
 
const EventHandlerlastEventHandler () const
 
tPExtrPtr lastExtractor () const
 
PDFT pdf (tcPPtr parton) const
 
const CutslastCuts () const
 
tCutsPtr lastCutsPtr () const
 
const PPairlastParticles () const
 
Energy2 lastS () const
 
const PPairlastPartons () const
 
Energy2 lastSHat () const
 
double lastTau () const
 
double lastY () const
 
double lastP1 () const
 
double lastP2 () const
 
double lastL1 () const
 
double lastL2 () const
 
double lastX1 () const
 
double lastX2 () const
 
double lastE1 () const
 
double lastE2 () const
 
double lastFL1L2 () const
 

Static Public Member Functions

static const tShowerHandlerPtr currentHandler ()
 pointer to "this", the current ShowerHandler.
 
static bool currentHandlerIsSet ()
 pointer to "this", the current ShowerHandler.
 
- Static Public Member Functions inherited from ThePEG::CascadeHandler
static void setDidRunCascade (bool c)
 
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::StepHandler
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::HandlerBase
static void Init ()
 
- 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

Functions to perform the cascade
virtual tPPair cascade (tSubProPtr sub, XCPtr xcomb)
 The main method which manages the showering of a subprocess.
 
void prepareCascade (tSubProPtr sub)
 Set up for the cascade.
 
void boostCollision (bool boost)
 Boost all the particles in the collision so that the collision always occurs in the rest frame with the incoming particles along the z axis.
 
void setCurrentHandler ()
 Set/unset the current shower handler.
 
void unSetCurrentHandler ()
 Unset the current handler.
 
Functions to return information relevant to the process being showered
tSubProPtr currentSubProcess () const
 Return the currently used SubProcess.
 
tPPair incomingBeams () const
 Access to the incoming beam particles.
 
void combineWeights ()
 Weight handling for shower variations.
 
void initializeWeights ()
 Initialise the weights in currentEvent()
 
void resetWeights ()
 Reset the current weights.
 
unsigned int maxtry () const
 Return the maximum number of attempts for showering a given subprocess.
 
bool includeSpaceTime () const
 Parameters for the space-time model.
 
Energy2 vMin () const
 The minimum virtuality for the space-time model.
 
Clone Methods.
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.
 
- Protected Member Functions inherited from ThePEG::StepHandler
void createNewStep ()
 
- 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

Parameters for initial- and final-state radiation
bool doFSR_
 Switch on or off final state radiation.
 
bool doISR_
 Switch on or off initial state radiation.
 

Standard Interfaced functions.

static tShowerHandlerPtr currentHandler_
 pointer to "this", the current ShowerHandler.
 
UEBasePtr MPIHandler_
 a MPIHandler to administer the creation of several (semihard) partonic interactions.
 
HwRemDecPtr remDec_
 Pointer to the HwRemDecayer.
 
unsigned int maxtry_
 Maximum tries for various stages of the showering process.
 
unsigned int maxtryMPI_
 Maximum number of attempts for the regeneration of an additional scattering, before the number of scatters is reduced.
 
unsigned int maxtryDP_
 Maximum number of attempts for the regeneration of an additional hard scattering, before this event is vetoed.
 
unsigned int maxtryDecay_
 Maximum number of attempts to generate a decay.
 
double factorizationScaleFactor_
 Factors for the various scales.
 
double renormalizationScaleFactor_
 The renormalization scale factor.
 
double hardScaleFactor_
 The scale factor for the hard scale.
 
bool restrictPhasespace_
 True, if the phase space restrictions of the dipole shower should be applied.
 
bool maxPtIsMuF_
 True if maximum pt should be deduced from the factorization scale.
 
Ptr< HardScaleProfile >::ptr hardScaleProfile_
 The profile scales.
 
unsigned int spinOpt_
 Option to include spin correlations.
 
tPPair incoming_
 Storage of information about the current event.
 
LorentzRotation boost_
 Boost to get back to the lab.
 
tSubProPtr subProcess_
 Const pointer to the currently handeled ThePEG::SubProcess.
 
tcStepPtr current_
 Const pointer to the current step.
 
Energy pdfFreezingScale_
 PDFs to be used for the various stages and related parameters.
 
PDFPtr PDFA_
 PDFs to be used for the various stages and related parameters.
 
PDFPtr PDFB_
 The PDF for beam particle B.
 
PDFPtr PDFARemnant_
 The PDF for beam particle A for remnant splitting.
 
PDFPtr PDFBRemnant_
 The PDF for beam particle B for remnant splitting.
 
pair< PDFPtr, PDFPtrmpipdfs_
 The MPI PDF's to be used for secondary scatters.
 
pair< PDFPtr, PDFPtrrempdfs_
 The MPI PDF's to be used for secondary scatters.
 
pair< PDFPtr, PDFPtrremmpipdfs_
 The MPI PDF's to be used for secondary scatters.
 
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk.
 
virtual void doinitrun ()
 Initialize this object.
 
virtual void dofinish ()
 Finalize this object.
 
ShowerHandleroperator= (const ShowerHandler &)=delete
 The assignment operator is private and must never be called.
 

Parameters for particle decays

bool splitHardProcess_
 Whether or not to split into hard and decay trees.
 
set< long > particlesDecayInShower_
 PDG codes of the particles which decay during showering this is fast storage for use during running.
 
vector< long > inputparticlesDecayInShower_
 PDG codes of the particles which decay during showering this is a vector that is interfaced so they can be changed.
 
bool includeSpaceTime_
 Parameters for the space-time model.
 
Energy2 vMin_
 The minimum virtuality for the space-time model.
 
bool useConstituentMasses_ = true
 Parameters for the constituent mass treatment.
 
int tagIntermediates_ = 0
 Status code to tag intermediate state as after the showering; if zero no tagging will be performed.
 
map< string, ShowerVariationshowerVariations_
 Parameters relevant for reweight and variations.
 
double reweight_
 A reweighting factor applied by the showering.
 
map< string, double > currentWeights_
 The shower variation weights.
 
string doAddVariation (string)
 Command to add a shower variation.
 

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.
 

Members relating to the underlying event and MPI

bool decaysInShower (long id) const
 Check if a particle decays in the shower.
 
bool isMPIOn () const
 Return true if multiple parton interactions are switched on and can be used for this beam setup.
 
tUEBasePtr getMPIHandler () const
 Access function for the MPIHandler, it should only be called after checking with isMPIOn.
 
bool isResolvedHadron (tPPtr)
 Is a beam particle where hadronic structure is resolved.
 
RemPair getRemnants (PBIPair incbins)
 Get the remnants from the ThePEG::PartonBinInstance es and do some checks.
 
void setMPIPDFs ()
 Reset the PDF's after the hard collision has been showered.
 
void findDecayProducts (PPtr parent, PerturbativeProcessPtr hard, DecayProcessMap &decay) const
 Members to handle splitting up of hard process and decays.
 
void createDecayProcess (PPtr parent, PerturbativeProcessPtr hard, DecayProcessMap &decay) const
 Find decay products from the hard process and create decay processes.
 

Additional Inherited Members

- 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)
 
- Protected Attributes inherited from ThePEG::LastXCombInfo< typename XC >
XCPtr theLastXComb
 

Detailed Description

This class is the main driver of the shower: it is responsible for the proper handling of all other specific collaborating classes and for the storing of the produced particles in the event record.

See also
The interfaces
ThePEG::CascadeHandler
MPIHandler
HwRemDecayer

Definition at line 40 of file ShowerHandler.h.

Member Typedef Documentation

◆ OrderedParticles

A container for ordered particles required for constructing tags for decay mode lookup.

Definition at line 190 of file ShowerHandler.h.

◆ RemPair

typedef pair<tRemPPtr, tRemPPtr> Herwig::ShowerHandler::RemPair

Typedef for a pair of ThePEG::RemnantParticle pointers.

Definition at line 47 of file ShowerHandler.h.

Member Function Documentation

◆ canHandleMatchboxTrunc()

virtual bool Herwig::ShowerHandler::canHandleMatchboxTrunc ( ) const
inlinevirtual

Return true, if the shower handler can generate a truncated shower for POWHEG style events generated using Matchbox.

Reimplemented in Herwig::DipoleShowerHandler, and Herwig::PowhegShowerHandler.

Definition at line 112 of file ShowerHandler.h.

◆ cascade()

virtual void Herwig::ShowerHandler::cascade ( )
virtual

The main method which manages the multiple interactions and starts the shower by calling cascade(sub, lastXC).

Implements ThePEG::CascadeHandler.

Referenced by Herwig::DipoleShowerHandler::cascade().

◆ clone()

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

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

Reimplemented in Herwig::AlpGenHandlerOL, Herwig::FxFxHandler, Herwig::DipoleShowerHandler, Herwig::PowhegHandler, Herwig::PowhegShowerHandler, and Herwig::QTildeShowerHandler.

◆ combineWeights()

void Herwig::ShowerHandler::combineWeights ( )
protected

Weight handling for shower variations.

Combine the variation weights which have been encountered

◆ correlations()

virtual bool Herwig::ShowerHandler::correlations ( ) const
inlinevirtual

Any correlations.

Reimplemented in Herwig::QTildeShowerHandler.

Definition at line 345 of file ShowerHandler.h.

References spinOpt_.

◆ createDecayProcess()

void Herwig::ShowerHandler::createDecayProcess ( PPtr  parent,
PerturbativeProcessPtr  hard,
DecayProcessMap decay 
) const
protected

Find decay products from the hard process and create decay processes.

Parameters
parentThe parent particle
hardThe parent hard process
decayThe decay processes

◆ currentHandler()

static const tShowerHandlerPtr Herwig::ShowerHandler::currentHandler ( )
inlinestatic

pointer to "this", the current ShowerHandler.

Definition at line 72 of file ShowerHandler.h.

References currentHandler_.

◆ currentHandlerIsSet()

static bool Herwig::ShowerHandler::currentHandlerIsSet ( )
inlinestatic

pointer to "this", the current ShowerHandler.

Definition at line 82 of file ShowerHandler.h.

References currentHandler_.

◆ currentSubProcess()

tSubProPtr Herwig::ShowerHandler::currentSubProcess ( ) const
inlineprotected

Return the currently used SubProcess.

Definition at line 524 of file ShowerHandler.h.

References subProcess_.

◆ currentWeights() [1/2]

map< string, double > & Herwig::ShowerHandler::currentWeights ( )
inline

Access the current Weights.

Definition at line 304 of file ShowerHandler.h.

References currentWeights_.

◆ currentWeights() [2/2]

const map< string, double > & Herwig::ShowerHandler::currentWeights ( ) const
inline

Return the current Weights.

Definition at line 311 of file ShowerHandler.h.

References currentWeights_.

◆ decay()

tDMPtr Herwig::ShowerHandler::decay ( PerturbativeProcessPtr  ,
DecayProcessMap decay,
bool  radPhotons = false 
) const

Decay a particle.

radPhotons switches the generation of photon radiation on/off. Required for Dipole Shower but not QTilde Shower.

◆ decaysInShower()

bool Herwig::ShowerHandler::decaysInShower ( long  id) const
inline

Check if a particle decays in the shower.

Parameters
idThe PDG code for the particle

Definition at line 489 of file ShowerHandler.h.

References particlesDecayInShower_.

◆ doesSplitHardProcess()

bool Herwig::ShowerHandler::doesSplitHardProcess ( ) const
inline

Information if the Showerhandler splits the hard process.

Definition at line 155 of file ShowerHandler.h.

References splitHardProcess_.

◆ dofinish()

virtual void Herwig::ShowerHandler::dofinish ( )
protectedvirtual

Finalize this object.

Called in the run phase just after a run has ended. Used eg. to write out statistics.

Reimplemented from ThePEG::InterfacedBase.

Reimplemented in Herwig::AlpGenHandlerOL, Herwig::FxFxHandler, and Herwig::DipoleShowerHandler.

◆ doFSR()

bool Herwig::ShowerHandler::doFSR ( ) const
inline

Switch on or off final state radiation.

Definition at line 207 of file ShowerHandler.h.

References doFSR_.

◆ doinit()

virtual void Herwig::ShowerHandler::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::AlpGenHandlerOL, Herwig::FxFxHandler, Herwig::DipoleShowerHandler, Herwig::MatchingHandler, Herwig::PowhegShowerHandler, and Herwig::QTildeShowerHandler.

◆ doinitrun()

virtual void Herwig::ShowerHandler::doinitrun ( )
protectedvirtual

Initialize this object.

Called in the run phase just before a run begins.

Reimplemented from ThePEG::InterfacedBase.

Reimplemented in Herwig::AlpGenHandlerOL, Herwig::FxFxHandler, Herwig::DipoleShowerHandler, and Herwig::QTildeShowerHandler.

◆ doISR()

bool Herwig::ShowerHandler::doISR ( ) const
inline

Switch on or off initial state radiation.

Definition at line 212 of file ShowerHandler.h.

References doISR_.

◆ doRadiation()

bool Herwig::ShowerHandler::doRadiation ( ) const
inline

Switch for any radiation.

Definition at line 202 of file ShowerHandler.h.

References doFSR_, and doISR_.

◆ facFac()

double Herwig::ShowerHandler::facFac ( ) const
inline

The factorization scale factor.

Definition at line 243 of file ShowerHandler.h.

References factorizationScaleFactor_.

◆ factorizationScaleFactor()

double Herwig::ShowerHandler::factorizationScaleFactor ( ) const
inline

The factorization scale factor.

Definition at line 229 of file ShowerHandler.h.

References factorizationScaleFactor_.

◆ findDecayMode()

tDMPtr Herwig::ShowerHandler::findDecayMode ( const string &  tag) const

Cached lookup of decay modes.

Generator::findDecayMode() is not efficient.

◆ findDecayProducts()

void Herwig::ShowerHandler::findDecayProducts ( PPtr  parent,
PerturbativeProcessPtr  hard,
DecayProcessMap decay 
) const
protected

Members to handle splitting up of hard process and decays.

Find decay products from the hard process and create decay processes

Parameters
parentThe parent particle
hardThe hard process
decayThe decay processes

◆ firstInteraction()

bool Herwig::ShowerHandler::firstInteraction ( ) const
inline

Return true if currently the primary subprocess is showered.

Definition at line 132 of file ShowerHandler.h.

References ThePEG::StepHandler::eventHandler(), and subProcess_.

◆ fullclone()

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

Reimplemented in Herwig::AlpGenHandlerOL, Herwig::FxFxHandler, Herwig::DipoleShowerHandler, Herwig::PowhegHandler, Herwig::PowhegShowerHandler, and Herwig::QTildeShowerHandler.

◆ getMPIHandler()

tUEBasePtr Herwig::ShowerHandler::getMPIHandler ( ) const
inlineprotected

Access function for the MPIHandler, it should only be called after checking with isMPIOn.

Definition at line 461 of file ShowerHandler.h.

References MPIHandler_.

◆ getPDFA()

PDFPtr Herwig::ShowerHandler::getPDFA ( ) const
inline

Get the local PDFs.

Definition at line 122 of file ShowerHandler.h.

References PDFA_.

◆ getPDFB()

PDFPtr Herwig::ShowerHandler::getPDFB ( ) const
inline

Get the local PDFs.

Definition at line 127 of file ShowerHandler.h.

References PDFB_.

◆ hardScale()

virtual Energy Herwig::ShowerHandler::hardScale ( ) const
virtual

Return the relevant hard scale to be used in the profile scales.

Reimplemented in Herwig::DipoleShowerHandler, and Herwig::QTildeShowerHandler.

◆ hardScaleFactor()

double Herwig::ShowerHandler::hardScaleFactor ( ) const
inline

The scale factor for the hard scale.

Definition at line 257 of file ShowerHandler.h.

References hardScaleFactor_.

◆ hardScaleIsMuF()

bool Herwig::ShowerHandler::hardScaleIsMuF ( ) const
inline

Return true if maximum pt should be deduced from the factorization scale.

Definition at line 224 of file ShowerHandler.h.

References maxPtIsMuF_.

◆ includeSpaceTime()

bool Herwig::ShowerHandler::includeSpaceTime ( ) const
inlineprotected

Parameters for the space-time model.

Whether or not to include spa-cetime distances in the shower

Definition at line 576 of file ShowerHandler.h.

References includeSpaceTime_.

◆ incomingBeams()

tPPair Herwig::ShowerHandler::incomingBeams ( ) const
inlineprotected

Access to the incoming beam particles.

Definition at line 532 of file ShowerHandler.h.

References incoming_.

◆ Init()

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

◆ isMPIOn()

bool Herwig::ShowerHandler::isMPIOn ( ) const
inlineprotected

Return true if multiple parton interactions are switched on and can be used for this beam setup.

Definition at line 453 of file ShowerHandler.h.

References MPIHandler_.

◆ isReshuffling()

virtual bool Herwig::ShowerHandler::isReshuffling ( ) const
inlinevirtual

Return true, if this cascade handler will perform reshuffling from hard process masses.

Reimplemented from ThePEG::CascadeHandler.

Reimplemented in Herwig::DipoleShowerHandler.

Definition at line 98 of file ShowerHandler.h.

◆ maxtry()

unsigned int Herwig::ShowerHandler::maxtry ( ) const
inlineprotected

Return the maximum number of attempts for showering a given subprocess.

Definition at line 565 of file ShowerHandler.h.

References maxtry_.

◆ operator=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ pdfFreezingScale()

Energy Herwig::ShowerHandler::pdfFreezingScale ( ) const
inline

Get the PDF freezing scale.

Definition at line 117 of file ShowerHandler.h.

References pdfFreezingScale_.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ prepareCascade()

void Herwig::ShowerHandler::prepareCascade ( tSubProPtr  sub)
inlineprotected

Set up for the cascade.

Definition at line 410 of file ShowerHandler.h.

References current_, ThePEG::StepHandler::currentStep(), and subProcess_.

◆ profileScales()

Ptr< HardScaleProfile >::tptr Herwig::ShowerHandler::profileScales ( ) const
inline

Return profile scales.

Definition at line 269 of file ShowerHandler.h.

References hardScaleProfile_.

◆ remnantDecayer()

tHwRemDecPtr Herwig::ShowerHandler::remnantDecayer ( ) const
inline

Return the remnant decayer.

Definition at line 141 of file ShowerHandler.h.

References remDec_.

◆ renFac()

double Herwig::ShowerHandler::renFac ( ) const
inline

The renormalization scale factor.

Definition at line 236 of file ShowerHandler.h.

References renormalizationScaleFactor_.

◆ renormalizationScaleFactor()

double Herwig::ShowerHandler::renormalizationScaleFactor ( ) const
inline

The renormalization scale factor.

Definition at line 250 of file ShowerHandler.h.

References renormalizationScaleFactor_.

◆ restrictPhasespace()

bool Herwig::ShowerHandler::restrictPhasespace ( ) const
inline

Return true, if the phase space restrictions of the dipole shower should be applied.

Definition at line 264 of file ShowerHandler.h.

References restrictPhasespace_.

◆ retConstituentMasses()

virtual bool Herwig::ShowerHandler::retConstituentMasses ( ) const
inlinevirtual

Return true, if this cascade handler will put the final state particles to their constituent mass.

If false the nominal mass is used.

Definition at line 104 of file ShowerHandler.h.

References useConstituentMasses_.

◆ reweight() [1/2]

double Herwig::ShowerHandler::reweight ( ) const
inline

Return the current reweighting factor.

Definition at line 325 of file ShowerHandler.h.

References reweight_.

◆ reweight() [2/2]

void Herwig::ShowerHandler::reweight ( double  w)
inline

Change the current reweighting factor.

Definition at line 318 of file ShowerHandler.h.

References reweight_.

◆ setCurrentHandler()

void Herwig::ShowerHandler::setCurrentHandler ( )
inlineprotected

Set/unset the current shower handler.

Set the current handler

Definition at line 431 of file ShowerHandler.h.

References currentHandler_.

◆ showerHardProcessVeto()

virtual bool Herwig::ShowerHandler::showerHardProcessVeto ( ) const
inlinevirtual

Hook to allow vetoing of event after showering hard sub-process as in e.g.

MLM merging.

Reimplemented in Herwig::AlpGenHandlerOL, Herwig::FxFxHandler, and Herwig::QTildeShowerHandler.

Definition at line 92 of file ShowerHandler.h.

◆ showerPhaseSpaceOption()

virtual int Herwig::ShowerHandler::showerPhaseSpaceOption ( ) const
inlinevirtual

Return information about shower phase space choices.

Reimplemented in Herwig::DipoleShowerHandler.

Definition at line 279 of file ShowerHandler.h.

◆ showerVariations() [1/2]

map< string, ShowerVariation > & Herwig::ShowerHandler::showerVariations ( )
inline

Access the shower variations.

Definition at line 290 of file ShowerHandler.h.

References showerVariations_.

◆ showerVariations() [2/2]

const map< string, ShowerVariation > & Herwig::ShowerHandler::showerVariations ( ) const
inline

Return the shower variations.

Definition at line 297 of file ShowerHandler.h.

References showerVariations_.

◆ spinCorrelations()

unsigned int Herwig::ShowerHandler::spinCorrelations ( ) const
inline

Access to switches for spin correlations.

Spin Correlations

Definition at line 338 of file ShowerHandler.h.

References spinOpt_.

Referenced by Herwig::QTildeShowerHandler::correlations().

◆ splitHardProcess()

void Herwig::ShowerHandler::splitHardProcess ( tPVector  tagged,
PerturbativeProcessPtr &  hard,
DecayProcessMap decay 
) const

Split the hard process into production and decays.

Parameters
taggedThe tagged particles from the StepHandler
hardThe hard perturbative process
decayThe decay particles

◆ unSetCurrentHandler()

void Herwig::ShowerHandler::unSetCurrentHandler ( )
inlineprotected

Unset the current handler.

Definition at line 438 of file ShowerHandler.h.

References currentHandler_.

◆ vMin()

Energy2 Herwig::ShowerHandler::vMin ( ) const
inlineprotected

The minimum virtuality for the space-time model.

Definition at line 581 of file ShowerHandler.h.

References vMin_.

Member Data Documentation

◆ boost_

LorentzRotation Herwig::ShowerHandler::boost_
private

Boost to get back to the lab.

Definition at line 738 of file ShowerHandler.h.

◆ current_

tcStepPtr Herwig::ShowerHandler::current_
private

Const pointer to the current step.

Definition at line 748 of file ShowerHandler.h.

Referenced by prepareCascade().

◆ currentHandler_

tShowerHandlerPtr Herwig::ShowerHandler::currentHandler_
staticprivate

pointer to "this", the current ShowerHandler.

Definition at line 638 of file ShowerHandler.h.

Referenced by currentHandler(), currentHandlerIsSet(), setCurrentHandler(), and unSetCurrentHandler().

◆ currentWeights_

map<string,double> Herwig::ShowerHandler::currentWeights_
private

The shower variation weights.

Definition at line 904 of file ShowerHandler.h.

Referenced by currentWeights().

◆ doFSR_

bool Herwig::ShowerHandler::doFSR_
private

Switch on or off final state radiation.

Definition at line 811 of file ShowerHandler.h.

Referenced by doFSR(), and doRadiation().

◆ doISR_

bool Herwig::ShowerHandler::doISR_
private

Switch on or off initial state radiation.

Definition at line 816 of file ShowerHandler.h.

Referenced by doISR(), and doRadiation().

◆ factorizationScaleFactor_

double Herwig::ShowerHandler::factorizationScaleFactor_
private

Factors for the various scales.

The factorization scale factor.

Definition at line 690 of file ShowerHandler.h.

Referenced by facFac(), and factorizationScaleFactor().

◆ hardScaleFactor_

double Herwig::ShowerHandler::hardScaleFactor_
private

The scale factor for the hard scale.

Definition at line 700 of file ShowerHandler.h.

Referenced by hardScaleFactor().

◆ hardScaleProfile_

Ptr<HardScaleProfile>::ptr Herwig::ShowerHandler::hardScaleProfile_
private

The profile scales.

Definition at line 716 of file ShowerHandler.h.

Referenced by profileScales().

◆ includeSpaceTime_

bool Herwig::ShowerHandler::includeSpaceTime_
private

Parameters for the space-time model.

Whether or not to include space-time distances in the shower

Definition at line 852 of file ShowerHandler.h.

Referenced by includeSpaceTime().

◆ incoming_

tPPair Herwig::ShowerHandler::incoming_
private

Storage of information about the current event.

The incoming beam particles for the current collision

Definition at line 733 of file ShowerHandler.h.

Referenced by incomingBeams().

◆ inputparticlesDecayInShower_

vector<long> Herwig::ShowerHandler::inputparticlesDecayInShower_
private

PDG codes of the particles which decay during showering this is a vector that is interfaced so they can be changed.

Definition at line 840 of file ShowerHandler.h.

◆ maxPtIsMuF_

bool Herwig::ShowerHandler::maxPtIsMuF_
private

True if maximum pt should be deduced from the factorization scale.

Definition at line 711 of file ShowerHandler.h.

Referenced by hardScaleIsMuF().

◆ maxtry_

unsigned int Herwig::ShowerHandler::maxtry_
private

Maximum tries for various stages of the showering process.

Maximum number of attempts for the main showering loop

Definition at line 661 of file ShowerHandler.h.

Referenced by maxtry().

◆ maxtryDecay_

unsigned int Herwig::ShowerHandler::maxtryDecay_
private

Maximum number of attempts to generate a decay.

Definition at line 678 of file ShowerHandler.h.

◆ maxtryDP_

unsigned int Herwig::ShowerHandler::maxtryDP_
private

Maximum number of attempts for the regeneration of an additional hard scattering, before this event is vetoed.

Definition at line 673 of file ShowerHandler.h.

◆ maxtryMPI_

unsigned int Herwig::ShowerHandler::maxtryMPI_
private

Maximum number of attempts for the regeneration of an additional scattering, before the number of scatters is reduced.

Definition at line 667 of file ShowerHandler.h.

◆ MPIHandler_

UEBasePtr Herwig::ShowerHandler::MPIHandler_
private

a MPIHandler to administer the creation of several (semihard) partonic interactions.

Definition at line 644 of file ShowerHandler.h.

Referenced by getMPIHandler(), and isMPIOn().

◆ mpipdfs_

pair<PDFPtr, PDFPtr> Herwig::ShowerHandler::mpipdfs_
private

The MPI PDF's to be used for secondary scatters.

Definition at line 789 of file ShowerHandler.h.

◆ particlesDecayInShower_

set<long> Herwig::ShowerHandler::particlesDecayInShower_
private

PDG codes of the particles which decay during showering this is fast storage for use during running.

Definition at line 834 of file ShowerHandler.h.

Referenced by decaysInShower().

◆ PDFA_

PDFPtr Herwig::ShowerHandler::PDFA_
private

PDFs to be used for the various stages and related parameters.

The PDF for beam particle A. Overrides the particle's own PDF setting.

Definition at line 769 of file ShowerHandler.h.

Referenced by getPDFA().

◆ PDFARemnant_

PDFPtr Herwig::ShowerHandler::PDFARemnant_
private

The PDF for beam particle A for remnant splitting.

Overrides the particle's own PDF setting.

Definition at line 779 of file ShowerHandler.h.

◆ PDFB_

PDFPtr Herwig::ShowerHandler::PDFB_
private

The PDF for beam particle B.

Overrides the particle's own PDF setting.

Definition at line 774 of file ShowerHandler.h.

Referenced by getPDFB().

◆ PDFBRemnant_

PDFPtr Herwig::ShowerHandler::PDFBRemnant_
private

The PDF for beam particle B for remnant splitting.

Overrides the particle's own PDF setting.

Definition at line 784 of file ShowerHandler.h.

◆ pdfFreezingScale_

Energy Herwig::ShowerHandler::pdfFreezingScale_
private

PDFs to be used for the various stages and related parameters.

The PDF freezing scale

Definition at line 760 of file ShowerHandler.h.

Referenced by pdfFreezingScale().

◆ remDec_

HwRemDecPtr Herwig::ShowerHandler::remDec_
private

Pointer to the HwRemDecayer.

Definition at line 649 of file ShowerHandler.h.

Referenced by remnantDecayer().

◆ remmpipdfs_

pair<PDFPtr, PDFPtr> Herwig::ShowerHandler::remmpipdfs_
private

The MPI PDF's to be used for secondary scatters.

Definition at line 799 of file ShowerHandler.h.

◆ rempdfs_

pair<PDFPtr, PDFPtr> Herwig::ShowerHandler::rempdfs_
private

The MPI PDF's to be used for secondary scatters.

Definition at line 794 of file ShowerHandler.h.

◆ renormalizationScaleFactor_

double Herwig::ShowerHandler::renormalizationScaleFactor_
private

The renormalization scale factor.

Definition at line 695 of file ShowerHandler.h.

Referenced by renFac(), and renormalizationScaleFactor().

◆ restrictPhasespace_

bool Herwig::ShowerHandler::restrictPhasespace_
private

True, if the phase space restrictions of the dipole shower should be applied.

Definition at line 706 of file ShowerHandler.h.

Referenced by restrictPhasespace().

◆ reweight_

double Herwig::ShowerHandler::reweight_
private

A reweighting factor applied by the showering.

Definition at line 899 of file ShowerHandler.h.

Referenced by reweight().

◆ showerVariations_

map<string,ShowerVariation> Herwig::ShowerHandler::showerVariations_
private

Parameters relevant for reweight and variations.

The shower variations

Definition at line 889 of file ShowerHandler.h.

Referenced by showerVariations().

◆ spinOpt_

unsigned int Herwig::ShowerHandler::spinOpt_
private

Option to include spin correlations.

Definition at line 722 of file ShowerHandler.h.

Referenced by correlations(), and spinCorrelations().

◆ splitHardProcess_

bool Herwig::ShowerHandler::splitHardProcess_
private

Whether or not to split into hard and decay trees.

Definition at line 828 of file ShowerHandler.h.

Referenced by doesSplitHardProcess().

◆ subProcess_

tSubProPtr Herwig::ShowerHandler::subProcess_
private

Const pointer to the currently handeled ThePEG::SubProcess.

Definition at line 743 of file ShowerHandler.h.

Referenced by currentSubProcess(), firstInteraction(), and prepareCascade().

◆ tagIntermediates_

int Herwig::ShowerHandler::tagIntermediates_ = 0
private

Status code to tag intermediate state as after the showering; if zero no tagging will be performed.

Definition at line 876 of file ShowerHandler.h.

◆ useConstituentMasses_

bool Herwig::ShowerHandler::useConstituentMasses_ = true
private

Parameters for the constituent mass treatment.

True if shower should return constituent masses.

Definition at line 871 of file ShowerHandler.h.

Referenced by retConstituentMasses().

◆ vMin_

Energy2 Herwig::ShowerHandler::vMin_
private

The minimum virtuality for the space-time model.

Definition at line 857 of file ShowerHandler.h.

Referenced by vMin().


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