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

The DipoleShowerHandler class manages the showering using the dipole shower algorithm. More...

#include <DipoleShowerHandler.h>

Inheritance diagram for Herwig::DipoleShowerHandler:

Classes

struct  RedoShower
 Indicate a problem in the shower. More...
 

Public Member Functions

 DipoleShowerHandler ()
 The default constructor.
 
void colourPrint ()
 
void addSplitting (Ptr< DipoleSplittingKernel >::ptr sp)
 Insert an additional splitting kernel.
 
void resetAlphaS (Ptr< AlphaSBase >::tptr)
 Reset the alpha_s for all splitting kernels.
 
virtual void cascade (tPVector)
 
void resetReweight (Ptr< DipoleSplittingReweight >::tptr)
 Reset the splitting reweight for all splitting kernels.
 
virtual bool canHandleMatchboxTrunc () const
 Return true, if the shower handler can generate a truncated shower for POWHEG style events generated using Matchbox.
 
virtual bool isReshuffling () const
 Return true, if this cascade handler will perform reshuffling from hard process masses.
 
virtual Energy hardScale () const
 Return the relevant hard scale to be used in the profile scales.
 
double as (Energy Q) const
 Calculate the alpha_s value the shower uses for Q.
 
double Nf (Energy Q) const
 Return the number of scale dependent active flavours from the alpha_s object.
 
DipoleVertexRecordvertexRecord ()
 
const DipoleVertexRecordvertexRecord () const
 Return the event record.
 
void setMerger (Ptr< MergerBase >::ptr mh)
 Set the pointer to the Merging Helper.
 
const map< PPtr, size_t > & particleIndices () const
 Return the dictionary for the incoming particles and outgoing partons in the event, will be empty if subleading Nc is turned off.
 
const cPDVectorparticlesAfter () const
 Return the particle data vector of the particles in the event, will be empty if subleading Nc is turned off.
 
DensityOperatordensityOperator ()
 Return the density operator from the event record.
 
const map< pair< vector< PDT::Colour >, pair< size_t, size_t > >, double > & correlatorMap () const
 Return the colour matrix element correction map, will be empty if subleading Nc is turned off.
 
Ptr< ColourBasis >::tptr colourBasis ()
 Return the colour basis used in the density operator.
 
bool continueSubleadingNc () const
 Return the continue subleading Nc flag from the event record.
 
- Public Member Functions inherited from Herwig::ShowerHandler
 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.
 
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.
 
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.
 
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.
 
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.
 
bool decaysInShower (long id) const
 Check if a particle decays in the shower.
 
- 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
 

Protected Types

typedef multimap< DipoleIndex, Ptr< DipoleSplittingGenerator >::ptr > GeneratorMap
 

Protected Member Functions

void addCandidates (PPair particles, list< DipoleSplittingInfo > &clist) const
 Add the possible splitting candidates given a pair of emitting particles.
 
void getCandidates (list< DipoleSplittingInfo > &clist) const
 Get all possible radiating dipoles.
 
void performSplitting (DipoleSplittingInfo &) const
 Perform a splitting independent of any chains.
 
Energy nextSubleadingSplitting (Energy hardPt, Energy optHardPt, Energy optCutoff, const bool decay)
 Generate the next subleading Nc improved splitting and return the scale.
 
virtual tPPair cascade (tSubProPtr sub, XCombPtr xcomb)
 The main method which manages the showering of a subprocess.
 
tPPair cascade (tSubProPtr sub, XCombPtr xcomb, Energy optHardPt, Energy optCutoff)
 The main method which manages the showering of a subprocess.
 
void getGenerators (const DipoleIndex &, Ptr< DipoleSplittingReweight >::tptr rw=Ptr< DipoleSplittingReweight >::tptr())
 Build splitting generators for the given dipole index.
 
void hardScales (Energy2 scale)
 Setup the hard scales.
 
void hardScalesSubleading (list< DipoleSplittingInfo > candidates, Energy hardPt)
 Setup the hard scales of the dipoles after subleading emissions.
 
Ptr< DipoleEvolutionOrdering >::tptr evolutionOrdering () const
 Return the evolution ordering.
 
void constituentReshuffle ()
 Reshuffle to constituent mass shells.
 
void decayConstituentReshuffle (PerturbativeProcessPtr decayProc)
 Reshuffle to constituent mass shells.
 
GeneratorMap & generators ()
 Access the generator map.
 
DipoleEventRecordeventRecord ()
 Access the event record.
 
const DipoleEventRecordeventRecord () const
 Return the event record.
 
const vector< Ptr< DipoleSplittingKernel >::ptr > & splittingKernels () const
 Return the splitting kernels.
 
const set< long > & offShellPartons ()
 Return the set of offshell parton ids.
 
bool isMERegion (const Energy winnerScale, const DipoleSplittingInfo &winner, const list< Dipole >::iterator winnerDip)
 In a merging setup this function checks if the next shower configuration is part of the matrix element region.
 
bool realign ()
 Realign the event such as to have the incoming partons along thre beam axes.
 
virtual int showerPhaseSpaceOption () const
 The choice of z boundaries; 0 = restricted, 1 = open, 2 = mixed/other.
 
void doCascade (unsigned int &emDone, Energy optHardPt=ZERO, Energy optCutoff=ZERO, const bool decay=false)
 Perform the cascade.
 
void setNEmissions (unsigned int n)
 Set the number of emissions.
 
Energy getWinner (DipoleSplittingInfo &winner, const Dipole &dip, pair< bool, bool > conf, Energy optHardPt=ZERO, Energy optCutoff=ZERO)
 Get the winning splitting for the given dipole and configuration.
 
Energy getWinner (DipoleSplittingInfo &winner, Energy optHardPt=ZERO, Energy optCutoff=ZERO)
 Get the winning splitting for the given dipole and configuration.
 
Energy getWinner (SubleadingSplittingInfo &winner, Energy optHardPt=ZERO, Energy optCutoff=ZERO)
 Get the winning splitting for the given dipole and configuration.
 
Energy getWinner (DipoleSplittingInfo &winner, const DipoleIndex &index, double emitterX, double spectatorX, pair< bool, bool > conf, tPPtr emitter, tPPtr spectator, Energy startScale, Energy optHardPt=ZERO, Energy optCutoff=ZERO)
 Get the winning splitting for the given dipole and configuration.
 
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 Herwig::ShowerHandler
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.
 
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.
 
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.
 
- 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)
 

Friends

class Merger
 

Standard Interfaced functions.

vector< Ptr< DipoleSplittingKernel >::ptr > kernels
 The splitting kernels to be used.
 
Ptr< DipoleEvolutionOrdering >::ptr theEvolutionOrdering
 The evolution ordering considered.
 
Ptr< ConstituentReshuffler >::ptr constituentReshuffler
 The ConstituentReshuffler to be used.
 
Ptr< IntrinsicPtGenerator >::ptr intrinsicPtGenerator
 The intrinsic pt generator to be used.
 
Ptr< AlphaSBase >::ptr theGlobalAlphaS
 A global alpha_s to be used for all splitting kernels.
 
bool chainOrderVetoScales
 Apply chain ordering to events from matrix element corrections.
 
unsigned int nEmissions
 Limit the number of emissions.
 
bool discardNoEmissions
 Discard events which did not radiate.
 
bool firstMCatNLOEmission
 Perform the first MC@NLO emission only.
 
bool thePowhegDecayEmission
 True if powheg style emissions are to be used in the decays.
 
int realignmentScheme
 Switch to record information required for the nearest neighbour analysis.
 
bool doSubleadingNc
 Switch on or off subleading Nc corrections.
 
size_t subleadingNcEmissionsLimit
 Number of emissions to do subleading Nc corrections to.
 
int currentReferenceWeight
 Current reference weight used for partial unweighting of the subleading colour shower (updated each emission).
 
int densityOperatorEvolution
 Integer used to set which method of evolving the density operator to use: 0 - Vijk is Eikonal but there is a cutoff.
 
Energy2 densityOperatorCutoff
 Cutoff scale for the invariants (e.g.
 
bool doPartialUnweightingAtEmission
 Switch on or off partial unweighting in after each subleading emission.
 
bool doPartialUnweighting
 Switch on or off partial unweighting in the splitting generator.
 
double referenceWeight
 Reference weight for the partial unweighting.
 
double cmecReweightFactor
 Factor changing the acceptance probability for the veto algorithm.
 
double negCMECScaling
 Scaling factor for the negative colour matrix element corrections.
 
int verbosity
 The verbosity level.
 
int printEvent
 See verbosity.
 
GeneratorMap theGenerators
 The splitting generators indexed by the dipole indices they can work on.
 
DipoleEventRecord theEventRecord
 The evnt record used.
 
DipoleVertexRecord theVertexRecord
 The vertex record.
 
unsigned int nTries
 The number of shoer tries so far.
 
bool didRadiate
 Whether or not we did radiate anything.
 
bool didRealign
 Whether or not we did realign the event.
 
vector< vector< std::tuple< Energy, double, bool > > > theWeightsVector
 Vector of candidate splittings containing a vector of the weights, scale and a bool for every step in the reweighted veto algorithm.
 
size_t winnerIndex
 Winning candidate index.
 
size_t kernelIndex
 
size_t winningKernelIndex
 
vector< Energy > scales
 
Energy theRenormalizationScaleFreeze
 A freezing value for the renormalization scale.
 
Energy theFactorizationScaleFreeze
 A freezing value for the factorization scale.
 
Ptr< ShowerApproximation >::tptr theShowerApproximation
 The matching subtraction, if appropriate.
 
bool theDoCompensate
 True, if sampler should apply compensation.
 
unsigned long theFreezeGrid
 Return the number of accepted points after which the grid should be frozen.
 
double theDetuning
 The detuning factor applied to the sampling overestimate kernel.
 
Ptr< DipoleEventReweight >::ptr theEventReweight
 A pointer to the dipole event reweight object.
 
Ptr< DipoleSplittingReweight >::ptr theSplittingReweight
 A pointer to a global dipole splitting reweight.
 
Energy maxPt
 The shower starting scale for the last event encountered.
 
Energy muPt
 The shower hard scale for the last event encountered.
 
Ptr< MergerBase >::ptr theMergingHelper
 The merging helper takes care of merging multiple LO and NLO cross sections.
 
set< long > theColouredOffShellInShower
 PDG codes of the partons which can have an off-shell mass, this is fast storage for use during running.
 
vector< long > theInputColouredOffShellInShower
 PDG codes of the partons which can have an off-shell mass, this is a vector that is interfaced so they can be changed.
 
int theZBoundaries
 The choice of z boundaries; 0 = restricted, 1 = open, 2 = mixed/other.
 
static bool firstWarn
 True if no warnings have been issued yet.
 
static ClassDescription< DipoleShowerHandlerinitDipoleShowerHandler
 The static object used to initialize the description of this class.
 
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.
 
DipoleShowerHandleroperator= (const DipoleShowerHandler &)=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.
 
static void Init ()
 The standard Init function used to initialize the interfaces.
 

Additional Inherited Members

- Public Types inherited from Herwig::ShowerHandler
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
 
- Static Public Member Functions inherited from Herwig::ShowerHandler
static const tShowerHandlerPtr currentHandler ()
 pointer to "this", the current ShowerHandler.
 
static bool currentHandlerIsSet ()
 pointer to "this", the current ShowerHandler.
 
static void Init ()
 The standard Init function used to initialize the interfaces.
 
- 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 ()
 
- 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

The DipoleShowerHandler class manages the showering using the dipole shower algorithm.

Author
Simon Platzer, Stephen Webster
See also
The interfaces defined for DipoleShowerHandler.

Definition at line 49 of file DipoleShowerHandler.h.

Member Typedef Documentation

◆ GeneratorMap

typedef multimap<DipoleIndex,Ptr<DipoleSplittingGenerator>::ptr> Herwig::DipoleShowerHandler::GeneratorMap
protected

Definition at line 207 of file DipoleShowerHandler.h.

Member Function Documentation

◆ addSplitting()

void Herwig::DipoleShowerHandler::addSplitting ( Ptr< DipoleSplittingKernel >::ptr  sp)
inline

Insert an additional splitting kernel.

Definition at line 74 of file DipoleShowerHandler.h.

References kernels.

◆ as()

double Herwig::DipoleShowerHandler::as ( Energy  Q) const
inline

Calculate the alpha_s value the shower uses for Q.

Definition at line 114 of file DipoleShowerHandler.h.

References ThePEG::sqr(), and theGlobalAlphaS.

◆ canHandleMatchboxTrunc()

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

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

Reimplemented from Herwig::ShowerHandler.

Definition at line 95 of file DipoleShowerHandler.h.

◆ cascade()

virtual tPPair Herwig::DipoleShowerHandler::cascade ( tSubProPtr  sub,
XCombPtr  xcomb 
)
inlineprotectedvirtual

The main method which manages the showering of a subprocess.

Definition at line 212 of file DipoleShowerHandler.h.

References Herwig::ShowerHandler::cascade(), and ThePEG::ZERO.

◆ clone()

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

Make a simple clone of this object.

Returns
a pointer to the new object.

Reimplemented from Herwig::ShowerHandler.

◆ colourBasis()

Ptr< ColourBasis >::tptr Herwig::DipoleShowerHandler::colourBasis ( )
inline

Return the colour basis used in the density operator.

NOT USED, REMOVE

Definition at line 172 of file DipoleShowerHandler.h.

References Herwig::DensityOperator::colourBasis(), Herwig::DipoleEventRecord::densityOperator(), and eventRecord().

◆ continueSubleadingNc()

bool Herwig::DipoleShowerHandler::continueSubleadingNc ( ) const
inline

Return the continue subleading Nc flag from the event record.

Definition at line 179 of file DipoleShowerHandler.h.

References eventRecord(), and Herwig::DipoleEventRecord::getContinueSubleadingNc().

◆ correlatorMap()

const map< pair< vector< PDT::Colour >, pair< size_t, size_t > >, double > & Herwig::DipoleShowerHandler::correlatorMap ( ) const
inline

Return the colour matrix element correction map, will be empty if subleading Nc is turned off.

NOT USED, REMOVE

Definition at line 165 of file DipoleShowerHandler.h.

References Herwig::DensityOperator::correlatorMap(), Herwig::DipoleEventRecord::densityOperator(), and eventRecord().

◆ densityOperator()

DensityOperator & Herwig::DipoleShowerHandler::densityOperator ( )
inline

Return the density operator from the event record.

Definition at line 159 of file DipoleShowerHandler.h.

References Herwig::DipoleEventRecord::densityOperator(), and eventRecord().

◆ dofinish()

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

Finalize this object.

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

Reimplemented from Herwig::ShowerHandler.

◆ doinit()

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

◆ doinitrun()

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

Initialize this object.

Called in the run phase just before a run begins.

Reimplemented from Herwig::ShowerHandler.

◆ eventRecord() [1/2]

DipoleEventRecord & Herwig::DipoleShowerHandler::eventRecord ( )
inlineprotected

Access the event record.

Definition at line 263 of file DipoleShowerHandler.h.

References theEventRecord.

Referenced by colourBasis(), continueSubleadingNc(), correlatorMap(), densityOperator(), particleIndices(), and particlesAfter().

◆ eventRecord() [2/2]

const DipoleEventRecord & Herwig::DipoleShowerHandler::eventRecord ( ) const
inlineprotected

Return the event record.

Definition at line 268 of file DipoleShowerHandler.h.

References theEventRecord.

◆ evolutionOrdering()

Ptr< DipoleEvolutionOrdering >::tptr Herwig::DipoleShowerHandler::evolutionOrdering ( ) const
inlineprotected

Return the evolution ordering.

Definition at line 243 of file DipoleShowerHandler.h.

References theEvolutionOrdering.

◆ fullclone()

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

◆ generators()

GeneratorMap & Herwig::DipoleShowerHandler::generators ( )
inlineprotected

Access the generator map.

Definition at line 258 of file DipoleShowerHandler.h.

References theGenerators.

◆ hardScale()

virtual Energy Herwig::DipoleShowerHandler::hardScale ( ) const
inlinevirtual

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

Reimplemented from Herwig::ShowerHandler.

Definition at line 106 of file DipoleShowerHandler.h.

References muPt.

◆ hardScalesSubleading()

void Herwig::DipoleShowerHandler::hardScalesSubleading ( list< DipoleSplittingInfo candidates,
Energy  hardPt 
)
protected

Setup the hard scales of the dipoles after subleading emissions.

//debug

◆ Init()

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

◆ isReshuffling()

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

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

Reimplemented from Herwig::ShowerHandler.

Definition at line 101 of file DipoleShowerHandler.h.

◆ Nf()

double Herwig::DipoleShowerHandler::Nf ( Energy  Q) const
inline

Return the number of scale dependent active flavours from the alpha_s object.

Definition at line 121 of file DipoleShowerHandler.h.

References ThePEG::sqr(), and theGlobalAlphaS.

◆ offShellPartons()

const set< long > & Herwig::DipoleShowerHandler::offShellPartons ( )
inlineprotected

Return the set of offshell parton ids.

Definition at line 280 of file DipoleShowerHandler.h.

References theColouredOffShellInShower.

◆ operator=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ particleIndices()

const map< PPtr, size_t > & Herwig::DipoleShowerHandler::particleIndices ( ) const
inline

Return the dictionary for the incoming particles and outgoing partons in the event, will be empty if subleading Nc is turned off.

Definition at line 148 of file DipoleShowerHandler.h.

References eventRecord(), and Herwig::DipoleEventRecord::particleIndices().

◆ particlesAfter()

const cPDVector & Herwig::DipoleShowerHandler::particlesAfter ( ) const
inline

Return the particle data vector of the particles in the event, will be empty if subleading Nc is turned off.

Definition at line 154 of file DipoleShowerHandler.h.

References eventRecord(), and Herwig::DipoleEventRecord::particlesAfter().

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ setMerger()

void Herwig::DipoleShowerHandler::setMerger ( Ptr< MergerBase >::ptr  mh)
inline

Set the pointer to the Merging Helper.

Used by the merging factory.

Definition at line 138 of file DipoleShowerHandler.h.

References theMergingHelper.

◆ setNEmissions()

void Herwig::DipoleShowerHandler::setNEmissions ( unsigned int  n)
inlineprotected

Set the number of emissions.

Definition at line 315 of file DipoleShowerHandler.h.

References nEmissions.

◆ showerPhaseSpaceOption()

virtual int Herwig::DipoleShowerHandler::showerPhaseSpaceOption ( ) const
inlineprotectedvirtual

The choice of z boundaries; 0 = restricted, 1 = open, 2 = mixed/other.

Reimplemented from Herwig::ShowerHandler.

Definition at line 299 of file DipoleShowerHandler.h.

References theZBoundaries.

◆ splittingKernels()

const vector< Ptr< DipoleSplittingKernel >::ptr > & Herwig::DipoleShowerHandler::splittingKernels ( ) const
inlineprotected

Return the splitting kernels.

Definition at line 273 of file DipoleShowerHandler.h.

References kernels.

◆ vertexRecord() [1/2]

DipoleVertexRecord & Herwig::DipoleShowerHandler::vertexRecord ( )
inline

Definition at line 126 of file DipoleShowerHandler.h.

◆ vertexRecord() [2/2]

const DipoleVertexRecord & Herwig::DipoleShowerHandler::vertexRecord ( ) const
inline

Return the event record.

Definition at line 131 of file DipoleShowerHandler.h.

References theVertexRecord.

Friends And Related Function Documentation

◆ Merger

friend class Merger
friend

Definition at line 52 of file DipoleShowerHandler.h.

Member Data Documentation

◆ chainOrderVetoScales

bool Herwig::DipoleShowerHandler::chainOrderVetoScales
private

Apply chain ordering to events from matrix element corrections.

Definition at line 461 of file DipoleShowerHandler.h.

◆ cmecReweightFactor

double Herwig::DipoleShowerHandler::cmecReweightFactor
private

Factor changing the acceptance probability for the veto algorithm.

Definition at line 545 of file DipoleShowerHandler.h.

◆ constituentReshuffler

Ptr<ConstituentReshuffler>::ptr Herwig::DipoleShowerHandler::constituentReshuffler
private

The ConstituentReshuffler to be used.

Definition at line 445 of file DipoleShowerHandler.h.

◆ currentReferenceWeight

int Herwig::DipoleShowerHandler::currentReferenceWeight
private

Current reference weight used for partial unweighting of the subleading colour shower (updated each emission).

Definition at line 509 of file DipoleShowerHandler.h.

◆ densityOperatorCutoff

Energy2 Herwig::DipoleShowerHandler::densityOperatorCutoff
private

Cutoff scale for the invariants (e.g.

pEmitter*pEmission) in the Eikonal dipole kernel, Vijk.

Definition at line 525 of file DipoleShowerHandler.h.

◆ densityOperatorEvolution

int Herwig::DipoleShowerHandler::densityOperatorEvolution
private

Integer used to set which method of evolving the density operator to use: 0 - Vijk is Eikonal but there is a cutoff.

1 - Vijk is Eikonal. 2 - Vijk=1 for all i,j,k. 3 - Semi-leading Nc, Vijk=0 for all

Definition at line 519 of file DipoleShowerHandler.h.

◆ didRadiate

bool Herwig::DipoleShowerHandler::didRadiate
private

Whether or not we did radiate anything.

Definition at line 596 of file DipoleShowerHandler.h.

◆ didRealign

bool Herwig::DipoleShowerHandler::didRealign
private

Whether or not we did realign the event.

Definition at line 601 of file DipoleShowerHandler.h.

◆ discardNoEmissions

bool Herwig::DipoleShowerHandler::discardNoEmissions
private

Discard events which did not radiate.

Definition at line 472 of file DipoleShowerHandler.h.

◆ doPartialUnweighting

bool Herwig::DipoleShowerHandler::doPartialUnweighting
private

Switch on or off partial unweighting in the splitting generator.

Definition at line 535 of file DipoleShowerHandler.h.

◆ doPartialUnweightingAtEmission

bool Herwig::DipoleShowerHandler::doPartialUnweightingAtEmission
private

Switch on or off partial unweighting in after each subleading emission.

Definition at line 530 of file DipoleShowerHandler.h.

◆ doSubleadingNc

bool Herwig::DipoleShowerHandler::doSubleadingNc
private

Switch on or off subleading Nc corrections.

Definition at line 498 of file DipoleShowerHandler.h.

◆ firstMCatNLOEmission

bool Herwig::DipoleShowerHandler::firstMCatNLOEmission
private

Perform the first MC@NLO emission only.

Definition at line 477 of file DipoleShowerHandler.h.

◆ firstWarn

bool Herwig::DipoleShowerHandler::firstWarn
staticprivate

True if no warnings have been issued yet.

Definition at line 664 of file DipoleShowerHandler.h.

◆ initDipoleShowerHandler

ClassDescription<DipoleShowerHandler> Herwig::DipoleShowerHandler::initDipoleShowerHandler
staticprivate

The static object used to initialize the description of this class.

Indicates that this is a concrete class with persistent data.

Definition at line 709 of file DipoleShowerHandler.h.

◆ intrinsicPtGenerator

Ptr<IntrinsicPtGenerator>::ptr Herwig::DipoleShowerHandler::intrinsicPtGenerator
private

The intrinsic pt generator to be used.

Definition at line 450 of file DipoleShowerHandler.h.

◆ kernelIndex

size_t Herwig::DipoleShowerHandler::kernelIndex
private

Definition at line 614 of file DipoleShowerHandler.h.

◆ kernels

vector<Ptr<DipoleSplittingKernel>::ptr> Herwig::DipoleShowerHandler::kernels
private

The splitting kernels to be used.

Definition at line 435 of file DipoleShowerHandler.h.

Referenced by addSplitting(), and splittingKernels().

◆ maxPt

Energy Herwig::DipoleShowerHandler::maxPt
private

The shower starting scale for the last event encountered.

Definition at line 669 of file DipoleShowerHandler.h.

◆ muPt

Energy Herwig::DipoleShowerHandler::muPt
private

The shower hard scale for the last event encountered.

Definition at line 674 of file DipoleShowerHandler.h.

Referenced by hardScale().

◆ negCMECScaling

double Herwig::DipoleShowerHandler::negCMECScaling
private

Scaling factor for the negative colour matrix element corrections.

Definition at line 550 of file DipoleShowerHandler.h.

◆ nEmissions

unsigned int Herwig::DipoleShowerHandler::nEmissions
private

Limit the number of emissions.

Limit applied if > 0.

Definition at line 467 of file DipoleShowerHandler.h.

Referenced by setNEmissions().

◆ nTries

unsigned int Herwig::DipoleShowerHandler::nTries
private

The number of shoer tries so far.

Definition at line 591 of file DipoleShowerHandler.h.

◆ printEvent

int Herwig::DipoleShowerHandler::printEvent
private

See verbosity.

Definition at line 568 of file DipoleShowerHandler.h.

◆ realignmentScheme

int Herwig::DipoleShowerHandler::realignmentScheme
private

Switch to record information required for the nearest neighbour analysis.

The realignment scheme

Definition at line 493 of file DipoleShowerHandler.h.

◆ referenceWeight

double Herwig::DipoleShowerHandler::referenceWeight
private

Reference weight for the partial unweighting.

Definition at line 540 of file DipoleShowerHandler.h.

◆ scales

vector<Energy> Herwig::DipoleShowerHandler::scales
private

Definition at line 616 of file DipoleShowerHandler.h.

◆ subleadingNcEmissionsLimit

size_t Herwig::DipoleShowerHandler::subleadingNcEmissionsLimit
private

Number of emissions to do subleading Nc corrections to.

Definition at line 503 of file DipoleShowerHandler.h.

◆ theColouredOffShellInShower

set<long> Herwig::DipoleShowerHandler::theColouredOffShellInShower
private

PDG codes of the partons which can have an off-shell mass, this is fast storage for use during running.

Definition at line 690 of file DipoleShowerHandler.h.

Referenced by offShellPartons().

◆ theDetuning

double Herwig::DipoleShowerHandler::theDetuning
private

The detuning factor applied to the sampling overestimate kernel.

Definition at line 649 of file DipoleShowerHandler.h.

◆ theDoCompensate

bool Herwig::DipoleShowerHandler::theDoCompensate
private

True, if sampler should apply compensation.

Definition at line 638 of file DipoleShowerHandler.h.

◆ theEventRecord

DipoleEventRecord Herwig::DipoleShowerHandler::theEventRecord
private

The evnt record used.

Definition at line 581 of file DipoleShowerHandler.h.

Referenced by eventRecord().

◆ theEventReweight

Ptr<DipoleEventReweight>::ptr Herwig::DipoleShowerHandler::theEventReweight
private

A pointer to the dipole event reweight object.

Definition at line 654 of file DipoleShowerHandler.h.

◆ theEvolutionOrdering

Ptr<DipoleEvolutionOrdering>::ptr Herwig::DipoleShowerHandler::theEvolutionOrdering
private

The evolution ordering considered.

Definition at line 440 of file DipoleShowerHandler.h.

Referenced by evolutionOrdering().

◆ theFactorizationScaleFreeze

Energy Herwig::DipoleShowerHandler::theFactorizationScaleFreeze
private

A freezing value for the factorization scale.

Definition at line 628 of file DipoleShowerHandler.h.

◆ theFreezeGrid

unsigned long Herwig::DipoleShowerHandler::theFreezeGrid
private

Return the number of accepted points after which the grid should be frozen.

Definition at line 644 of file DipoleShowerHandler.h.

◆ theGenerators

GeneratorMap Herwig::DipoleShowerHandler::theGenerators
private

The splitting generators indexed by the dipole indices they can work on.

Definition at line 576 of file DipoleShowerHandler.h.

Referenced by generators().

◆ theGlobalAlphaS

Ptr<AlphaSBase>::ptr Herwig::DipoleShowerHandler::theGlobalAlphaS
private

A global alpha_s to be used for all splitting kernels.

Definition at line 455 of file DipoleShowerHandler.h.

Referenced by as(), and Nf().

◆ theInputColouredOffShellInShower

vector<long> Herwig::DipoleShowerHandler::theInputColouredOffShellInShower
private

PDG codes of the partons which can have an off-shell mass, this is a vector that is interfaced so they can be changed.

Definition at line 696 of file DipoleShowerHandler.h.

◆ theMergingHelper

Ptr<MergerBase>::ptr Herwig::DipoleShowerHandler::theMergingHelper
private

The merging helper takes care of merging multiple LO and NLO cross sections.

Here we need to check if an emission would radiate in the matrix element region of an other multipicity. If so, the emission is vetoed.

Definition at line 683 of file DipoleShowerHandler.h.

Referenced by setMerger().

◆ thePowhegDecayEmission

bool Herwig::DipoleShowerHandler::thePowhegDecayEmission
private

True if powheg style emissions are to be used in the decays.

Definition at line 482 of file DipoleShowerHandler.h.

◆ theRenormalizationScaleFreeze

Energy Herwig::DipoleShowerHandler::theRenormalizationScaleFreeze
private

A freezing value for the renormalization scale.

Definition at line 623 of file DipoleShowerHandler.h.

◆ theShowerApproximation

Ptr<ShowerApproximation>::tptr Herwig::DipoleShowerHandler::theShowerApproximation
private

The matching subtraction, if appropriate.

Definition at line 633 of file DipoleShowerHandler.h.

◆ theSplittingReweight

Ptr<DipoleSplittingReweight>::ptr Herwig::DipoleShowerHandler::theSplittingReweight
private

A pointer to a global dipole splitting reweight.

Definition at line 659 of file DipoleShowerHandler.h.

◆ theVertexRecord

DipoleVertexRecord Herwig::DipoleShowerHandler::theVertexRecord
private

The vertex record.

Definition at line 586 of file DipoleShowerHandler.h.

Referenced by vertexRecord().

◆ theWeightsVector

vector<vector<std::tuple<Energy,double,bool> > > Herwig::DipoleShowerHandler::theWeightsVector
private

Vector of candidate splittings containing a vector of the weights, scale and a bool for every step in the reweighted veto algorithm.

The bool is true for an accept step.

Definition at line 608 of file DipoleShowerHandler.h.

◆ theZBoundaries

int Herwig::DipoleShowerHandler::theZBoundaries
private

The choice of z boundaries; 0 = restricted, 1 = open, 2 = mixed/other.

Definition at line 701 of file DipoleShowerHandler.h.

Referenced by showerPhaseSpaceOption().

◆ verbosity

int Herwig::DipoleShowerHandler::verbosity
private

The verbosity level.

0 - print no info 1 - print diagnostic information on setting up splitting generators etc. 2 - print detailed event information for up to printEvent events. 3 - print dipole chains after each splitting.

Definition at line 563 of file DipoleShowerHandler.h.

◆ winnerIndex

size_t Herwig::DipoleShowerHandler::winnerIndex
private

Winning candidate index.

Definition at line 613 of file DipoleShowerHandler.h.

◆ winningKernelIndex

size_t Herwig::DipoleShowerHandler::winningKernelIndex
private

Definition at line 615 of file DipoleShowerHandler.h.


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