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

The Dipole class is used by the dipole shower to represent a dipole of two coloured partons. More...

#include <Dipole.h>

Public Member Functions

 Dipole ()
 The default constructor.
 
 Dipole (const pair< PPtr, PPtr > &newParticles, const pair< PDF, PDF > &newPDFs, pair< double, double > newFractions, pair< Energy, Energy > newScales)
 The standard constructor.
 
 Dipole (const pair< PPtr, PPtr > &newParticles, const pair< PDF, PDF > &newPDFs, pair< double, double > newFractions, const pair< bool, bool > decaying=pair< bool, bool >(false, false), const pair< bool, bool > offShell=pair< bool, bool >(false, false), pair< Energy, Energy > newScales=pair< Energy, Energy >(ZERO, ZERO))
 The standard constructor.
 
tPPtr leftParticle () const
 Get the left particle.
 
tPPtr rightParticle () const
 Get the right particle.
 
const PDFleftPDF () const
 Get the left PDF.
 
const PDFrightPDF () const
 Get the right PDF.
 
double leftFraction () const
 Get the left fraction.
 
double rightFraction () const
 Get the right fraction.
 
bool leftDecaying ()
 Get the bool indicating incoming decay for the left particle, for debugging only.
 
bool rightDecaying ()
 Get the bool indicating incoming decay for the right particle, for debugging only.
 
void leftParticle (PPtr p)
 Set the left particle.
 
void rightParticle (PPtr p)
 Set the right particle.
 
void leftPDF (const PDF &p)
 Set the left PDF.
 
void rightPDF (const PDF &p)
 Set the right PDF.
 
void leftFraction (double x)
 Set the momentum fraction for the left particle.
 
void rightFraction (double x)
 Set the momentum fraction for the right particle.
 
Energy leftScale () const
 Get the scale for the left particle.
 
void leftScale (Energy s)
 Set the scale for the left particle.
 
Energy rightScale () const
 Get the scale for the right particle.
 
void rightScale (Energy s)
 Set the scale for the right particle.
 
void leftDecaying (bool decaying)
 Set the decayed particle indicator for the left particle.
 
void rightDecaying (bool decaying)
 Set the decayed particle indicator for the right particle.
 
void update ()
 Update information, if modified.
 
const DipoleIndexindex (pair< bool, bool > conf) const
 Return the dipole index for the selected emitter-spectator assignment.
 
void setFirstIndex (DipoleIndex s)
 Set the first index.
 
void setSecondIndex (DipoleIndex s)
 Set the first index.
 
tPPtr emitter (pair< bool, bool > conf) const
 Return the emitter particle for the selected configuration.
 
tPPtr spectator (pair< bool, bool > conf) const
 Return the spectator particle for the selected configuration.
 
Energy emitterScale (pair< bool, bool > conf) const
 Return the scale associated to the emitter for the selected configuration.
 
void emitterScale (pair< bool, bool > conf, Energy scale)
 Set the scale associated to the emitter for the selected configuration.
 
double emitterX (pair< bool, bool > conf) const
 Return the momentum fraction of the emitter for the selected configuration.
 
const PDFemitterPDF (pair< bool, bool > conf) const
 Return the PDF of the emitter for the selected configuration.
 
double spectatorX (pair< bool, bool > conf) const
 Return the momentum fraction of the spectator for the selected configuration.
 
const PDFspectatorPDF (pair< bool, bool > conf) const
 Return the PDF of the spectator for the selected configuration.
 
pair< Dipole, Dipolesplit (DipoleSplittingInfo &dsplit, bool colourSpectator, bool subleadingNc=false) const
 Split this dipole according to the given splitting.
 
void tmpsplit (DipoleSplittingInfo &dsplit, bool colourSpectator) const
 As split, but without touching the event record.
 
void recoil (DipoleSplittingInfo &dsplit)
 Produce a new spectator according to the given splitting.
 
void print (ostream &) const
 Put information to ostream.
 

Private Attributes

pair< PPtr, PPtrtheParticles
 The particles forming the dipole.
 
pair< PDF, PDFthePDFs
 The PDF objects.
 
pair< double, double > theFractions
 The momentum fractions associated to the incoming particles.
 
pair< DipoleIndex, DipoleIndextheIndices
 The dipole indices, if the first or second particle is considered as emitter.
 
pair< bool, bool > theDecaying
 Indicates if either the first or the second parton is incoming to a decay.
 
pair< bool, bool > theOffShell
 Indicates if either the first or second parton can be off-shell (required for sampling).
 
pair< Energy, Energy > theScales
 The scale associated to the first and second particle, respectively.
 

Detailed Description

The Dipole class is used by the dipole shower to represent a dipole of two coloured partons.

Author
Simon Platzer, Stephen Webster, Johannes Bellm

Definition at line 30 of file Dipole.h.

Member Function Documentation

◆ emitter()

tPPtr Herwig::Dipole::emitter ( pair< bool, bool >  conf) const
inline

Return the emitter particle for the selected configuration.

Definition at line 195 of file Dipole.h.

References theParticles.

◆ emitterPDF()

const PDF & Herwig::Dipole::emitterPDF ( pair< bool, bool >  conf) const
inline

Return the PDF of the emitter for the selected configuration.

Definition at line 235 of file Dipole.h.

References thePDFs.

◆ emitterScale() [1/2]

Energy Herwig::Dipole::emitterScale ( pair< bool, bool >  conf) const
inline

Return the scale associated to the emitter for the selected configuration.

Definition at line 211 of file Dipole.h.

References theScales.

◆ emitterScale() [2/2]

void Herwig::Dipole::emitterScale ( pair< bool, bool >  conf,
Energy  scale 
)
inline

Set the scale associated to the emitter for the selected configuration.

Definition at line 219 of file Dipole.h.

References theScales.

◆ emitterX()

double Herwig::Dipole::emitterX ( pair< bool, bool >  conf) const
inline

Return the momentum fraction of the emitter for the selected configuration.

Definition at line 227 of file Dipole.h.

References theFractions.

◆ index()

const DipoleIndex & Herwig::Dipole::index ( pair< bool, bool >  conf) const
inline

Return the dipole index for the selected emitter-spectator assignment.

Definition at line 177 of file Dipole.h.

References theIndices.

◆ leftDecaying() [1/2]

bool Herwig::Dipole::leftDecaying ( )
inline

Get the bool indicating incoming decay for the left particle, for debugging only.

Definition at line 95 of file Dipole.h.

References theDecaying.

◆ leftDecaying() [2/2]

void Herwig::Dipole::leftDecaying ( bool  decaying)
inline

Set the decayed particle indicator for the left particle.

Definition at line 158 of file Dipole.h.

References theDecaying.

◆ leftFraction() [1/2]

double Herwig::Dipole::leftFraction ( ) const
inline

Get the left fraction.

Definition at line 83 of file Dipole.h.

References theFractions.

◆ leftFraction() [2/2]

void Herwig::Dipole::leftFraction ( double  x)
inline

Set the momentum fraction for the left particle.

Definition at line 127 of file Dipole.h.

References theFractions.

◆ leftParticle() [1/2]

tPPtr Herwig::Dipole::leftParticle ( ) const
inline

Get the left particle.

Definition at line 63 of file Dipole.h.

References theParticles.

◆ leftParticle() [2/2]

void Herwig::Dipole::leftParticle ( PPtr  p)
inline

Set the left particle.

Definition at line 107 of file Dipole.h.

References theParticles.

◆ leftPDF() [1/2]

const PDF & Herwig::Dipole::leftPDF ( ) const
inline

Get the left PDF.

Definition at line 73 of file Dipole.h.

References thePDFs.

◆ leftPDF() [2/2]

void Herwig::Dipole::leftPDF ( const PDF p)
inline

Set the left PDF.

Definition at line 117 of file Dipole.h.

References thePDFs.

◆ leftScale() [1/2]

Energy Herwig::Dipole::leftScale ( ) const
inline

Get the scale for the left particle.

Definition at line 137 of file Dipole.h.

References theScales.

◆ leftScale() [2/2]

void Herwig::Dipole::leftScale ( Energy  s)
inline

Set the scale for the left particle.

Definition at line 142 of file Dipole.h.

References theScales.

◆ rightDecaying() [1/2]

bool Herwig::Dipole::rightDecaying ( )
inline

Get the bool indicating incoming decay for the right particle, for debugging only.

Definition at line 102 of file Dipole.h.

References theDecaying.

◆ rightDecaying() [2/2]

void Herwig::Dipole::rightDecaying ( bool  decaying)
inline

Set the decayed particle indicator for the right particle.

Definition at line 164 of file Dipole.h.

References theDecaying.

◆ rightFraction() [1/2]

double Herwig::Dipole::rightFraction ( ) const
inline

Get the right fraction.

Definition at line 88 of file Dipole.h.

References theFractions.

◆ rightFraction() [2/2]

void Herwig::Dipole::rightFraction ( double  x)
inline

Set the momentum fraction for the right particle.

Definition at line 132 of file Dipole.h.

References theFractions.

◆ rightParticle() [1/2]

tPPtr Herwig::Dipole::rightParticle ( ) const
inline

Get the right particle.

Definition at line 68 of file Dipole.h.

References theParticles.

◆ rightParticle() [2/2]

void Herwig::Dipole::rightParticle ( PPtr  p)
inline

Set the right particle.

Definition at line 112 of file Dipole.h.

References theParticles.

◆ rightPDF() [1/2]

const PDF & Herwig::Dipole::rightPDF ( ) const
inline

Get the right PDF.

Definition at line 78 of file Dipole.h.

References thePDFs.

◆ rightPDF() [2/2]

void Herwig::Dipole::rightPDF ( const PDF p)
inline

Set the right PDF.

Definition at line 122 of file Dipole.h.

References thePDFs.

◆ rightScale() [1/2]

Energy Herwig::Dipole::rightScale ( ) const
inline

Get the scale for the right particle.

Definition at line 147 of file Dipole.h.

References theScales.

◆ rightScale() [2/2]

void Herwig::Dipole::rightScale ( Energy  s)
inline

Set the scale for the right particle.

Definition at line 152 of file Dipole.h.

References theScales.

◆ setFirstIndex()

void Herwig::Dipole::setFirstIndex ( DipoleIndex  s)
inline

Set the first index.

Definition at line 184 of file Dipole.h.

References theIndices.

◆ setSecondIndex()

void Herwig::Dipole::setSecondIndex ( DipoleIndex  s)
inline

Set the first index.

Definition at line 189 of file Dipole.h.

References theIndices.

◆ spectator()

tPPtr Herwig::Dipole::spectator ( pair< bool, bool >  conf) const
inline

Return the spectator particle for the selected configuration.

Definition at line 203 of file Dipole.h.

References theParticles.

◆ spectatorPDF()

const PDF & Herwig::Dipole::spectatorPDF ( pair< bool, bool >  conf) const
inline

Return the PDF of the spectator for the selected configuration.

Definition at line 251 of file Dipole.h.

References thePDFs.

◆ spectatorX()

double Herwig::Dipole::spectatorX ( pair< bool, bool >  conf) const
inline

Return the momentum fraction of the spectator for the selected configuration.

Definition at line 243 of file Dipole.h.

References theFractions.

◆ split()

pair< Dipole, Dipole > Herwig::Dipole::split ( DipoleSplittingInfo dsplit,
bool  colourSpectator,
bool  subleadingNc = false 
) const

Split this dipole according to the given splitting.

If colourSpectator is true, do not change the spectator.

◆ tmpsplit()

void Herwig::Dipole::tmpsplit ( DipoleSplittingInfo dsplit,
bool  colourSpectator 
) const

As split, but without touching the event record.

Needed to produce a phase space point as it would be after calling split.

Member Data Documentation

◆ theDecaying

pair<bool,bool> Herwig::Dipole::theDecaying
private

Indicates if either the first or the second parton is incoming to a decay.

Definition at line 315 of file Dipole.h.

Referenced by leftDecaying(), and rightDecaying().

◆ theFractions

pair<double,double> Herwig::Dipole::theFractions
private

The momentum fractions associated to the incoming particles.

Definition at line 303 of file Dipole.h.

Referenced by emitterX(), leftFraction(), rightFraction(), and spectatorX().

◆ theIndices

pair<DipoleIndex,DipoleIndex> Herwig::Dipole::theIndices
private

The dipole indices, if the first or second particle is considered as emitter.

Definition at line 309 of file Dipole.h.

Referenced by index(), setFirstIndex(), and setSecondIndex().

◆ theOffShell

pair<bool,bool> Herwig::Dipole::theOffShell
private

Indicates if either the first or second parton can be off-shell (required for sampling).

Definition at line 321 of file Dipole.h.

◆ theParticles

pair<PPtr,PPtr> Herwig::Dipole::theParticles
private

The particles forming the dipole.

Definition at line 292 of file Dipole.h.

Referenced by emitter(), leftParticle(), rightParticle(), and spectator().

◆ thePDFs

pair<PDF,PDF> Herwig::Dipole::thePDFs
private

The PDF objects.

Definition at line 297 of file Dipole.h.

Referenced by emitterPDF(), leftPDF(), rightPDF(), and spectatorPDF().

◆ theScales

pair<Energy,Energy> Herwig::Dipole::theScales
private

The scale associated to the first and second particle, respectively.

Definition at line 327 of file Dipole.h.

Referenced by emitterScale(), leftScale(), and rightScale().


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