herwig is hosted by Hepforge, IPPP Durham
Herwig  7.1.5
Herwig::TildeKinematics Class Referenceabstract

TildeKinematics is the base class for the 'tilde' kinematics being used for subtraction terms in the formalism of Catani and Seymour. More...

#include <TildeKinematics.h>

Inheritance diagram for Herwig::TildeKinematics:

Public Member Functions

Ptr< TildeKinematics >::ptr cloneMe () const
 Clone this object.
 
virtual void getShowerVariables () const
 If this tilde kinematics is implementing a mapping different from the baseline dipole mapping, determine the relevant shower parameters and check for phase space boundaries. More...
 
virtual double jacobianRatio () const
 If this tilde kinematics is implementing a mapping different from the baseline dipole mapping, return the ratio of phase space factorization Jacobians for this and the nominal dipole mapping. More...
 
double emitterX () const
 Return the momentum fraction of the emitter.
 
double spectatorX () const
 Return the momentum fraction of the spectator.
 
Standard constructors and destructors.
 TildeKinematics ()
 The default constructor.
 
virtual ~TildeKinematics ()
 The destructor.
 
Access to kinematic quantities.
const Lorentz5Momentum & realEmitterMomentum () const
 Return the momentum of the emitter in the real emission process.
 
const Lorentz5Momentum & realEmissionMomentum () const
 Return the momentum of the emission in the real emission process.
 
const Lorentz5Momentum & realSpectatorMomentum () const
 Return the momentum of the spectator in the real emission process.
 
const Lorentz5Momentum & bornEmitterMomentum () const
 Return the momentum of the emitter in the underlying Born process.
 
const Lorentz5Momentum & bornSpectatorMomentum () const
 Return the momentum of the spectator in the underlying Born process.
 
const vector< double > & subtractionParameters () const
 Return the vector of dimensionless variables calculated.
 
virtual bool doesTransform () const
 Return true, if this TildeKinematics object needs to transform all other particles in the process except the emitter and spectator.
 
virtual Lorentz5Momentum transform (const Lorentz5Momentum &p) const
 If this TildeKinematics object needs to transform all other particles in the process except the emitter and spectator, return the transformed momentum.
 
Access to process data.
void prepare (tcStdXCombPtr newRealXComb, tcStdXCombPtr newBornXComb)
 Prepare given a dipole, and XCombs describing the real emission and underlying Born processes, respectively.
 
void dipole (Ptr< SubtractionDipole >::tptr dip)
 Set the current dipole.
 
Ptr< SubtractionDipole >::tptr dipole ()
 Return the current dipole.
 
Ptr< SubtractionDipole >::tcptr dipole () const
 Return the current dipole.
 
virtual bool doMap ()=0
 Perform the mapping to the tilde kinematics for the last selected process and store all dimensionless variables in the subtractionParameters() vector. More...
 
virtual Energy lastPt () const =0
 Return the pt associated to the last merged splitting.
 
virtual Energy lastPt (Lorentz5Momentum, Lorentz5Momentum, Lorentz5Momentum) const =0
 Return the pt associated to emitter emission and sppectator momentum.
 
virtual pair< double, double > zBounds (Energy pt, Energy hardPt) const =0
 Given a pt and a hard pt, return the boundaries on z;.
 
virtual double lastZ () const =0
 Return the momentum fraction associated to the last splitting.
 
virtual Energy lastScale () const
 Return the relevant dipole scale.
 
virtual bool aboveAlpha () const
 
cPDPtr realEmitterData () const
 Return the particle type of the emitter in the real emission process.
 
cPDPtr realEmissionData () const
 Return the particle type of the emission in the real emission process.
 
cPDPtr realSpectatorData () const
 Return the particle type of the spectator in the real emission process.
 
cPDPtr bornEmitterData () const
 Return the particle type of the emitter in the underlying Born process.
 
cPDPtr bornSpectatorData () const
 Return the particle type of the spectator in the underlying Born process.
 
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())
 
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 & bornEmitterMomentum ()
 Access the momentum of the emitter in the underlying Born process.
 
Lorentz5Momentum & bornSpectatorMomentum ()
 Access the momentum of the spectator in the underlying Born process.
 
vector< double > & subtractionParameters ()
 Access the vector of dimensionless variables calculated.
 
Standard Interfaced functions.
virtual void rebind (const TranslationMap &trans)
 Rebind pointer to other Interfaced objects. More...
 
virtual IVector getReferences ()
 Return a vector of all pointers to Interfaced objects used in this object. More...
 
- 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 void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinit ()
 
virtual void doinitrun ()
 
virtual void dofinish ()
 
- 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)
 

Private Member Functions

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

Private Attributes

Ptr< SubtractionDipole >::tptr theDipole
 The last dipole this TildeKinematics has been selected for.
 
tcStdXCombPtr theRealXComb
 The XComb object describing the real emission process.
 
tcStdXCombPtr theBornXComb
 The XComb object describing the underlying Born process.
 
Lorentz5Momentum theBornEmitterMomentum
 The momentum of the emitter in the underlying Born process.
 
Lorentz5Momentum theBornSpectatorMomentum
 The momentum of the spectator in the underlying Born process.
 

Additional Inherited Members

- Public Types inherited from ThePEG::InterfacedBase
enum  InitState
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 
- 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

TildeKinematics is the base class for the 'tilde' kinematics being used for subtraction terms in the formalism of Catani and Seymour.

Author
Simon Platzer

Definition at line 33 of file TildeKinematics.h.

Member Function Documentation

◆ doMap()

virtual bool Herwig::TildeKinematics::doMap ( )
pure virtual

Perform the mapping to the tilde kinematics for the last selected process and store all dimensionless variables in the subtractionParameters() vector.

Return false, if the calculation of the tilde kinematics was impossible for the selected configuration and true on success.

Implemented in Herwig::FFLightTildeKinematics, Herwig::FFMassiveTildeKinematics, Herwig::FILightTildeKinematics, Herwig::FIMassiveTildeKinematics, Herwig::IFLightTildeKinematics, Herwig::IFMassiveTildeKinematics, and Herwig::IILightTildeKinematics.

◆ getReferences()

virtual IVector Herwig::TildeKinematics::getReferences ( )
protectedvirtual

Return a vector of all pointers to Interfaced objects used in this object.

Returns
a vector of pointers.

Reimplemented from ThePEG::InterfacedBase.

◆ getShowerVariables()

virtual void Herwig::TildeKinematics::getShowerVariables ( ) const
inlinevirtual

If this tilde kinematics is implementing a mapping different from the baseline dipole mapping, determine the relevant shower parameters and check for phase space boundaries.

Note that real emission kinematics only are available at this stage.

Definition at line 117 of file TildeKinematics.h.

◆ Init()

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

◆ jacobianRatio()

virtual double Herwig::TildeKinematics::jacobianRatio ( ) const
inlinevirtual

If this tilde kinematics is implementing a mapping different from the baseline dipole mapping, return the ratio of phase space factorization Jacobians for this and the nominal dipole mapping.

This is used for matching subtractions.

Definition at line 125 of file TildeKinematics.h.

◆ operator=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ rebind()

virtual void Herwig::TildeKinematics::rebind ( const TranslationMap trans)
protectedvirtual

Rebind pointer to other Interfaced objects.

Called in the setup phase after all objects used in an EventGenerator has been cloned so that the pointers will refer to the cloned objects afterwards.

Parameters
transa TranslationMap relating the original objects to their respective clones.
Exceptions
RebindExceptionif no cloned object was found for a given pointer.

Reimplemented from ThePEG::InterfacedBase.


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