thepeg is hosted by Hepforge, IPPP Durham
ThePEG 2.3.0
ThePEG::PartonBinInstance Class Reference

PartonBinInstance is used to store information about the generation of a given parton extraction for a corresponding PartonBin object. More...

#include <PartonBinInstance.h>

Inheritance diagram for ThePEG::PartonBinInstance:

Public Member Functions

Standard constructors and destructors.
 PartonBinInstance ()
 Default constructor.
 
 PartonBinInstance (const PartonBinInstance &)
 Copy-constructor.
 
virtual ~PartonBinInstance ()
 Destructor.
 
 PartonBinInstance (tcPBPtr, tPBIPtr=tPBIPtr())
 Constructor taking a PartonBin as argument.
 
 PartonBinInstance (tPPtr parton, tcPBPtr pb, Energy2 scale=ZERO)
 Constructor using an already prepared extracted parton.
 
 PartonBinInstance (tPPtr particle, tPPtr parton, tcPBPtr pb, Energy2 scale=ZERO)
 Constructor using a parton which is to be extracted from the given particle, but no mother-child relations exist, yet.
 
Access information about the corresponding PartonBin object.
tcPBPtr bin () const
 Return a pointer to the PartonBin this instance refer to.
 
const PartonVector & bins () const
 Return pointers to the bins this instance refer to in case more than one parton has been extracted.
 
tcPDPtr particleData () const
 Return a pointer to the data object of the incoming particle.
 
tcPDPtr partonData () const
 Return a pointer to the data object of the extracted parton.
 
tPBIPtr incoming () const
 In the case the incoming particle in turn is extracted from another particle, return the PartonBinInstance for that extraction.
 
tPBIPtr getFirst ()
 Return the parton bin instance corresponding to the first incoming particle for this bin.
 
tcPDFPtr pdf () const
 The PDFBase object describing the momentum distribution of the parton within the particle in this PartonBin.
 
tcRemHPtr remnantHandler () const
 The remnant handler associated with the pdf().
 
bool hasPoleIn1 () const
 Return true if the corresponding PDFs has a pole at $x=1$ for the current particle/parton combination.
 
Functions used for the generation.
void reset (double lx=0, Energy2 Q2=ZERO)
 Reset the current PartonBin, making room for a new event.
 
void prepare ()
 Reset last generated l and Q2 values of this and parent bins.
 
void generate (const double *r)
 Generate l and Q2 of this and parent bins.
 
double jacobian () const
 Get the jacobian associated with the phase space point generated.
 
void jacobian (double j)
 Set the jacobian associated with the phase space point generated.
 
Access information about the generated extraction.
tPPtr particle () const
 Get the current particle instance.
 
void particle (tPPtr p)
 Set the current particle instance.
 
tPPtr parton () const
 Get the current parton instance.
 
void parton (tPPtr p)
 Set the current parton instance.
 
const PVectorpartons () const
 The currently extracted partons (in case of multiple interactions.
 
double xi () const
 Get the momentum fraction of this parton w.r.t.
 
double eps () const
 Get one minus the momentum fraction of this parton w.r.t.
 
double li () const
 Get the logarithmic momentum fraction of this parton w.r.t.
 
void li (double lx)
 Set the logarithmic momentum fraction of this parton w.r.t.
 
double x () const
 Get the momentum fraction of this parton w.r.t.
 
double l () const
 Get the logarithmic momentum fraction of this parton w.r.t.
 
void l (double lx)
 Set the logarithmic momentum fraction of this parton w.r.t.
 
Energy2 scale () const
 Get the scale at which the current parton was extracted.
 
void scale (Energy2 s)
 Set the scale at which the current parton was extracted.
 
const TransverseMomentumkT () const
 Return the transverse momentum of the extracted parton.
 
double remnantWeight () const
 Get the weight associated with the remnant generation.
 
void remnantWeight (double w)
 Set the weight associated with the remnant generation.
 
const PVectorremnants () const
 Get the current remnants.
 
void remnants (const PVector &rems)
 Set the current remnants.
 
tRemIPtr remnantInfo () const
 Get information saved by the remnant handler from the generation, to be used in the construction of the remnants.
 
void remnantInfo (tRemIPtr ri)
 Set information saved by the remnant handler from the generation, to be used in the construction of the remnants.
 
- Public Member Functions inherited from ThePEG::Base
virtual ~Base ()
 The virtual destructor.
 
void debug () const
 Print out debugging information for this object on std::cerr.
 
virtual void debugme () const
 Print out debugging information for this object on std::cerr.
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 Return the reference count.
 

Functions used by the persistent I/O system.

cPBPtr theBin
 Pointer to the main bin this instance refer to.
 
PartonVector theBins
 Pointer to the main bin (and secondary in case several partons have been extracted this instance refer to.
 
PBIPtr theIncoming
 In the case the incoming particle in turn is extracted from another particle, this is the PartonBinInstance for that extraction.
 
double theJacobian
 The jacobian associated with the phase space point generated.
 
PPtr theParticle
 The current particle instance.
 
PPtr theParton
 The current parton instance.
 
PVector thePartons
 The currently extracted partons (in case of multiple interactions.
 
double theXi
 The momentum fraction (xi, li=log(xi), eps=1-xi), of this parton w.r.t.
 
double theEps
 The momentum fraction (xi, li=log(xi), eps=1-xi), of this parton w.r.t.
 
double theLi
 The momentum fraction (xi, li=log(xi), eps=1-xi), of this parton w.r.t.
 
double theX
 The momentum fraction (x, l=log(x)) of this parton w.r.t.
 
double theL
 The momentum fraction (x, l=log(x)) of this parton w.r.t.
 
Energy2 theScale
 The scale at which the current parton was extracted.
 
TransverseMomentum theKT
 The transverse momentum of the extracted parton.
 
double theRemnantWeight
 The weight associated with the remnant generation.
 
PVector theRemnants
 The current remnants.
 
RemIPtr theRemInfo
 The information saved by the remnant handler from the generation, to be used in the construction of the remnants.
 
static ClassDescription< PartonBinInstanceinitPartonBinInstance
 Describe a concrete class with persistent data.
 
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently.
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently.
 
static void Init ()
 Standard Init function used to initialize the interfaces.
 
PartonBinInstanceoperator= (const PartonBinInstance &)=delete
 Private and non-existent assignment operator.
 

Additional Inherited Members

- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 The integer type used for counting.
 
- Static Public Member Functions inherited from ThePEG::Base
static void Init ()
 The standard Init function used to initialize the interfaces.
 
- Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long uniqueId
 The unique ID.
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted ()
 Default constructor.
 
 ReferenceCounted (const ReferenceCounted &)
 Copy-constructor.
 
ReferenceCountedoperator= (const ReferenceCounted &)
 Assignment.
 

Detailed Description

PartonBinInstance is used to store information about the generation of a given parton extraction for a corresponding PartonBin object.

Definition at line 28 of file PartonBinInstance.h.

Constructor & Destructor Documentation

◆ PartonBinInstance() [1/3]

ThePEG::PartonBinInstance::PartonBinInstance ( tcPBPtr  ,
tPBIPtr  = tPBIPtr() 
)

Constructor taking a PartonBin as argument.

The second argument should be used if the incoming bin is already known and exists.

◆ PartonBinInstance() [2/3]

ThePEG::PartonBinInstance::PartonBinInstance ( tPPtr  parton,
tcPBPtr  pb,
Energy2  scale = ZERO 
)

Constructor using an already prepared extracted parton.

This will also initialize the x, and scale values. To calculate the momentum fractions, a Direction<0> object must have been properly initialized.

Parameters
partonthe extracted parton which must have its first parent set to define the particle extracted from.
pbthe PartonBin object corresponding to the extracted parton. If the particle extracted from in turn has been extracted, the incoming() member of the PartonBin must point to the corresponding PartonBin.
scalethe resolution scale at which the parton was extracted.

◆ PartonBinInstance() [3/3]

ThePEG::PartonBinInstance::PartonBinInstance ( tPPtr  particle,
tPPtr  parton,
tcPBPtr  pb,
Energy2  scale = ZERO 
)

Constructor using a parton which is to be extracted from the given particle, but no mother-child relations exist, yet.

This will also initialize the x, and scale values. To calculate the momentum fractions, a Direction<0> object must have been properly initialized.

Member Function Documentation

◆ bin()

tcPBPtr ThePEG::PartonBinInstance::bin ( ) const
inline

Return a pointer to the PartonBin this instance refer to.

Definition at line 93 of file PartonBinInstance.h.

References theBin.

Referenced by particleData(), partonData(), pdf(), and remnantHandler().

◆ bins()

const PartonVector & ThePEG::PartonBinInstance::bins ( ) const
inline

Return pointers to the bins this instance refer to in case more than one parton has been extracted.

Definition at line 99 of file PartonBinInstance.h.

References theBins.

◆ eps()

double ThePEG::PartonBinInstance::eps ( ) const
inline

Get one minus the momentum fraction of this parton w.r.t.

the incoming particle in this bin.

Definition at line 212 of file PartonBinInstance.h.

References ThePEG::Math::exp1m(), li(), and theEps.

◆ incoming()

tPBIPtr ThePEG::PartonBinInstance::incoming ( ) const
inline

In the case the incoming particle in turn is extracted from another particle, return the PartonBinInstance for that extraction.

Definition at line 116 of file PartonBinInstance.h.

References theIncoming.

◆ jacobian() [1/2]

double ThePEG::PartonBinInstance::jacobian ( ) const
inline

Get the jacobian associated with the phase space point generated.

Definition at line 162 of file PartonBinInstance.h.

References theJacobian.

◆ jacobian() [2/2]

void ThePEG::PartonBinInstance::jacobian ( double  j)
inline

Set the jacobian associated with the phase space point generated.

Definition at line 167 of file PartonBinInstance.h.

References theJacobian.

◆ kT()

const TransverseMomentum & ThePEG::PartonBinInstance::kT ( ) const
inline

Return the transverse momentum of the extracted parton.

Definition at line 273 of file PartonBinInstance.h.

References theKT.

◆ l() [1/2]

double ThePEG::PartonBinInstance::l ( ) const
inline

Get the logarithmic momentum fraction of this parton w.r.t.

the collidig particles.

Definition at line 247 of file PartonBinInstance.h.

References theL.

Referenced by x().

◆ l() [2/2]

void ThePEG::PartonBinInstance::l ( double  lx)
inline

Set the logarithmic momentum fraction of this parton w.r.t.

the collidig particles.

Definition at line 253 of file PartonBinInstance.h.

References theL, and theX.

◆ li() [1/2]

double ThePEG::PartonBinInstance::li ( ) const
inline

Get the logarithmic momentum fraction of this parton w.r.t.

the incoming particle in this bin.

Definition at line 221 of file PartonBinInstance.h.

References theLi.

Referenced by eps(), and xi().

◆ li() [2/2]

void ThePEG::PartonBinInstance::li ( double  lx)
inline

Set the logarithmic momentum fraction of this parton w.r.t.

the incoming particle in this bin.

Definition at line 227 of file PartonBinInstance.h.

References theEps, theLi, and theXi.

◆ particle() [1/2]

tPPtr ThePEG::PartonBinInstance::particle ( ) const
inline

Get the current particle instance.

Definition at line 175 of file PartonBinInstance.h.

References theParticle.

◆ particle() [2/2]

void ThePEG::PartonBinInstance::particle ( tPPtr  p)
inline

Set the current particle instance.

Definition at line 180 of file PartonBinInstance.h.

References theParticle.

◆ particleData()

tcPDPtr ThePEG::PartonBinInstance::particleData ( ) const
inline

Return a pointer to the data object of the incoming particle.

Definition at line 104 of file PartonBinInstance.h.

References bin().

◆ parton() [1/2]

tPPtr ThePEG::PartonBinInstance::parton ( ) const
inline

Get the current parton instance.

Definition at line 185 of file PartonBinInstance.h.

References theParton.

◆ parton() [2/2]

void ThePEG::PartonBinInstance::parton ( tPPtr  p)
inline

Set the current parton instance.

Definition at line 190 of file PartonBinInstance.h.

References theParton.

◆ partonData()

tcPDPtr ThePEG::PartonBinInstance::partonData ( ) const
inline

Return a pointer to the data object of the extracted parton.

Definition at line 109 of file PartonBinInstance.h.

References bin().

◆ partons()

const PVector & ThePEG::PartonBinInstance::partons ( ) const
inline

The currently extracted partons (in case of multiple interactions.

Definition at line 196 of file PartonBinInstance.h.

References thePartons.

◆ pdf()

tcPDFPtr ThePEG::PartonBinInstance::pdf ( ) const
inline

The PDFBase object describing the momentum distribution of the parton within the particle in this PartonBin.

Definition at line 128 of file PartonBinInstance.h.

References bin().

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ remnantHandler()

tcRemHPtr ThePEG::PartonBinInstance::remnantHandler ( ) const
inline

The remnant handler associated with the pdf().

Definition at line 133 of file PartonBinInstance.h.

References bin().

◆ remnantInfo() [1/2]

tRemIPtr ThePEG::PartonBinInstance::remnantInfo ( ) const
inline

Get information saved by the remnant handler from the generation, to be used in the construction of the remnants.

(In addition the remnantWeight and remnants() may be used for this purpose.)

Definition at line 300 of file PartonBinInstance.h.

References theRemInfo.

◆ remnantInfo() [2/2]

void ThePEG::PartonBinInstance::remnantInfo ( tRemIPtr  ri)
inline

Set information saved by the remnant handler from the generation, to be used in the construction of the remnants.

(In addition the remnantWeight and remnants() may be used for this purpose.)

Definition at line 307 of file PartonBinInstance.h.

References theRemInfo.

◆ remnants() [1/2]

const PVector & ThePEG::PartonBinInstance::remnants ( ) const
inline

Get the current remnants.

Definition at line 288 of file PartonBinInstance.h.

References theRemnants.

◆ remnants() [2/2]

void ThePEG::PartonBinInstance::remnants ( const PVector rems)
inline

Set the current remnants.

Definition at line 293 of file PartonBinInstance.h.

References theRemnants.

◆ remnantWeight() [1/2]

double ThePEG::PartonBinInstance::remnantWeight ( ) const
inline

Get the weight associated with the remnant generation.

Definition at line 278 of file PartonBinInstance.h.

References theRemnantWeight.

◆ remnantWeight() [2/2]

void ThePEG::PartonBinInstance::remnantWeight ( double  w)
inline

Set the weight associated with the remnant generation.

Definition at line 283 of file PartonBinInstance.h.

References theRemnantWeight.

◆ scale() [1/2]

Energy2 ThePEG::PartonBinInstance::scale ( ) const
inline

Get the scale at which the current parton was extracted.

Definition at line 262 of file PartonBinInstance.h.

References theScale.

◆ scale() [2/2]

void ThePEG::PartonBinInstance::scale ( Energy2  s)
inline

Set the scale at which the current parton was extracted.

Definition at line 268 of file PartonBinInstance.h.

References theScale.

◆ x()

double ThePEG::PartonBinInstance::x ( ) const
inline

Get the momentum fraction of this parton w.r.t.

the collidig particles.

Definition at line 237 of file PartonBinInstance.h.

References l(), and theX.

◆ xi()

double ThePEG::PartonBinInstance::xi ( ) const
inline

Get the momentum fraction of this parton w.r.t.

the incoming particle in this bin.

Definition at line 202 of file PartonBinInstance.h.

References li(), and theXi.

Member Data Documentation

◆ initPartonBinInstance

ClassDescription<PartonBinInstance> ThePEG::PartonBinInstance::initPartonBinInstance
staticprivate

Describe a concrete class with persistent data.

Definition at line 436 of file PartonBinInstance.h.

◆ theBin

cPBPtr ThePEG::PartonBinInstance::theBin
private

Pointer to the main bin this instance refer to.

Definition at line 338 of file PartonBinInstance.h.

Referenced by bin().

◆ theBins

PartonVector ThePEG::PartonBinInstance::theBins
private

Pointer to the main bin (and secondary in case several partons have been extracted this instance refer to.

Definition at line 344 of file PartonBinInstance.h.

Referenced by bins().

◆ theEps

double ThePEG::PartonBinInstance::theEps
mutableprivate

The momentum fraction (xi, li=log(xi), eps=1-xi), of this parton w.r.t.

the incoming particle in this bin.

Definition at line 385 of file PartonBinInstance.h.

Referenced by eps(), and li().

◆ theIncoming

PBIPtr ThePEG::PartonBinInstance::theIncoming
private

In the case the incoming particle in turn is extracted from another particle, this is the PartonBinInstance for that extraction.

Definition at line 351 of file PartonBinInstance.h.

Referenced by incoming().

◆ theJacobian

double ThePEG::PartonBinInstance::theJacobian
private

The jacobian associated with the phase space point generated.

Definition at line 356 of file PartonBinInstance.h.

Referenced by jacobian().

◆ theKT

TransverseMomentum ThePEG::PartonBinInstance::theKT
private

The transverse momentum of the extracted parton.

Definition at line 412 of file PartonBinInstance.h.

Referenced by kT().

◆ theL

double ThePEG::PartonBinInstance::theL
private

The momentum fraction (x, l=log(x)) of this parton w.r.t.

the collidig particles.

Definition at line 402 of file PartonBinInstance.h.

Referenced by l().

◆ theLi

double ThePEG::PartonBinInstance::theLi
private

The momentum fraction (xi, li=log(xi), eps=1-xi), of this parton w.r.t.

the incoming particle in this bin.

Definition at line 391 of file PartonBinInstance.h.

Referenced by li().

◆ theParticle

PPtr ThePEG::PartonBinInstance::theParticle
private

The current particle instance.

Definition at line 361 of file PartonBinInstance.h.

Referenced by particle().

◆ theParton

PPtr ThePEG::PartonBinInstance::theParton
private

The current parton instance.

Definition at line 366 of file PartonBinInstance.h.

Referenced by parton().

◆ thePartons

PVector ThePEG::PartonBinInstance::thePartons
private

The currently extracted partons (in case of multiple interactions.

Definition at line 372 of file PartonBinInstance.h.

Referenced by partons().

◆ theRemInfo

RemIPtr ThePEG::PartonBinInstance::theRemInfo
private

The information saved by the remnant handler from the generation, to be used in the construction of the remnants.

(In addition the remnantWeight and lastRemnants() may be used for this purpose.)

Definition at line 429 of file PartonBinInstance.h.

Referenced by remnantInfo().

◆ theRemnants

PVector ThePEG::PartonBinInstance::theRemnants
private

The current remnants.

Definition at line 422 of file PartonBinInstance.h.

Referenced by remnants().

◆ theRemnantWeight

double ThePEG::PartonBinInstance::theRemnantWeight
private

The weight associated with the remnant generation.

Definition at line 417 of file PartonBinInstance.h.

Referenced by remnantWeight().

◆ theScale

Energy2 ThePEG::PartonBinInstance::theScale
private

The scale at which the current parton was extracted.

Definition at line 407 of file PartonBinInstance.h.

Referenced by scale().

◆ theX

double ThePEG::PartonBinInstance::theX
mutableprivate

The momentum fraction (x, l=log(x)) of this parton w.r.t.

the collidig particles.

Definition at line 397 of file PartonBinInstance.h.

Referenced by l(), and x().

◆ theXi

double ThePEG::PartonBinInstance::theXi
mutableprivate

The momentum fraction (xi, li=log(xi), eps=1-xi), of this parton w.r.t.

the incoming particle in this bin.

Definition at line 379 of file PartonBinInstance.h.

Referenced by li(), and xi().


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