thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.1.5
ThePEG::RemnantHandler Class Referenceabstract

RemnantHandler is an abstract base class for implementing classes used to generate remnants when partons are extracted from particles. More...

#include <RemnantHandler.h>

Inheritance diagram for ThePEG::RemnantHandler:

Public Member Functions

bool multiCapable () const
 Return true if this remnant handler is able to handle multiple extractions of partons from the same particle.
 
Standard constructors and destructors.
 RemnantHandler (bool multi=false)
 Default constructor. More...
 
Virtual functions to be overridden by sub-classes.
virtual bool canHandle (tcPDPtr particle, const cPDVector &partons) const =0
 Return true if this remnant handler can handle extracting all specified partons from the given particle.
 
virtual int nDim (const PartonBin &pb, bool doScale) const
 If the generation of remnants is expected to influence the actual cross section of the hard sub process, the degrees of freedom generated by this remnant handler may be included in the general phase space sampling for the subprocess. More...
 
virtual Lorentz5Momentum generate (PartonBinInstance &pb, const double *r, Energy2 scale, const LorentzMomentum &parent, bool fixedPartonMomentum=false) const =0
 Generate the momentum of the extracted parton with the parent momentum given by the last argument. More...
 
virtual Lorentz5Momentum generate (PartonBinInstance &pb, const double *r, Energy2 scale, Energy2 shat, const LorentzMomentum &parent, bool fixedPartonMomentum=false) const =0
 Generate the momentum of the extracted parton with the parent momentum given by the last argument. More...
 
virtual void boostRemnants (PartonBinInstance &pb) const
 Boost the generated remnants to the proper momentum given the information in the parton bin, pb.
 
virtual bool recreateRemnants (PartonBinInstance &pb, tPPtr oldp, tPPtr newp, double newl, Energy2 scale, const LorentzMomentum &p, const PVector &prev=PVector()) const
 Redo the remnant generation for the given particle bin, pb. More...
 
virtual bool recreateRemnants (PartonBinInstance &pb, tPPtr oldp, tPPtr newp, double newl, Energy2 scale, Energy2 shat, const LorentzMomentum &p, const PVector &prev=PVector()) const
 Redo the remnant generation for the given particle bin, pb. More...
 
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 ThePEG::HandlerBaseT< UseRandom >
double rnd () const
 Return a simple flat random number in the range ]0,1[.
 
double rnd (double xu) const
 Return a simple flat random number in the range ]0,xu[.
 
double rnd (double xl, double xu) const
 Return a simple flat random number in the range ]xl,xu[.
 
bool rndbool () const
 Return true with 50% probability.
 
bool rndbool (double p) const
 Return a true with probability p.
 
bool rndbool (double p1, double p2) const
 Return a true with probability p1/(p1+p2).
 
int rndsign (double p1, double p2, double p3) const
 Return -1, 0, or 1 with relative probabilities p1, p2, p3.
 
int rnd2 (double p0, double p1) const
 Return an integer $i$ with probability p $i$/(p0+p1).
 
int rnd3 (double p0, double p1, double p2) const
 Return an integer $i$ with probability p $i$/(p0+p1+p2).
 
int rnd4 (double p0, double p1, double p2, double p3) const
 Return an integer/ $i$ with probability p $i$(p0+p1+p2+p3).
 
long irnd (long xu=2) const
 Return a simple flat random integrer number in the range [0,xu[.
 
long irnd (long xl, long xu) const
 Return a simple flat random integrer number in the range [xl,xu[.
 
const StandardModelBaseSM () const
 Return a reference to the object containing the standard model parameters for this run.
 
tSMPtr standardModel () const
 Return a pointer to the object containing the standard model parameters for this run.
 
virtual ~HandlerBaseT ()
 Destructor.
 
- Public Member Functions inherited from ThePEG::Interfaced
virtual ~Interfaced ()
 Empty virtual destructor.
 
virtual bool defaultInit ()
 Functions which are to be used during the actual event generation, after the setup is complete. More...
 
PPtr getParticle (PID) const
 Create a new Particle instance given a id number.
 
PDPtr getParticleData (PID) const
 Return a pointer to the ParticleData object corresponding to the given id number.
 
bool used () const
 Returns true if this object has actally been used.
 
void useMe () const
 Should be called to indicate that this object has actually been used.
 
tEGPtr generator () const
 Return a pointer to the EventGenerator controlling the run. More...
 
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 ThePEG::InterfacedBase
virtual ~InterfacedBase ()
 The virtual (empty) destructor;.
 
string fullName () const
 Returns the full name of this object including its path, e.g. More...
 
string name () const
 Returns the name of this object, without the path.
 
string path () const
 Returns the path to this object including the trailing '/'. More...
 
string comment () const
 Returns a comment assigned to this object.
 
void setup (istream &is)
 Read setup info from a standard istream is. More...
 
virtual IBPtr fullclone () const
 Return a full clone of this object possibly doing things to the clone to make it sane.
 
virtual void debugme () const
 Print out debugging information for this object on std::cerr. More...
 
void update ()
 Calls the doupdate() function with recursion prevention.
 
void init ()
 Calls the doinit() function with recursion prevention.
 
virtual bool preInitialize () const
 Return true if this object needs to be initialized before all other objects (except those for which this function also returns true). More...
 
void initrun ()
 Calls the doinitrun() function with recursion prevention.
 
void finish ()
 Calls the dofinish() function with recursion prevention.
 
void touch ()
 This function should be called every time something in this object has changed in a way that a sanity check with update() is needed.
 
void reset ()
 Set the state of this object to uninitialized.
 
void clear ()
 Calls reset() and unTouch().
 
InitState state () const
 Return the state of initialization of this object.
 
bool locked () const
 Return true if the BaseRepository is not allowed to change the state of this object.
 
bool touched () const
 Return true if the state of this object has been changed since the last call to update().
 
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 ThePEG::Base
virtual ~Base ()
 The virtual destructor.
 
void debug () const
 Print out debugging information for this object on std::cerr. More...
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 Return the reference count.
 
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 Constructor with name.
 
 Named (const Named &)=default
 Explicit default copy-constructor (too avoid compiler warnings)
 
const string & name () const
 Return name.
 
bool operator== (const Named &other) const
 Test for equality.
 
bool operator< (const Named &other) const
 Lexicographical comparison.
 

Static Public Member Functions

static void Init ()
 Standard Init function used to initialize the interface.
 
- Static Public Member Functions inherited from ThePEG::HandlerBase
static void Init ()
 Standard Init function used to initialize the interface.
 
- Static Public Member Functions inherited from ThePEG::Interfaced
static void Init ()
 Standard Init function.
 
- Static Public Member Functions inherited from ThePEG::InterfacedBase
static void Init ()
 Standard Init function.
 
- Static Public Member Functions inherited from ThePEG::Base
static void Init ()
 The standard Init function used to initialize the interfaces. More...
 

Protected Attributes

bool isMultiCapable
 True if this handler can generate remnants also if several partons have been extracted.
 

Private Member Functions

RemnantHandleroperator= (const RemnantHandler &)=delete
 Private and non-existent assignment operator.
 

Static Private Attributes

static AbstractClassDescription< RemnantHandlerinitRemnantHandler
 The static object used to initialize the description of this class. More...
 

Additional Inherited Members

- Public Types inherited from ThePEG::InterfacedBase
enum  InitState { initializing = -1, uninitialized = 0, initialized = 1, runready = 2 }
 Enumeration reflecting the state of an InterfacedBase object. More...
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 The integer type used for counting.
 
- Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long uniqueId
 The unique ID. More...
 
- Protected Member Functions inherited from ThePEG::Interfaced
void reporeg (IBPtr object, string name) const
 Register the given object in the Repository with the given name in a subdirectory with the same name as this object. More...
 
template<typename PtrT >
bool setDefaultReference (PtrT &ptr, string classname, string objectname)
 If the pointer, ptr, to an object is not set, create an object of class classname and register it with the Repository with the given objectname in a sib-directory with the same name as this object.
 
 Interfaced ()
 Protected default constructor.
 
 Interfaced (const string &newName)
 Protected constructor taking a name as argument.
 
 Interfaced (const Interfaced &i)
 Protected copy-constructor.
 
void setGenerator (tEGPtr generator)
 Protected function to reset the generator pointer, required for automatic decayer generation in Herwig++ BSM models.
 
- Protected Member Functions inherited from ThePEG::InterfacedBase
virtual IBPtr clone () const =0
 Return a simple clone of this object. More...
 
 InterfacedBase ()
 Protected default constructor.
 
 InterfacedBase (string newName)
 Protected constructor with the name given as argument.
 
 InterfacedBase (const InterfacedBase &i)
 Protected copy-constructor.
 
virtual void readSetup (istream &is)
 Read setup info from a standard istream is. More...
 
virtual void doupdate ()
 Check sanity of the object during the setup phase. More...
 
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk. More...
 
virtual void doinitrun ()
 Initialize this object. More...
 
virtual void dofinish ()
 Finalize this object. More...
 
virtual IVector getReferences ()
 Return a vector of all pointers to Interfaced objects used in this object. More...
 
virtual void rebind (const TranslationMap &)
 Rebind pointer to other Interfaced objects. More...
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted ()
 Default constructor.
 
 ReferenceCounted (const ReferenceCounted &)
 Copy-constructor.
 
ReferenceCountedoperator= (const ReferenceCounted &)
 Assignment.
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (const Named &other)
 Assignment.
 
const string & name (const string &newName)
 Set new name.
 
- Static Protected Member Functions inherited from ThePEG::Interfaced
static void registerRepository (IBPtr)
 Register an Interfaced object with the Repository.
 
static void registerRepository (IBPtr, string newName)
 Register an Interfaced object with the Repository, giving it a name.
 

Detailed Description

RemnantHandler is an abstract base class for implementing classes used to generate remnants when partons are extracted from particles.

See also
The interfaces defined for RemnantHandler.
PartonExtractor
PDFBase

Definition at line 31 of file RemnantHandler.h.

Constructor & Destructor Documentation

◆ RemnantHandler()

ThePEG::RemnantHandler::RemnantHandler ( bool  multi = false)

Default constructor.

If multi is true the derived class can be used to extract more than one parton.

Member Function Documentation

◆ generate() [1/2]

virtual Lorentz5Momentum ThePEG::RemnantHandler::generate ( PartonBinInstance pb,
const double *  r,
Energy2  scale,
const LorentzMomentum parent,
bool  fixedPartonMomentum = false 
) const
pure virtual

Generate the momentum of the extracted parton with the parent momentum given by the last argument.

If the scale is negative, it means that the doScale in the previous call to nDim() was true, otherwise the given scale should be the virtuality of the extracted parton. Generated quantities which are not returned in the momentum may be saved in the PartonBinInstance, pb, for later use. In particular, if the nDim() random numbers, r, are not enough to generate with weight one, the resulting weight should be stored with the remnantWeight() method of the parton bin.

Implemented in ThePEG::UnResolvedRemnant, ThePEG::SoftRemnantHandler, and ThePEG::NoRemnants.

◆ generate() [2/2]

virtual Lorentz5Momentum ThePEG::RemnantHandler::generate ( PartonBinInstance pb,
const double *  r,
Energy2  scale,
Energy2  shat,
const LorentzMomentum parent,
bool  fixedPartonMomentum = false 
) const
pure virtual

Generate the momentum of the extracted parton with the parent momentum given by the last argument.

If the scale is negative, it means that the doScale in the previous call to nDim() was true, otherwise the given scale should be the virtuality of the extracted parton. shat is the total invariant mass squared of the hard sub-system produced by the extracted parton and the primary parton entering from the other side. Generated quantities which are not returned in the momentum may be saved in the PartonBinInstance, pb, for later use. In particular, if the nDim() random numbers, r, are not enough to generate with weight one, the resulting weight should be stored with the remnantWeight() method of the parton bin.

Implemented in ThePEG::UnResolvedRemnant, ThePEG::SoftRemnantHandler, and ThePEG::NoRemnants.

◆ nDim()

virtual int ThePEG::RemnantHandler::nDim ( const PartonBin pb,
bool  doScale 
) const
virtual

If the generation of remnants is expected to influence the actual cross section of the hard sub process, the degrees of freedom generated by this remnant handler may be included in the general phase space sampling for the subprocess.

In this case this function should be overridden to return the number of degrees of freedom used in the generation. If doScale is false, it means that the actual virtuality of the extracted parton will be obtained from another source.

Reimplemented in ThePEG::UnResolvedRemnant.

◆ persistentInput()

void ThePEG::RemnantHandler::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.

Referenced by multiCapable().

◆ persistentOutput()

void ThePEG::RemnantHandler::persistentOutput ( PersistentOStream os) const

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

Referenced by multiCapable().

◆ recreateRemnants() [1/2]

virtual bool ThePEG::RemnantHandler::recreateRemnants ( PartonBinInstance pb,
tPPtr  oldp,
tPPtr  newp,
double  newl,
Energy2  scale,
const LorentzMomentum p,
const PVector prev = PVector() 
) const
virtual

Redo the remnant generation for the given particle bin, pb.

If oldp is non-null it corresponds to the previously extracted parton which should be replaced by newp. If oldp is null it means newp should be extracted in addition to the previously extracted ones available in prev.

Returns
false if the generation failed.

Reimplemented in ThePEG::SoftRemnantHandler, and ThePEG::UnResolvedRemnant.

◆ recreateRemnants() [2/2]

virtual bool ThePEG::RemnantHandler::recreateRemnants ( PartonBinInstance pb,
tPPtr  oldp,
tPPtr  newp,
double  newl,
Energy2  scale,
Energy2  shat,
const LorentzMomentum p,
const PVector prev = PVector() 
) const
virtual

Redo the remnant generation for the given particle bin, pb.

If oldp is non-null it corresponds to the previously extracted parton which should be replaced by newp. If oldp is null it means newp should be extracted in addition to the previously extracted ones available in prev. In either case shat is the total invariant mass squared of the hard sub-system produced by the extracted parton and the primary parton entering from the other side.

Returns
false if the generation failed.

Reimplemented in ThePEG::SoftRemnantHandler, and ThePEG::UnResolvedRemnant.

Member Data Documentation

◆ initRemnantHandler

AbstractClassDescription<RemnantHandler> ThePEG::RemnantHandler::initRemnantHandler
staticprivate

The static object used to initialize the description of this class.

Indicates that this is an abstract class with persistent data.

Definition at line 182 of file RemnantHandler.h.


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