herwig is hosted by Hepforge, IPPP Durham
Herwig  7.2.1
Herwig::MatchboxPhasespace Class Referenceabstract

MatchboxPhasespace defines an abstract interface to a phase space generator. More...

#include <MatchboxPhasespace.h>

Inheritance diagram for Herwig::MatchboxPhasespace:

Public Member Functions

virtual void setXComb (tStdXCombPtr xc)
 Set the XComb object steering the Born matrix element this class represents virtual corrections to.
 
Ptr< MatchboxFactory >::tcptr factory () const
 Return the factory object.
 
Ptr< ProcessData >::tptr processData () const
 Return the process data object.
 
virtual double generateKinematics (const double *r, vector< Lorentz5Momentum > &momenta)
 Generate a phase space point and return its weight.
 
virtual double generateTwoToNKinematics (const double *, vector< Lorentz5Momentum > &momenta)=0
 Generate a phase space point and return its weight.
 
virtual double generateTwoToOneKinematics (const double *, vector< Lorentz5Momentum > &momenta)
 Generate a 2 -> 1 phase space point and return its weight.
 
virtual int nDim (const cPDVector &) const
 Return the number of random numbers required to produce a given multiplicity final state.
 
virtual int nDimPhasespace (int nFinal) const =0
 Return the number of random numbers required to produce a given multiplicity final state.
 
virtual bool haveX1X2 () const
 Return true, if this phasespace generator will generate incoming partons itself.
 
virtual bool wantCMS () const
 Return true, if this phase space generator expects the incoming partons in their center-of-mass system.
 
bool useMassGenerators () const
 True, if mass generators should be used instead of fixed masses.
 
virtual Selector< MEBase::DiagramIndexselectDiagrams (const MEBase::DiagramVector &) const
 Fill a diagram selector for the last phase space point.
 
pair< double, Lorentz5Momentum > timeLikeWeight (const Tree2toNDiagram &diag, int branch, double flatCut) const
 Return the momentum and weight appropriate to the given timelike branch of the diagram.
 
double spaceLikeWeight (const Tree2toNDiagram &diag, const Lorentz5Momentum &incoming, int branch, double flatCut) const
 Return the weight appropriate to the given spacelike branch of the diagram.
 
double diagramWeight (const Tree2toNDiagram &diag) const
 Return the weight appropriate to the given diagram.
 
void fillDiagramWeights (double flatCut=0.0)
 Fill the diagram weights.
 
void clearDiagramWeights ()
 Clear the diagram weights.
 
Ptr< MatchboxPhasespace >::ptr cloneMe () const
 Clone this phase space generator.
 
virtual void cloneDependencies (const std::string &prefix="")
 Clone the dependencies, using a given prefix.
 
virtual bool isInvertible () const
 Return true, if this phase space generator is invertible.
 
virtual double invertKinematics (const vector< Lorentz5Momentum > &momenta, double *r) const
 Invert the given phase space point to the random numbers which would have generated it.
 
virtual double invertTwoToNKinematics (const vector< Lorentz5Momentum > &, double *) const
 Invert the given phase space point to the random numbers which would have generated it.
 
virtual double invertTwoToOneKinematics (const vector< Lorentz5Momentum > &, double *) const
 Invert the given 2 -> 1 phase space point to the random numbers which would have generated it.
 
void singularLimit (size_t i, size_t j)
 Limit phasespace generation to a given collinear or soft limit.
 
const pair< size_t, size_t > & lastSingularIndices () const
 Return the last matched singular limit.
 
bool matchConstraints (const vector< Lorentz5Momentum > &momenta)
 Return true, if constraints on phasespace generation have been met.
 
Standard constructors and destructors.
 MatchboxPhasespace ()
 The default constructor.
 
virtual ~MatchboxPhasespace ()
 The destructor.
 
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())
 
 Named (const Named &)=default
 
const string & name () const
 
bool operator== (const Named &other) const
 
bool operator< (const Named &other) const
 
- Public Member Functions inherited from ThePEG::LastXCombInfo< StandardXComb >
const StandardXComblastXComb () const
 
const StandardXComblastXComb () const
 
tXCPtr lastXCombPtr () const
 
tXCPtr lastXCombPtr () const
 
const StandardXComblastHeadXComb () const
 
const StandardXComblastHeadXComb () const
 
tXCPtr lastHeadXCombPtr () const
 
tXCPtr lastHeadXCombPtr () const
 
const EventHandlerlastEventHandler () const
 
const EventHandlerlastEventHandler () const
 
tPExtrPtr lastExtractor () const
 
tPExtrPtr lastExtractor () const
 
PDFT pdf (tcPPtr parton) const
 
PDFT pdf (tcPPtr parton) const
 
const CutslastCuts () const
 
const CutslastCuts () const
 
tCutsPtr lastCutsPtr () const
 
tCutsPtr lastCutsPtr () const
 
const PPairlastParticles () const
 
const PPairlastParticles () const
 
Energy2 lastS () const
 
Energy2 lastS () const
 
const PPairlastPartons () const
 
const PPairlastPartons () const
 
Energy2 lastSHat () const
 
Energy2 lastSHat () const
 
double lastTau () const
 
double lastTau () const
 
double lastY () const
 
double lastY () const
 
double lastP1 () const
 
double lastP1 () const
 
double lastP2 () const
 
double lastP2 () const
 
double lastL1 () const
 
double lastL1 () const
 
double lastL2 () const
 
double lastL2 () const
 
double lastX1 () const
 
double lastX1 () const
 
double lastX2 () const
 
double lastX2 () const
 
double lastE1 () const
 
double lastE1 () const
 
double lastE2 () const
 
double lastE2 () const
 
double lastFL1L2 () const
 
double lastFL1L2 () const
 
Energy2 lastScale () const
 
Energy2 lastScale () const
 
double lastAlphaS () const
 
double lastAlphaS () const
 
double lastAlphaEM () const
 
double lastAlphaEM () const
 
const vector< Lorentz5Momentum > & meMomenta () const
 
const vector< Lorentz5Momentum > & meMomenta () const
 
double lastME2 () const
 
double lastME2 () const
 
double lastPreweight () const
 
double lastPreweight () const
 
double jacobian () const
 
double jacobian () const
 
CrossSection lastMECrossSection () const
 
CrossSection lastMECrossSection () const
 
double lastMEPDFWeight () const
 
double lastMEPDFWeight () const
 
double lastMECouplings () const
 
double lastMECouplings () const
 
tSubProPtr subProcess () const
 
tSubProPtr subProcess () const
 
const cPDVectormePartonData () const
 
const cPDVectormePartonData () const
 
- Public Member Functions inherited from Herwig::LastMatchboxXCombInfo
 LastMatchboxXCombInfo ()
 Default constructor.
 
MatchboxXCombDatalastMatchboxXComb () const
 Return a pointer to the last selected XComb.
 
MatchboxXCombDatalastHeadMatchboxXComb () const
 If the last selected XComb object belongs to a group of XComb's return a pointer to the head XComb object for this group.
 
const vector< int > & crossingMap () const
 The crossing information as filled by the last call to fillCrossingMap()
 
const map< size_t, size_t > & amplitudeToColourMap () const
 The colour crossing information as filled by the last call to fillCrossingMap()
 
const map< size_t, size_t > & colourToAmplitudeMap () const
 The colour crossing information as filled by the last call to fillCrossingMap()
 
double crossingSign () const
 The crossing sign as filled by the last call to fillCrossingMap()
 
Energy2 lastRenormalizationScale () const
 The last renormalization scale.
 
const cPDVectoramplitudePartonData () const
 The amplitude parton data.
 
const vector< Lorentz5Momentum > & amplitudeMomenta () const
 The crossed momenta.
 
bool calculateTreeAmplitudes () const
 True, if the the tree level amplitudes need to be calculated.
 
const map< vector< int >, CVector > & lastAmplitudes () const
 The amplitude values which have been contributing to the last call of prepareAmplitudes.
 
const map< vector< int >, CVector > & lastLargeNAmplitudes () const
 The leading N amplitude values which have been contributing to the last call of prepareAmplitudes.
 
bool calculateOneLoopAmplitudes () const
 True, if the the one-loop amplitudes need to be calculated.
 
const map< vector< int >, CVector > & lastOneLoopAmplitudes () const
 The one-loop amplitude values which have been contributing to the last call of prepareAmplitudes.
 
bool calculateTreeME2 () const
 True, if the tree-level matrix element squared needs to be calculated.
 
double lastTreeME2 () const
 The last tree-level matrix element squared.
 
bool calculateLargeNME2 () const
 True, if the tree-level matrix element squared needs to be calculated.
 
double lastLargeNME2 () const
 The last tree-level matrix element squared.
 
bool calculateOneLoopInterference () const
 True, if the one-loop/tree-level interference. More...
 
double lastOneLoopInterference () const
 The last one-loop/tree-level interference.
 
bool calculateOneLoopPoles () const
 True, if the one-loop/tree-level interference. More...
 
pair< double, double > lastOneLoopPoles () const
 The last one-loop/tree-level interference.
 
bool calculateColourCorrelator (const pair< int, int > &ij) const
 True, if the indexed colour correlated matrix element needs to be calculated.
 
double lastColourCorrelator (const pair< int, int > &ij) const
 The colour correlated matrix element.
 
bool calculateLargeNColourCorrelator (const pair< int, int > &ij) const
 True, if the indexed large-N colour correlated matrix element needs to be calculated.
 
double lastLargeNColourCorrelator (const pair< int, int > &ij) const
 The large-N colour correlated matrix element.
 
bool calculateColourSpinCorrelator (const pair< int, int > &ij) const
 True, if the indexed colour/spin correlated matrix element needs to be calculated.
 
Complex lastColourSpinCorrelator (const pair< int, int > &ij) const
 The colour/spin correlated matrix element.
 
bool calculateSpinCorrelator (const pair< int, int > &ij) const
 True, if the indexed spin correlated matrix element needs to be calculated.
 
Complex lastSpinCorrelator (const pair< int, int > &ij) const
 The spin correlated matrix element.
 
unsigned int nLight () const
 Return the number of light flavours to be considered for this process.
 
vector< long > nLightJetVec () const
 Return the vector that contains the PDG ids of the light flavours, which are contained in the jet particle group.
 
vector< long > nHeavyJetVec () const
 Return the vector that contains the PDG ids of the heavy flavours, which are contained in the jet particle group.
 
vector< long > nLightProtonVec () const
 Return the vector that contains the PDG ids of the light flavours, which are contained in the proton particle group.
 
size_t colourBasisDim () const
 Get the dimensionality of the colour basis for this process.
 
int nDimPhasespace () const
 Return the number of degrees of freedom required by the phase space generator.
 
int nDimAmplitude () const
 Return the number of degrees of freedom required by the amplitude.
 
int nDimInsertions () const
 Return the number of degrees of freedom required by the insertion operators.
 
const vector< double > & amplitudeRandomNumbers () const
 Get the additional random numbers required by the amplitude.
 
const vector< double > & insertionRandomNumbers () const
 Get the additional random numbers required by the insertion operator.
 
const map< int, double > & diagramWeights () const
 Return the diagram weights indexed by diagram id.
 
const set< pair< size_t, size_t > > & singularLimits () const
 Return the singular limits.
 
const set< pair< size_t, size_t > >::const_iterator & lastSingularLimit () const
 Return the last matched singular limit.
 
Ptr< StandardModel >::tcptr hwStandardModel () const
 Get the Herwig StandardModel object.
 
double symmetryFactor () const
 Return the symmetry factor.
 
const vector< int > & olpId () const
 Return the OLP process id.
 
double * olpMomenta () const
 Return the olp momentum vector.
 
void fillOLPMomenta (const vector< Lorentz5Momentum > &mm, const cPDVector &mePartonData, const map< long, Energy > &reshuffleMap) const
 Fill the olp momentum vector.
 

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

void setCoupling (long a, long b, long c, double coupling, bool includeCrossings=true)
 Set a coupling for the given vertex; the convention is that all legs are outgoing, and all possible crossings will be taken care of. 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 IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
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 &)
 
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (const Named &other)
 
const string & name (const string &newName)
 
- Protected Member Functions inherited from Herwig::LastMatchboxXCombInfo
vector< int > & crossingMap ()
 The crossing information as filled by the last call to fillCrossingMap()
 
map< size_t, size_t > & amplitudeToColourMap ()
 The colour crossing information as filled by the last call to fillCrossingMap()
 
map< size_t, size_t > & colourToAmplitudeMap ()
 The colour crossing information as filled by the last call to fillCrossingMap()
 
void crossingSign (double c)
 The crossing sign as filled by the last call to fillCrossingMap()
 
void lastRenormalizationScale (Energy2 lrs)
 The last renormalization scale.
 
cPDVectoramplitudePartonData ()
 The amplitude parton data.
 
vector< Lorentz5Momentum > & amplitudeMomenta ()
 The crossed momenta.
 
void haveTreeAmplitudes (bool f=true)
 True, if the the tree level amplitudes need to be calculated.
 
map< vector< int >, CVector > & lastAmplitudes ()
 The amplitude values which have been contributing to the last call of prepareAmplitudes.
 
map< vector< int >, CVector > & lastLargeNAmplitudes ()
 The leading N amplitude values which have been contributing to the last call of prepareAmplitudes.
 
void haveOneLoopAmplitudes (bool f=true)
 True, if the the one-loop amplitudes need to be calculated.
 
map< vector< int >, CVector > & lastOneLoopAmplitudes ()
 The one-loop amplitude values which have been contributing to the last call of prepareAmplitudes.
 
void lastTreeME2 (double v) const
 The last tree-level matrix element squared.
 
void lastLargeNME2 (double v) const
 The last tree-level matrix element squared.
 
void lastOneLoopInterference (double v) const
 The last one-loop/tree-level interference.
 
void lastOneLoopPoles (pair< double, double > v) const
 The last one-loop/tree-level interference.
 
void lastColourCorrelator (const pair< int, int > &ij, double v) const
 The colour correlated matrix element.
 
void lastLargeNColourCorrelator (const pair< int, int > &ij, double v) const
 The large-N colour correlated matrix element.
 
void lastColourSpinCorrelator (const pair< int, int > &ij, Complex v) const
 The colour/spin correlated matrix element.
 
void lastSpinCorrelator (const pair< int, int > &ij, Complex v) const
 The spin correlated matrix element.
 
void nLight (unsigned int n)
 Set the number of light flavours to be considered for this process.
 
void nLightJetVec (int n)
 Set the elements of the vector that contains the PDG ids of the light flavours, which are contained in the jet particle group.
 
void nHeavyJetVec (int n)
 Set the elements of the vector that contains the PDG ids of the heavy flavours, which are contained in the jet particle group.
 
void nLightProtonVec (int n)
 Set the elements of the vector that contains the PDG ids of the light flavours, which are contained in the proton particle group.
 
void colourBasisDim (size_t d)
 Set the dimensionality of the colour basis for this process.
 
void nDimPhasespace (int d)
 Set the number of degrees of freedom required by the phase space generator.
 
void nDimAmplitude (int d)
 Set the number of degrees of freedom required by the amplitude.
 
void nDimInsertions (int d)
 Set the number of degrees of freedom required by the insertion operators.
 
vector< double > & amplitudeRandomNumbers ()
 Access the additional random numbers required by the amplitude.
 
vector< double > & insertionRandomNumbers ()
 Access the additional random numbers required by the insertion operator.
 
map< int, double > & diagramWeights ()
 Access the diagram weights indexed by diagram id.
 
set< pair< size_t, size_t > > & singularLimits ()
 Access the singular limits.
 
set< pair< size_t, size_t > >::const_iterator & lastSingularLimit ()
 Access the last matched singular limit.
 
void hwStandardModel (Ptr< StandardModel >::tcptr sm)
 Set the Herwig StandardModel object.
 
void symmetryFactor (double f) const
 Set the symmetry factor.
 
void olpId (int pType, int id)
 Set the OLP process id.
 
void lastMatchboxXComb (tStdXCombPtr xc)
 Set the XComb pointer cast to MatchboxXComb.
 

Private Member Functions

string doSetCoupling (string)
 Interface function to setcoupling.
 
string doSetPhysicalCoupling (string)
 Interface function to setcoupling.
 
MatchboxPhasespaceoperator= (const MatchboxPhasespace &)=delete
 The assignment operator is private and must never be called. More...
 

Private Attributes

Energy singularCutoff
 A cutoff below which a region is considered singular.
 
bool theUseMassGenerators
 True, if mass generators should be used instead of fixed masses.
 
Ptr< PhasespaceCouplings >::ptr theCouplings
 Couplings to be used in diagram weighting.
 
int theLoopParticleIdMin
 The first id in a range of id's meant to denote fictitious 'ghost' particles to be used by the diagram generator in loop induced processes.
 
int theLoopParticleIdMax
 The last id in a range of id's meant to denote fictitious 'ghost' particles to be used by the diagram generator in loop induced processes.
 

Additional Inherited Members

- Public Types inherited from ThePEG::InterfacedBase
enum  InitState
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 
- Public Types inherited from ThePEG::LastXCombInfo< StandardXComb >
typedef ThePEG::Ptr< StandardXComb >::pointer XCPtr
 
typedef ThePEG::Ptr< StandardXComb >::const_pointer cXCPtr
 
typedef ThePEG::Ptr< StandardXComb >::transient_pointer tXCPtr
 
typedef ThePEG::Ptr< StandardXComb >::transient_const_pointer tcXCPtr
 
- 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)
 
- Protected Attributes inherited from ThePEG::LastXCombInfo< StandardXComb >
XCPtr theLastXComb
 
- Protected Attributes inherited from Herwig::LastMatchboxXCombInfo
MatchboxXCombDatatheLastMatchboxXComb
 The XComb pointer cast to MatchboxXComb.
 
MatchboxXCombDatatheLastHeadMatchboxXComb
 The head XComb pointer cast to MatchboxXComb.
 

Detailed Description

MatchboxPhasespace defines an abstract interface to a phase space generator.

Author
Simon Platzer

Definition at line 79 of file MatchboxPhasespace.h.

Member Function Documentation

◆ Init()

static void Herwig::MatchboxPhasespace::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=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ setCoupling()

void Herwig::MatchboxPhasespace::setCoupling ( long  a,
long  b,
long  c,
double  coupling,
bool  includeCrossings = true 
)
protected

Set a coupling for the given vertex; the convention is that all legs are outgoing, and all possible crossings will be taken care of.

If not set, coupling weights default to one.


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