herwig is hosted by Hepforge, IPPP Durham
 Herwig  7.1.4
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), 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.

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) const
Split this dipole according to the given splitting. More...

void tmpsplit (DipoleSplittingInfo &dsplit, bool colourSpectator) const
As split, but without touching the event record. More...

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< Energy, Energy > theScales
The scale associated to the first and second particle, respectively.

pair< bool, bool > theDecaying
Indicates if either the first or the second parton is incoming to a decay.

## Detailed Description

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

Definition at line 30 of file Dipole.h.

## ◆ split()

 pair Herwig::Dipole::split ( DipoleSplittingInfo & dsplit, bool colourSpectator ) 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.

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