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

MEMatching implements NLO matching with matrix element correction (aka Powheg). More...

#include <MEMatching.h>

Inheritance diagram for Herwig::MEMatching:

Public Member Functions

 MEMatching ()
 The default constructor.
 
virtual bool needsSplittingGenerator () const
 Return true, if this shower approximation will require a splitting generator.
 
virtual bool hasHEvents () const
 Return true, if this shower approximation will require H events.
 
virtual bool needsTruncatedShower () const
 Return true, if this shower approximation will require a truncated parton shower.
 
virtual CrossSection dSigHatDR () const
 Return the shower approximation to the real emission cross section for the given pair of Born and real emission configurations.
 
virtual double me2 () const
 Return the shower approximation splitting kernel for the given pair of Born and real emission configurations in units of the Born center of mass energy squared, and including a weight to project onto the splitting given by the dipole used.
 
- Public Member Functions inherited from Herwig::ShowerApproximation
 ShowerApproximation ()
 The default constructor.
 
virtual bool needsSplittingGenerator () const
 Return true, if this shower approximation will require a splitting generator.
 
virtual bool hasHEvents () const
 Return true, if this shower approximation will require H events.
 
virtual bool needsTildeXCombs () const
 Return true, if this shower approximation will require tilde XCombs for the real phase space point generated.
 
virtual bool needsTruncatedShower () const
 Return true, if this shower approximation will require a truncated parton shower.
 
virtual Ptr< TildeKinematics >::tptr showerTildeKinematics () const
 Return the tilde kinematics object returning the shower kinematics parametrization if different from the nominal dipole mappings.
 
virtual Ptr< InvertedTildeKinematics >::tptr showerInvertedTildeKinematics () const
 Return the tilde kinematics object returning the shower kinematics parametrization if different from the nominal dipole mappings.
 
void setBornXComb (tStdXCombPtr xc)
 Set the XComb object describing the Born process.
 
tStdXCombPtr bornXComb () const
 Return the XComb object describing the Born process.
 
tcStdXCombPtr bornCXComb () const
 Return the XComb object describing the Born process.
 
void setRealXComb (tStdXCombPtr xc)
 Set the XComb object describing the real emission process.
 
tStdXCombPtr realXComb () const
 Return the XComb object describing the real emission process.
 
tcStdXCombPtr realCXComb () const
 Return the XComb object describing the real emission process.
 
void setTildeXCombs (const vector< StdXCombPtr > &xc)
 Set the tilde xcomb objects associated to the real xcomb.
 
const vector< StdXCombPtr > & tildeXCombs () const
 Return the tilde xcomb objects associated to the real xcomb.
 
void setDipole (Ptr< SubtractionDipole >::tptr)
 Set the dipole in charge for the emission.
 
Ptr< SubtractionDipole >::tptr dipole () const
 Return the dipole in charge for the emission.
 
virtual bool hasSpinCorrelations () const
 Return true, if this matching is capable of spin correlations.
 
bool belowCutoff () const
 Return true if one of the recently encountered configutations was below the infrared cutoff.
 
void wasBelowCutoff ()
 Indicate that one of the recently encountered configutations was below the infrared cutoff.
 
void resetBelowCutoff ()
 Reset the below cutoff flag.
 
Energy ffPtCut () const
 Return the pt cut to be applied for final-final dipoles.
 
Energy fiPtCut () const
 Return the pt cut to be applied for final-initial dipoles.
 
Energy iiPtCut () const
 Return the pt cut to be applied for initial-initial dipoles.
 
Energy safeCut () const
 Return the pt cut to be applied for initial-initial dipoles.
 
Energy ffScreeningScale () const
 Return the screening scale to be applied for final-final dipoles.
 
Energy fiScreeningScale () const
 Return the screening scale to be applied for final-initial dipoles.
 
Energy iiScreeningScale () const
 Return the screening scale to be applied for initial-initial dipoles.
 
virtual Energy2 showerEmissionScale () const
 Return the shower renormalization scale.
 
Energy2 showerRenormalizationScale () const
 Return the shower renormalization scale.
 
Energy2 showerFactorizationScale () const
 Return the shower factorization scale.
 
Energy2 bornRenormalizationScale () const
 Return the Born renormalization scale.
 
Energy2 bornFactorizationScale () const
 Return the Born factorization scale.
 
Energy2 realRenormalizationScale () const
 Return the real emission renormalization scale.
 
Energy2 realFactorizationScale () const
 Return the real emission factorization scale.
 
int realEmissionScaleInSubtraction () const
 Return the scale choice in the real emission cross section to be used in the matching subtraction.
 
int bornScaleInSubtraction () const
 Return the scale choice in the born cross section to be used in the matching subtraction.
 
int emissionScaleInSubtraction () const
 Return the scale choice in the emission contribution to be used in the matching subtraction.
 
int realEmissionScaleInSplitting () const
 Return the scale choice in the real emission cross section to be used in the splitting.
 
int bornScaleInSplitting () const
 Return the scale choice in the born cross section to be used in the splitting.
 
int emissionScaleInSplitting () const
 Return the scale choice in the emission contribution to be used in the splitting.
 
double scaleWeight (int rScale, int bScale, int eScale) const
 Return the scale weight.
 
double subtractionScaleWeight () const
 Return the scale weight for the matching subtraction.
 
double splittingScaleWeight () const
 Return the scale weight for the splitting.
 
bool restrictPhasespace () const
 Return true, if the phase space restrictions of the dipole shower should be applied.
 
void restrictPhasespace (bool yes)
 Indicate that the phase space restrictions of the dipole shower should be applied.
 
Ptr< HardScaleProfile >::tptr profileScales () const
 Return profile scales.
 
void profileScales (Ptr< HardScaleProfile >::ptr prof)
 Set profile scales.
 
bool hardScaleIsMuF () const
 Return true if maximum pt should be deduced from the factorization scale.
 
void hardScaleIsMuF (bool yes)
 Indicate that maximum pt should be deduced from the factorization scale.
 
double hardScaleFactor () const
 Return the scale factor for the hard scale.
 
void hardScaleFactor (double f)
 Set the scale factor for the hard scale.
 
double factorizationScaleFactor () const
 Get the factorization scale factor.
 
double renormalizationScaleFactor () const
 Get the renormalization scale factor.
 
void factorizationScaleFactor (double f)
 Set the factorization scale factor.
 
void renormalizationScaleFactor (double f)
 Set the renormalization scale factor.
 
virtual void checkCutoff ()
 Determine if the configuration is below or above the cutoff.
 
virtual void getShowerVariables ()
 Determine all kinematic variables which are not provided by the dipole kinematics; store all shower variables in the respective dipole object for later use.
 
virtual CrossSection dSigHatDR () const =0
 Return the shower approximation to the real emission cross section for the given pair of Born and real emission configurations.
 
virtual double me2 () const =0
 Return the shower approximation splitting kernel for the given pair of Born and real emission configurations in units of the Born center of mass energy squared, and including a weight to project onto the splitting given by the dipole used.
 
double bornPDFWeight (Energy2 muF) const
 Return the Born PDF weight.
 
double realPDFWeight (Energy2 muF) const
 Return the real emission PDF weight.
 
virtual double channelWeight (int emitter, int emission, int spectator, int bemitter) const
 Generate a weight for the given dipole channel.
 
virtual double channelWeight () const
 Generate a normalized weight taking into account all channels.
 
Ptr< ColourBasis >::tptr largeNBasis () const
 A large-N colour basis to be used when reproducing the shower kernels.
 
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.
 
- 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
 

Clone Methods.

bool theTruncatedShower
 True, if a truncated parton shower should be generated.
 
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.
 
MEMatchingoperator= (const MEMatching &)=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::ShowerApproximation
enum  ScaleChoices { bornScale = 0 , realScale = 1 , showerScale = 2 }
 Enumerate possible scale choices. More...
 
- Public Types inherited from ThePEG::InterfacedBase
enum  InitState
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 
- Static Public Member Functions inherited from Herwig::ShowerApproximation
static void Init ()
 The standard Init function used to initialize the interfaces.
 
- 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
 
- Protected Member Functions inherited from Herwig::ShowerApproximation
virtual bool isInShowerPhasespace () const
 Return true, if the shower was able to generate an emission leading from the given Born to the given real emission process.
 
virtual bool isAboveCutoff () const
 Return true, if the shower emission leading from the given Born to the given real emission process would have been generated above the shower's infrared cutoff.
 
virtual Energy hardScale () const
 Return the relevant hard scale.
 
void useOpenZ (bool yes)
 Use the maximum available phase space for the momentum fraction.
 
bool openZ () const
 Return true if the maximum available phase space should be used for the momentum fraction.
 
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk.
 
void setLargeNBasis ()
 Set the large-N basis.
 
- 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)
 
- Static Protected Member Functions inherited from ThePEG::Interfaced
static void registerRepository (IBPtr)
 
static void registerRepository (IBPtr, string newName)
 
- Protected Attributes inherited from Herwig::ShowerApproximation
Ptr< ColourBasis >::ptr theLargeNBasis
 A large-N colour basis to be used when reproducing the shower kernels.
 
double theExtrapolationX
 The x value from which on we extrapolate PDFs for numerically stable ratios.
 

Detailed Description

MEMatching implements NLO matching with matrix element correction (aka Powheg).

Author
Simon Platzer

Definition at line 28 of file MEMatching.h.

Member Function Documentation

◆ clone()

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

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ dSigHatDR()

virtual CrossSection Herwig::MEMatching::dSigHatDR ( ) const
virtual

Return the shower approximation to the real emission cross section for the given pair of Born and real emission configurations.

Implements Herwig::ShowerApproximation.

◆ fullclone()

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

◆ hasHEvents()

virtual bool Herwig::MEMatching::hasHEvents ( ) const
inlinevirtual

Return true, if this shower approximation will require H events.

Reimplemented from Herwig::ShowerApproximation.

Definition at line 49 of file MEMatching.h.

References Herwig::ShowerApproximation::profileScales(), and Herwig::ShowerApproximation::restrictPhasespace().

◆ Init()

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

◆ me2()

virtual double Herwig::MEMatching::me2 ( ) const
virtual

Return the shower approximation splitting kernel for the given pair of Born and real emission configurations in units of the Born center of mass energy squared, and including a weight to project onto the splitting given by the dipole used.

Implements Herwig::ShowerApproximation.

◆ needsSplittingGenerator()

virtual bool Herwig::MEMatching::needsSplittingGenerator ( ) const
inlinevirtual

Return true, if this shower approximation will require a splitting generator.

Reimplemented from Herwig::ShowerApproximation.

Definition at line 43 of file MEMatching.h.

◆ needsTruncatedShower()

virtual bool Herwig::MEMatching::needsTruncatedShower ( ) const
inlinevirtual

Return true, if this shower approximation will require a truncated parton shower.

Reimplemented from Herwig::ShowerApproximation.

Definition at line 55 of file MEMatching.h.

References theTruncatedShower.

◆ operator=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

Member Data Documentation

◆ theTruncatedShower

bool Herwig::MEMatching::theTruncatedShower
private

True, if a truncated parton shower should be generated.

Definition at line 133 of file MEMatching.h.

Referenced by needsTruncatedShower().


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