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

IILightKinematics implements massless splittings off an initial-initial dipole. More...

#include <IILightKinematics.h>

Inheritance diagram for Herwig::IILightKinematics:

Public Member Functions

 IILightKinematics ()
 The default constructor.
 
virtual Energy ptMax (Energy dScale, double emX, double specX, const DipoleIndex &, const DipoleSplittingKernel &) const
 Return the maximum pt for the given dipole scale.
 
virtual Energy QMax (Energy dScale, double emX, double specX, const DipoleIndex &dIndex, const DipoleSplittingKernel &) const
 Return the maximum virtuality for the given dipole scale.
 
virtual Energy PtFromQ (Energy scale, const DipoleSplittingInfo &) const
 Return the pt given a virtuality.
 
virtual Energy QFromPt (Energy scale, const DipoleSplittingInfo &) const
 Return the virtuality given a pt.
 
virtual pair< double, double > zBoundaries (Energy pt, const DipoleSplittingInfo &dInfo, const DipoleSplittingKernel &split) const
 Return the boundaries on the momentum fraction.
 
virtual bool generateSplitting (double kappa, double xi, double phi, DipoleSplittingInfo &dIndex, const DipoleSplittingKernel &)
 Generate splitting variables given three random numbers and the momentum fractions of the emitter and spectator.
 
virtual void generateKinematics (const Lorentz5Momentum &pEmitter, const Lorentz5Momentum &pSpectator, const DipoleSplittingInfo &dInfo)
 Generate the full kinematics given emitter and spectator momentum and a previously completeted DipoleSplittingInfo object.
 
virtual bool doesTransform () const
 Return true, if there is a transformation which should be applied to all other final state particles except the ones involved in the splitting after having performed the splitting.
 
virtual void setTransformation ()
 Calculate and store a required Lorentz transformation.
 
virtual void transform (PPtr &part)
 
- Public Member Functions inherited from Herwig::DipoleSplittingKinematics
 DipoleSplittingKinematics ()
 The default constructor.
 
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.
 
virtual Energy recoilMassKin (const Lorentz5Momentum &, const Lorentz5Momentum &pSpectator) const
 Return the mass of the system absorbing the recoil in the dipole splitting.
 
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.
 
double jacobian () const
 Get the splitting phasespace weight associated to the last call to generateSplitting.
 
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.
 
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.
 
virtual void decayRecoil (PList &)
 Perform the recoil in the case of a decayed parton.
 
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.
 
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.

static ClassDescription< IILightKinematicsinitIILightKinematics
 The static object used to initialize the description of this class.
 
bool theCollinearScheme
 Wether or not to choose the ‘collinear’ scheme.
 
bool didCollinear
 
Lorentz5Momentum K
 SW 30/01/2019: Test feature only, not for release.
 
Energy2 K2
 
Lorentz5Momentum Ktilde
 
Lorentz5Momentum KplusKtilde
 
Energy2 KplusKtilde2
 
LorentzRotation theRecoilTransformation
 Store the LorentzRotation object equivalent to the transformation applied to the outgoing particles.
 
bool theTransformationCalculated
 Bool to avoid unecessary recalculation of the Lorentz transformation.
 
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.
 
IILightKinematicsoperator= (const IILightKinematics &)=delete
 The assignment operator is private and must never be called.
 

Functions used by the persistent I/O system.

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

Perform the recoil in the case of a decayed parton

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::DipoleSplittingKinematics
enum  ZSamplingOptions { FlatZ = 0 , OneOverZ , OneOverOneMinusZ , OneOverZOneMinusZ }
 Enumerate the variants of sampling z. 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::DipoleSplittingKinematics
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::DipoleSplittingKinematics
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.
 
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.
 
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 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::DipoleSplittingKinematics
Ptr< DipoleMCCheck >::ptr theMCCheck
 Pointer to a check histogram object.
 

Detailed Description

IILightKinematics implements massless splittings off an initial-initial dipole.

Author
Simon Platzer
See also
The interfaces defined for IILightKinematics.

Definition at line 31 of file IILightKinematics.h.

Member Function Documentation

◆ clone()

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

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

◆ doesTransform()

virtual bool Herwig::IILightKinematics::doesTransform ( ) const
inlinevirtual

Return true, if there is a transformation which should be applied to all other final state particles except the ones involved in the splitting after having performed the splitting.

Reimplemented from Herwig::DipoleSplittingKinematics.

Definition at line 98 of file IILightKinematics.h.

References theCollinearScheme.

◆ fullclone()

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

◆ generateKinematics()

virtual void Herwig::IILightKinematics::generateKinematics ( const Lorentz5Momentum &  pEmitter,
const Lorentz5Momentum &  pSpectator,
const DipoleSplittingInfo dInfo 
)
virtual

Generate the full kinematics given emitter and spectator momentum and a previously completeted DipoleSplittingInfo object.

Implements Herwig::DipoleSplittingKinematics.

◆ generateSplitting()

virtual bool Herwig::IILightKinematics::generateSplitting ( double  kappa,
double  xi,
double  phi,
DipoleSplittingInfo dIndex,
const DipoleSplittingKernel  
)
virtual

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

Return true on success.

Implements Herwig::DipoleSplittingKinematics.

◆ Init()

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

◆ operator=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ PtFromQ()

virtual Energy Herwig::IILightKinematics::PtFromQ ( Energy  scale,
const DipoleSplittingInfo  
) const
virtual

Return the pt given a virtuality.

Implements Herwig::DipoleSplittingKinematics.

◆ ptMax()

virtual Energy Herwig::IILightKinematics::ptMax ( Energy  dScale,
double  emX,
double  specX,
const DipoleIndex ,
const DipoleSplittingKernel  
) const
virtual

Return the maximum pt for the given dipole scale.

Implements Herwig::DipoleSplittingKinematics.

◆ QFromPt()

virtual Energy Herwig::IILightKinematics::QFromPt ( Energy  scale,
const DipoleSplittingInfo  
) const
virtual

Return the virtuality given a pt.

Implements Herwig::DipoleSplittingKinematics.

◆ QMax()

virtual Energy Herwig::IILightKinematics::QMax ( Energy  dScale,
double  emX,
double  specX,
const DipoleIndex dIndex,
const DipoleSplittingKernel  
) const
virtual

Return the maximum virtuality for the given dipole scale.

Implements Herwig::DipoleSplittingKinematics.

◆ setTransformation()

virtual void Herwig::IILightKinematics::setTransformation ( )
virtual

Calculate and store a required Lorentz transformation.

Reimplemented from Herwig::DipoleSplittingKinematics.

◆ transform()

virtual void Herwig::IILightKinematics::transform ( PPtr part)
inlinevirtual

Reimplemented from Herwig::DipoleSplittingKinematics.

Definition at line 108 of file IILightKinematics.h.

◆ zBoundaries()

virtual pair< double, double > Herwig::IILightKinematics::zBoundaries ( Energy  pt,
const DipoleSplittingInfo dInfo,
const DipoleSplittingKernel split 
) const
virtual

Return the boundaries on the momentum fraction.

Implements Herwig::DipoleSplittingKinematics.

Member Data Documentation

◆ didCollinear

bool Herwig::IILightKinematics::didCollinear
private

Definition at line 220 of file IILightKinematics.h.

◆ initIILightKinematics

ClassDescription<IILightKinematics> Herwig::IILightKinematics::initIILightKinematics
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 205 of file IILightKinematics.h.

◆ K

Lorentz5Momentum Herwig::IILightKinematics::K
private

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

Whether to transform only hard (i.e. non-coloured) particles.

Definition at line 228 of file IILightKinematics.h.

◆ K2

Energy2 Herwig::IILightKinematics::K2
private

Definition at line 229 of file IILightKinematics.h.

◆ KplusKtilde

Lorentz5Momentum Herwig::IILightKinematics::KplusKtilde
private

Definition at line 231 of file IILightKinematics.h.

◆ KplusKtilde2

Energy2 Herwig::IILightKinematics::KplusKtilde2
private

Definition at line 232 of file IILightKinematics.h.

◆ Ktilde

Lorentz5Momentum Herwig::IILightKinematics::Ktilde
private

Definition at line 230 of file IILightKinematics.h.

◆ theCollinearScheme

bool Herwig::IILightKinematics::theCollinearScheme
private

Wether or not to choose the ‘collinear’ scheme.

Definition at line 218 of file IILightKinematics.h.

Referenced by doesTransform().

◆ theRecoilTransformation

LorentzRotation Herwig::IILightKinematics::theRecoilTransformation
private

Store the LorentzRotation object equivalent to the transformation applied to the outgoing particles.

Need this to apply to the particle SpinInfo if spin correlations are included.

Definition at line 240 of file IILightKinematics.h.

◆ theTransformationCalculated

bool Herwig::IILightKinematics::theTransformationCalculated
private

Bool to avoid unecessary recalculation of the Lorentz transformation.

Definition at line 246 of file IILightKinematics.h.


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