herwig is hosted by Hepforge, IPPP Durham
Herwig  7.2.1
Herwig::DipoleSplittingKinematics Class Referenceabstract

DipoleSplittingKinematics is the base class for dipole splittings as performed in the dipole shower. More...

#include <DipoleSplittingKinematics.h>

Inheritance diagram for Herwig::DipoleSplittingKinematics:

Public Types

enum  ZSamplingOptions { FlatZ = 0, OneOverZ, OneOverOneMinusZ, OneOverZOneMinusZ }
 Enumerate the variants of sampling z.
 
- Public Types inherited from ThePEG::InterfacedBase
enum  InitState
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 

Public Member Functions

virtual pair< double, double > kappaSupport (const DipoleSplittingInfo &) const
 Return the boundaries in between the evolution variable random number is to be sampled; the lower cuoff is assumed to correspond to the infrared cutoff.
 
virtual pair< double, double > xiSupport (const DipoleSplittingInfo &) const
 Return the boundaries in between the momentum fraction random number is to be sampled.
 
virtual Energy dipoleScale (const Lorentz5Momentum &pEmitter, const Lorentz5Momentum &pSpectator) const
 Return the dipole scale associated to the given pair of emitter and spectator. More...
 
virtual Energy recoilMassKin (const Lorentz5Momentum &, const Lorentz5Momentum &pSpectator) const
 Return the mass of the system absorbing the recoil in the dipole splitting. More...
 
virtual Energy ptMax (Energy dScale, double emX, double specX, const DipoleIndex &dIndex, const DipoleSplittingKernel &split) const =0
 Return the maximum pt for the given dipole scale.
 
virtual Energy ptMax (Energy dScale, double emX, double specX, const DipoleSplittingInfo &dInfo, const DipoleSplittingKernel &split) const
 Return the maximum pt for the given dipole scale.
 
virtual Energy ptMax (Energy dScale, double emX, double specX, const DipoleIndex &dIndex, const DipoleSplittingKernel &split, tPPtr emitter, tPPtr spectator) const
 Return the maximum pt for the given dipole scale.
 
virtual Energy QMax (Energy dScale, double emX, double specX, const DipoleIndex &dIndex, const DipoleSplittingKernel &split) const =0
 Return the maximum virtuality for the given dipole scale.
 
virtual Energy QMax (Energy dScale, double emX, double specX, const DipoleSplittingInfo &dInfo, const DipoleSplittingKernel &split) const
 Return the maximum virtuality for the given dipole scale.
 
virtual Energy QMax (Energy dScale, double emX, double specX, const DipoleIndex &dIndex, const DipoleSplittingKernel &split, tPPtr emitter, tPPtr spectator) const
 Return the maximum virtuality for the given dipole scale.
 
virtual Energy PtFromQ (Energy scale, const DipoleSplittingInfo &) const =0
 Return the pt given a virtuality.
 
virtual Energy QFromPt (Energy scale, const DipoleSplittingInfo &) const =0
 Return the virtuality given a pt.
 
virtual Energy IRCutoff () const
 Return the infrared cutoff.
 
double xMin () const
 Return the minimum momentum fraction for incoming partons.
 
Energy generatePt (double r, Energy dScale, double emX, double specX, const DipoleIndex &dIndex, const DipoleSplittingKernel &split, double &weight) const
 Generate a pt.
 
virtual double ptToRandom (Energy pt, Energy dScale, double emX, double specX, const DipoleIndex &dIndex, const DipoleSplittingKernel &split) const
 Return the random number associated to the given pt.
 
virtual pair< double, double > zBoundaries (Energy pt, const DipoleSplittingInfo &dInfo, const DipoleSplittingKernel &split) const =0
 Return the boundaries on the momentum fraction.
 
double generateZ (double r, Energy pt, int sampling, const DipoleSplittingInfo &dInfo, const DipoleSplittingKernel &split, double &weight) const
 Generate a z value flat.
 
virtual bool generateSplitting (double kappa, double xi, double phi, DipoleSplittingInfo &info, const DipoleSplittingKernel &)=0
 Generate splitting variables given three random numbers and the momentum fractions of the emitter and spectator. More...
 
double jacobian () const
 Get the splitting phasespace weight associated to the last call to generateSplitting. More...
 
virtual bool haveOverestimate () const
 Return true, if this splitting kinematics class is capable of delivering an overestimate to the jacobian.
 
virtual double jacobianOverestimate () const
 Return the overestimated jacobian for the last generated parameters.
 
Energy lastPt () const
 Return the last generated pt.
 
double lastZ () const
 Return the last generated momentum fraction.
 
double lastPhi () const
 Return the last calculated zPrime for massive FF and decay dipoles. More...
 
double lastEmitterZ () const
 Return the momentum fraction, by which the emitter's momentum fraction should be divided after the splitting.
 
double lastSpectatorZ () const
 Return the momentum fraction, by which the spectator's momentum fraction should be divided after the splitting.
 
const vector< double > & lastSplittingParameters () const
 Return any additional parameters needed to evaluate the splitting kernel or to generate the full splitting.
 
void prepareSplitting (DipoleSplittingInfo &dInfo)
 Complete a DipoleSplittingInfo object with the parameters generated by the last call to generateSplitting()
 
virtual void generateKinematics (const Lorentz5Momentum &pEmitter, const Lorentz5Momentum &pSpectator, const DipoleSplittingInfo &dInfo)=0
 Generate the full kinematics given emitter and spectator momentum and a previously completeted DipoleSplittingInfo object.
 
const Lorentz5Momentum & lastEmitterMomentum () const
 Return the emitter's momentum after the splitting.
 
const Lorentz5Momentum & lastSpectatorMomentum () const
 Return the spectator's momentum after the splitting.
 
const Lorentz5Momentum & lastEmissionMomentum () const
 Return the emission's momentum.
 
virtual bool doesTransform () const
 
virtual void setTransformation ()
 Calculate and store a required Lorentz transformation.
 
int openZBoundaries () const
 
virtual void transform (PPtr &)
 
virtual bool isDecay () const
 SW 30/01/2019: Test feature only, not for release. More...
 
virtual void decayRecoil (PList &)
 Perform the recoil in the case of a decayed parton. More...
 
virtual Lorentz5Momentum pVector (const Lorentz5Momentum &pEmitter, const Lorentz5Momentum &, const DipoleSplittingInfo &) const
 Return the pVector, required for spin correlations.
 
virtual Lorentz5Momentum nVector (const Lorentz5Momentum &, const Lorentz5Momentum &pSpectator, const DipoleSplittingInfo &) const
 Return the nVector, required for spin correlations.
 
Standard constructors and destructors.
 DipoleSplittingKinematics ()
 The default constructor.
 
virtual ~DipoleSplittingKinematics ()
 The destructor.
 
Functions used by the persistent I/O system.
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- Public Member Functions inherited from 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 StandardModelBase & SM () 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
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
- Public Member Functions inherited from ThePEG::InterfacedBase
string fullName () const
 
string name () const
 
string path () const
 
string comment () const
 
void setup (istream &is)
 
virtual IBPtr fullclone () const
 
virtual void debugme () const
 
void update ()
 
void init ()
 
virtual bool preInitialize () const
 
void initrun ()
 
void finish ()
 
void touch ()
 
void reset ()
 
void clear ()
 
InitState state () const
 
bool locked () const
 
bool touched () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
void update ()
 
void init ()
 
virtual bool preInitialize () const
 
void initrun ()
 
void finish ()
 
void touch ()
 
void reset ()
 
void clear ()
 
InitState state () const
 
bool locked () const
 
bool touched () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
- Public Member Functions inherited from ThePEG::Base
void debug () const
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 
 Named (const Named &)=default
 
const string & name () const
 
bool operator== (const Named &other) const
 
bool operator< (const Named &other) const
 

Static Public Member Functions

static void Init ()
 The standard Init function used to initialize the interfaces. More...
 
- Static Public Member Functions inherited from ThePEG::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

Lorentz5Momentum getKt (const Lorentz5Momentum &p1, const Lorentz5Momentum &p2, Energy pt, double phi, bool spacelike=false) const
 Calculate a transverse momentum for the given momenta, invariant pt and azimuth.
 
void jacobian (double w)
 Set the splitting phasespace weight associated to the last call to generateSplitting. More...
 
void lastPt (Energy p)
 Set the last generated pt.
 
void lastZ (double z)
 Set the last generated momentum fraction.
 
void lastPhi (double p)
 Set the last calculated zPrime for massive FF and decay dipoles. More...
 
void lastEmitterZ (double z)
 Set the momentum fraction, by which the emitter's momentum fraction should be divided after the splitting.
 
void lastSpectatorZ (double z)
 Set the momentum fraction, by which the spectator's momentum fraction should be divided after the splitting.
 
vector< double > & splittingParameters ()
 Access any additional parameters needed to evaluate the splitting kernel or to generate the full splitting.
 
void emitterMomentum (const Lorentz5Momentum &p)
 Set the emitter's momentum after the splitting.
 
void spectatorMomentum (const Lorentz5Momentum &p)
 Set the spectator's momentum after the splitting.
 
void emissionMomentum (const Lorentz5Momentum &p)
 Set the emission's momentum.
 
void splitRecoilMomentum (const Lorentz5Momentum &mom)
 Set the momentum of the recoil system after the splitting.
 
const Lorentz5Momentum & splitRecoilMomentum () const
 Return the momentum of the recoil system after splitting.
 
- Protected Member Functions inherited from ThePEG::Interfaced
void reporeg (IBPtr object, string name) const
 
bool setDefaultReference (PtrT &ptr, string classname, string objectname)
 
 Interfaced (const string &newName)
 
 Interfaced (const Interfaced &i)
 
void setGenerator (tEGPtr generator)
 
- Protected Member Functions inherited from ThePEG::InterfacedBase
virtual IBPtr clone () const=0
 
 InterfacedBase (string newName)
 
 InterfacedBase (const InterfacedBase &i)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinit ()
 
virtual void doinitrun ()
 
virtual void dofinish ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinit ()
 
virtual void doinitrun ()
 
virtual void dofinish ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (const Named &other)
 
const string & name (const string &newName)
 

Protected Attributes

Ptr< DipoleMCCheck >::ptr theMCCheck
 Pointer to a check histogram object.
 

Private Member Functions

DipoleSplittingKinematicsoperator= (const DipoleSplittingKinematics &)=delete
 The assignment operator is private and must never be called. More...
 

Private Attributes

Energy theIRCutoff
 The infrared cutoff associated to this splitting kinematics.
 
double theXMin
 The minimum momentum fraction for incoming partons.
 
double theJacobian
 The last calculated splitting phase space weight.
 
Energy theLastPt
 The last generated pt.
 
double theLastZ
 The last generated momentum fraction.
 
double theLastPhi
 The last calculated zPrime required for massive FF and decay kinematics dipoles. More...
 
double theLastEmitterZ
 The momentum fraction, by which the emitter's momentum fraction should be divided after the splitting.
 
double theLastSpectatorZ
 The momentum fraction, by which the spectator's momentum fraction should be divided after the splitting.
 
vector< double > theLastSplittingParameters
 Any additional parameters needed to evaluate the splitting kernel or to generate the full splitting.
 
Lorentz5Momentum theEmitterMomentum
 The emitter's momentum after the splitting.
 
Lorentz5Momentum theEmissionMomentum
 The emission's momentum after the splitting.
 
Lorentz5Momentum theSpectatorMomentum
 The spectator's momentum after the splitting.
 
Lorentz5Momentum theSplitRecoilMomentum
 The momentum of the recoil system after the splitting, used in decay dipole kinematics.
 
int theOpenZBoundaries
 

Static Private Attributes

static AbstractClassDescription< DipoleSplittingKinematicsinitDipoleSplittingKinematics
 The static object used to initialize the description of this class. More...
 

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)
 

Detailed Description

DipoleSplittingKinematics is the base class for dipole splittings as performed in the dipole shower.

Author
Simon Platzer
See also
The interfaces defined for DipoleSplittingKinematics.

Definition at line 41 of file DipoleSplittingKinematics.h.

Member Function Documentation

◆ decayRecoil()

virtual void Herwig::DipoleSplittingKinematics::decayRecoil ( PList )
inlinevirtual

Perform the recoil in the case of a decayed parton.

Perform the recoil in the case of a decayed parton

Reimplemented in Herwig::FIMassiveDecayKinematics, and Herwig::IFMassiveDecayKinematics.

Definition at line 385 of file DipoleSplittingKinematics.h.

◆ dipoleScale()

virtual Energy Herwig::DipoleSplittingKinematics::dipoleScale ( const Lorentz5Momentum &  pEmitter,
const Lorentz5Momentum &  pSpectator 
) const
inlinevirtual

Return the dipole scale associated to the given pair of emitter and spectator.

This should be the invariant mass or absolute value final/final or initial/initial and the absolute value of the momentum transfer for intial/final or final/initial dipoles.

Reimplemented in Herwig::FIMassiveDecayKinematics, Herwig::IFMassiveDecayKinematics, Herwig::IFMassiveKinematics, Herwig::FFMassiveKinematics, and Herwig::FIMassiveKinematics.

Definition at line 85 of file DipoleSplittingKinematics.h.

References sqrt(), and ZERO.

◆ generateSplitting()

virtual bool Herwig::DipoleSplittingKinematics::generateSplitting ( double  kappa,
double  xi,
double  phi,
DipoleSplittingInfo info,
const DipoleSplittingKernel  
)
pure virtual

Generate splitting variables given three random numbers and the momentum fractions of the emitter and spectator.

Return true on success.

Implemented in Herwig::FIMassiveDecayKinematics, Herwig::IFMassiveKinematics, Herwig::FFMassiveKinematics, Herwig::FIMassiveKinematics, Herwig::IFMassiveDecayKinematics, Herwig::IFLightKinematics, Herwig::IILightKinematics, Herwig::FFLightKinematics, and Herwig::FILightKinematics.

◆ Init()

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

◆ isDecay()

virtual bool Herwig::DipoleSplittingKinematics::isDecay ( ) const
inlinevirtual

SW 30/01/2019: Test feature only, not for release.

In II case use colourless particles only to absorb recoil SW 30/01/2019: Used in DipoleEventRecord to prepare for transformHard, test feature only, not for release. Add to splitRecoilMomentum for transformation

Reimplemented in Herwig::FIMassiveDecayKinematics, and Herwig::IFMassiveDecayKinematics.

Definition at line 375 of file DipoleSplittingKinematics.h.

◆ jacobian() [1/2]

double Herwig::DipoleSplittingKinematics::jacobian ( ) const
inline

Get the splitting phasespace weight associated to the last call to generateSplitting.

This is taken to be the single particle phasespace times 16 ^2 divided by the relevant propagator invariant.

Definition at line 234 of file DipoleSplittingKinematics.h.

◆ jacobian() [2/2]

void Herwig::DipoleSplittingKinematics::jacobian ( double  w)
inlineprotected

Set the splitting phasespace weight associated to the last call to generateSplitting.

This is taken to be the single particle phasespace times 16 ^2 divided by the relevant propagator invariant.

Definition at line 425 of file DipoleSplittingKinematics.h.

◆ lastPhi() [1/2]

double Herwig::DipoleSplittingKinematics::lastPhi ( ) const
inline

Return the last calculated zPrime for massive FF and decay dipoles.

Return the last generated azimuthal angle.

Definition at line 270 of file DipoleSplittingKinematics.h.

◆ lastPhi() [2/2]

void Herwig::DipoleSplittingKinematics::lastPhi ( double  p)
inlineprotected

Set the last calculated zPrime for massive FF and decay dipoles.

Set the last generated azimuthal angle.

Definition at line 447 of file DipoleSplittingKinematics.h.

◆ operator=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ recoilMassKin()

virtual Energy Herwig::DipoleSplittingKinematics::recoilMassKin ( const Lorentz5Momentum &  ,
const Lorentz5Momentum &  pSpectator 
) const
inlinevirtual

Return the mass of the system absorbing the recoil in the dipole splitting.

This is overloaded in the decay dipoles.

Reimplemented in Herwig::FIMassiveDecayKinematics, and Herwig::IFMassiveDecayKinematics.

Definition at line 98 of file DipoleSplittingKinematics.h.

Member Data Documentation

◆ initDipoleSplittingKinematics

AbstractClassDescription<DipoleSplittingKinematics> Herwig::DipoleSplittingKinematics::initDipoleSplittingKinematics
staticprivate

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

Indicates that this is an abstract class.

Definition at line 625 of file DipoleSplittingKinematics.h.

◆ theLastPhi

double Herwig::DipoleSplittingKinematics::theLastPhi
private

The last calculated zPrime required for massive FF and decay kinematics dipoles.

zPrime := qi.nk / (qi+qj).nk (qj = emission momentum) The last generated azimuthal angle.

Definition at line 566 of file DipoleSplittingKinematics.h.


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