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

DipoleIndex is used to index splitting generators for a particular dipole. More...

#include <DipoleSplittingInfo.h>

Public Member Functions

 DipoleIndex ()
 The default constructor.
 
 DipoleIndex (tcPDPtr newEmitter, tcPDPtr newSpectator, const PDF &newEmitterPDF=PDF(), const PDF &newSpectatorPDF=PDF(), const bool decayingEmitter=false, const bool decayingSpectator=false, const bool offShellEmitter=false, const bool offShellSpectator=false)
 The standard constructor.
 
bool operator== (const DipoleIndex &x) const
 Compare for equality.
 
bool operator< (const DipoleIndex &x) const
 Compare for ordering.
 
void swap ()
 Swap emitter and spectator.
 
pair< DipoleIndex, DipoleIndexsplit (tcPDPtr) const
 Produce a pair of dipole indices given a particle data object for the emission.
 
tcPDPtr emitterData () const
 Return the emitter particle data object.
 
bool initialStateEmitter () const
 Return true, if the emitter is an incoming parton.
 
bool incomingDecayEmitter () const
 Return true, if the emitter is incoming to a decay.
 
bool offShellEmitter () const
 Return true, if the emitter can be off-shell.
 
const PDFemitterPDF () const
 Return the PDF object associated with the emitter.
 
tcPDPtr spectatorData () const
 Return the spectator particle data object.
 
bool initialStateSpectator () const
 Return true, if the spectator is an incoming parton.
 
bool incomingDecaySpectator () const
 Return true, if the spectator is incoming to a decay.
 
bool offShellSpectator () const
 Return true, if the spectator can be off-shell.
 
const PDFspectatorPDF () const
 Return the PDF object associated with the spectator.
 
void print (ostream &) const
 Put information to ostream.
 

Private Attributes

tcPDPtr theEmitterData
 The particle data object of the emitter.
 
bool theInitialStateEmitter
 Whether or not the emitter is an incoming parton.
 
bool theIncomingDecayEmitter
 Whether or not the emitter is incoming to a decay.
 
bool theOffShellEmitter
 Can the emitter be off-shell?
 
PDF theEmitterPDF
 The PDF object for the emitter.
 
tcPDPtr theSpectatorData
 The particle data object of the spectator.
 
bool theInitialStateSpectator
 Whether or not the spectator is an incoming parton.
 
bool theIncomingDecaySpectator
 Whether or not the spectator is incoming to a decay.
 
bool theOffShellSpectator
 Can the spectator be off-shell?
 
PDF theSpectatorPDF
 The PDF object for the spectator.
 

Detailed Description

DipoleIndex is used to index splitting generators for a particular dipole.

Author
Simon Platzer, Stephen Webster

Definition at line 35 of file DipoleSplittingInfo.h.

Member Function Documentation

◆ emitterData()

tcPDPtr Herwig::DipoleIndex::emitterData ( ) const
inline

Return the emitter particle data object.

Definition at line 86 of file DipoleSplittingInfo.h.

References theEmitterData.

◆ emitterPDF()

const PDF & Herwig::DipoleIndex::emitterPDF ( ) const
inline

Return the PDF object associated with the emitter.

Definition at line 107 of file DipoleSplittingInfo.h.

References theEmitterPDF.

◆ incomingDecayEmitter()

bool Herwig::DipoleIndex::incomingDecayEmitter ( ) const
inline

Return true, if the emitter is incoming to a decay.

Definition at line 96 of file DipoleSplittingInfo.h.

References theIncomingDecayEmitter.

◆ incomingDecaySpectator()

bool Herwig::DipoleIndex::incomingDecaySpectator ( ) const
inline

Return true, if the spectator is incoming to a decay.

Definition at line 122 of file DipoleSplittingInfo.h.

References theIncomingDecaySpectator.

◆ initialStateEmitter()

bool Herwig::DipoleIndex::initialStateEmitter ( ) const
inline

Return true, if the emitter is an incoming parton.

Definition at line 91 of file DipoleSplittingInfo.h.

References theInitialStateEmitter.

◆ initialStateSpectator()

bool Herwig::DipoleIndex::initialStateSpectator ( ) const
inline

Return true, if the spectator is an incoming parton.

Definition at line 117 of file DipoleSplittingInfo.h.

References theInitialStateSpectator.

◆ offShellEmitter()

bool Herwig::DipoleIndex::offShellEmitter ( ) const
inline

Return true, if the emitter can be off-shell.

Definition at line 101 of file DipoleSplittingInfo.h.

References theOffShellEmitter.

◆ offShellSpectator()

bool Herwig::DipoleIndex::offShellSpectator ( ) const
inline

Return true, if the spectator can be off-shell.

Definition at line 127 of file DipoleSplittingInfo.h.

References theOffShellSpectator.

◆ spectatorData()

tcPDPtr Herwig::DipoleIndex::spectatorData ( ) const
inline

Return the spectator particle data object.

Definition at line 112 of file DipoleSplittingInfo.h.

References theSpectatorData.

◆ spectatorPDF()

const PDF & Herwig::DipoleIndex::spectatorPDF ( ) const
inline

Return the PDF object associated with the spectator.

Definition at line 133 of file DipoleSplittingInfo.h.

References theSpectatorPDF.

◆ split()

pair< DipoleIndex, DipoleIndex > Herwig::DipoleIndex::split ( tcPDPtr  ) const

Produce a pair of dipole indices given a particle data object for the emission.

The ME correction is ignored in the children. The emission is inserted between the emitter and spectator, being a spectator in the first dipole index containing the original emitter, and an emitter in the second dipole, containing the original spectator.

Member Data Documentation

◆ theEmitterData

tcPDPtr Herwig::DipoleIndex::theEmitterData
private

The particle data object of the emitter.

Definition at line 147 of file DipoleSplittingInfo.h.

Referenced by emitterData().

◆ theEmitterPDF

PDF Herwig::DipoleIndex::theEmitterPDF
private

The PDF object for the emitter.

Definition at line 167 of file DipoleSplittingInfo.h.

Referenced by emitterPDF().

◆ theIncomingDecayEmitter

bool Herwig::DipoleIndex::theIncomingDecayEmitter
private

Whether or not the emitter is incoming to a decay.

Definition at line 157 of file DipoleSplittingInfo.h.

Referenced by incomingDecayEmitter().

◆ theIncomingDecaySpectator

bool Herwig::DipoleIndex::theIncomingDecaySpectator
private

Whether or not the spectator is incoming to a decay.

Definition at line 182 of file DipoleSplittingInfo.h.

Referenced by incomingDecaySpectator().

◆ theInitialStateEmitter

bool Herwig::DipoleIndex::theInitialStateEmitter
private

Whether or not the emitter is an incoming parton.

Definition at line 152 of file DipoleSplittingInfo.h.

Referenced by initialStateEmitter().

◆ theInitialStateSpectator

bool Herwig::DipoleIndex::theInitialStateSpectator
private

Whether or not the spectator is an incoming parton.

Definition at line 177 of file DipoleSplittingInfo.h.

Referenced by initialStateSpectator().

◆ theOffShellEmitter

bool Herwig::DipoleIndex::theOffShellEmitter
private

Can the emitter be off-shell?

Definition at line 162 of file DipoleSplittingInfo.h.

Referenced by offShellEmitter().

◆ theOffShellSpectator

bool Herwig::DipoleIndex::theOffShellSpectator
private

Can the spectator be off-shell?

Definition at line 187 of file DipoleSplittingInfo.h.

Referenced by offShellSpectator().

◆ theSpectatorData

tcPDPtr Herwig::DipoleIndex::theSpectatorData
private

The particle data object of the spectator.

Definition at line 172 of file DipoleSplittingInfo.h.

Referenced by spectatorData().

◆ theSpectatorPDF

PDF Herwig::DipoleIndex::theSpectatorPDF
private

The PDF object for the spectator.

Definition at line 192 of file DipoleSplittingInfo.h.

Referenced by spectatorPDF().


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