ThePEG  1.8.0
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes
ThePEG::RemnantDecayer Class Reference

The RemnantDecayer class is the base class to be used for all decayers capable of decaying a RemnantParticle object produced by a SoftRemnantHandler object. More...

#include <RemnantDecayer.h>

Inheritance diagram for ThePEG::RemnantDecayer:
Inheritance graph
[legend]

List of all members.

Classes

struct  SubSystemFail
 Exception used if getSubSystem fails. More...

Public Types

enum  RecoilOption { boostAll, boostFinal, copyFinal }
 Enumerate the options for how to distribute recoils in the hard subsystem when taking energy to produce remnants. More...
typedef Ptr< PtGenerator >::pointer PtGPtr
 A pointer to a PtGenerator object.

Public Member Functions

virtual bool canHandle (tcPDPtr parent, tcPDPtr extracted) const
 Return true if this decayer can handle the extraction of the extracted parton from the given particle.
virtual bool checkExtract (tcPPtr parent, tcPPtr extracted, const LorentzMomentum &pnew) const
 Return true if this decayer can handle the extraction of the extracted parton instance from the given particle instance.
virtual bool multiCapable () const
 Return true if this decayed can extract more than one parton from a particle.
RecoilOption recoilOption () const
 The option for how to distribute recoils in the hard subsystem when taking energy to produce remnants.
int respectDISKinematics () const
 If true, do not boost a scattered lepton (and possible radiated photons) in a DIS event, to ensure that $x$ and $Q^2$ is unmodified.
PtGPtr pTGenerator () const
 An object capable of generating an intrinsic transverse momentum of the created remnants.
Standard constructors and destructors.
 RemnantDecayer ()
 The default constructor.
virtual ~RemnantDecayer ()
 The destructor.
Virtual functions required by the Decayer class.
virtual bool accept (const DecayMode &dm) const
 Check if this decayer can perfom the decay specified by the given decay mode.
virtual bool needsFullStep () const
 Return true if this Decayer need to access the full current step when a particle is decayed.
virtual ParticleVector decay (const DecayMode &dm, const Particle &p, Step &step) const =0
 Perform a decay for a given DecayMode and a given Particle instance.
virtual ParticleVector decay (const DecayMode &dm, const Particle &p) const
 Perform a decay for a given DecayMode and a given Particle instance.
Functions used by the persistent I/O system.
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.
- Public Member Functions inherited from ThePEG::Decayer
Ptr< Amplitude >::pointer amplitude () const
 Return an amplitude associated with this decay matrix element.
virtual double brat (const DecayMode &dm, const ParticleData &pd, double oldbrat) const
 Calculate branching ratio.
virtual double brat (const DecayMode &dm, const Particle &p, double oldbrat) const
 Calculate branching ratio.
virtual ParticleVector getChildren (const DecayMode &dm, const Particle &parent) const
 Produce the children.
virtual void finalBoost (const Particle &parent, const ParticleVector &children) const
 Boost the decay products.
virtual void setScales (const Particle &parent, const ParticleVector &children) const
 Set the scales.

Static Public Member Functions

static tPVector decayRemnants (const tPVector &particles, Step &step)
 Static function to decay al remnants among the given particles.
static void Init ()
 The standard Init function used to initialize the interfaces.
- Static Public Member Functions inherited from ThePEG::Decayer
static ParticleVector DecayParticle (tPPtr parent, Step &step, long maxtry=1000)
 Static function to administer the decay of a particle.

Protected Member Functions

tRemPDPtr data (tcRemPPtr remnant) const
 Access the RemnantData object of a remnant.
tcPPtr parent (tcRemPPtr remnant) const
 Access the parent of a remnant.
const PVectorextracted (tcRemPPtr remnant) const
 Access the vector of extracted particles of a remnant.
virtual void fillSubSystem (tPPtr p, set< tPPtr > &sub) const
 Recursively find all particles produced from an extracted parton.
virtual tPVector getSubSystem (tcPPtr parent, tPPtr parton) const
 Return the system of particles from the hard subsystem which may be used to shuffle momenta to get the remnants on-shell.
Standard Interfaced functions.
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk.
virtual bool preInitialize () const
 Return true if this object needs to be initialized before all other objects because it needs to extract cuts from the event file.

Static Protected Member Functions

static LorentzRotation getZBoost (const LorentzMomentum &p0, const LorentzMomentum &p)
 Return a small boost along the z-axis.

Protected Attributes

int respectDIS
 If true, do not boost a scattered lepton (and possible radiated photons) in a DIS event, to ensure that $x$ and $Q^2$ is unmodified.

Private Member Functions

RemnantDecayeroperator= (const RemnantDecayer &)
 The assignment operator is private and must never be called.

Private Attributes

RecoilOption theRecoilOption
 The option for how to distribute recoils in the hard subsystem when taking energy to produce remnants.
PtGPtr thePTGenerator
 An object capable of generating an intrinsic transverse momentum of the created remnants.

Static Private Attributes

static
AbstractClassDescription
< RemnantDecayer
initRemnantDecayer
 The static object used to initialize the description of this class.

Detailed Description

The RemnantDecayer class is the base class to be used for all decayers capable of decaying a RemnantParticle object produced by a SoftRemnantHandler object.

A derived class must implement the decay(const DecayMode &, const Particle &, Step &) function, while the decay(const DecayMode &, const Particle &) function should never be called.

See also:
The interfaces defined for RemnantDecayer.

Definition at line 34 of file RemnantDecayer.h.


Member Typedef Documentation

A pointer to a PtGenerator object.

Definition at line 39 of file RemnantDecayer.h.


Member Enumeration Documentation

Enumerate the options for how to distribute recoils in the hard subsystem when taking energy to produce remnants.

Enumerator:
boostAll 

Boost all particles in the hard subsystem.

boostFinal 

Boost only final state particles in hard subsystem.

copyFinal 

Boost copies of final state particles in hard subsystem.

Definition at line 47 of file RemnantDecayer.h.


Member Function Documentation

virtual bool ThePEG::RemnantDecayer::accept ( const DecayMode dm) const
virtual

Check if this decayer can perfom the decay specified by the given decay mode.

Parameters:
dmthe DecayMode describing the decay.
Returns:
true if this decayer can handle the given mode, otherwise false.

Implements ThePEG::Decayer.

Reimplemented in ThePEG::SimpleBaryonRemnantDecayer.

virtual bool ThePEG::RemnantDecayer::checkExtract ( tcPPtr  parent,
tcPPtr  extracted,
const LorentzMomentum pnew 
) const
virtual

Return true if this decayer can handle the extraction of the extracted parton instance from the given particle instance.

pnew is the momentum of the resulting remnant. The default version simply checks if the energy is positive.

Reimplemented in ThePEG::SimpleBaryonRemnantDecayer.

virtual ParticleVector ThePEG::RemnantDecayer::decay ( const DecayMode dm,
const Particle p,
Step step 
) const
pure virtual

Perform a decay for a given DecayMode and a given Particle instance.

This version allows the decaying particle to borrow energy/momentum from its sublings in the current step. This will be called by the standard DecayHandler if the needsFullStep() function returns true.

Parameters:
dmthe DecayMode describing the decay.
pthe Particle instance to be decayed.
stepthe current step in which to find possible siblings to shuffle energy with.
Returns:
a ParticleVector containing the decay products.

Reimplemented from ThePEG::Decayer.

Implemented in ThePEG::SimpleBaryonRemnantDecayer.

virtual ParticleVector ThePEG::RemnantDecayer::decay ( const DecayMode dm,
const Particle p 
) const
virtual

Perform a decay for a given DecayMode and a given Particle instance.

Parameters:
dmthe DecayMode describing the decay.
pthe Particle instance to be decayed.
Returns:
a ParticleVector containing the decay products.

Implements ThePEG::Decayer.

static tPVector ThePEG::RemnantDecayer::decayRemnants ( const tPVector particles,
Step step 
)
static

Static function to decay al remnants among the given particles.

The decay products are inserted in the step provided.

Returns:
a vector of the non-remnant particles together with the remnant decay products.
virtual void ThePEG::RemnantDecayer::doinit ( )
protectedvirtual

Initialize this object after the setup phase before saving an EventGenerator to disk.

Exceptions:
InitExceptionif object could not be initialized properly.

Reimplemented from ThePEG::InterfacedBase.

Reimplemented in ThePEG::SimpleBaryonRemnantDecayer.

virtual tPVector ThePEG::RemnantDecayer::getSubSystem ( tcPPtr  parent,
tPPtr  parton 
) const
protectedvirtual

Return the system of particles from the hard subsystem which may be used to shuffle momenta to get the remnants on-shell.

In this version the particles are ordered in rapidity with the ones closest to the remnant direction comes first. Other orderings can be enforced by sub-classes.

static LorentzRotation ThePEG::RemnantDecayer::getZBoost ( const LorentzMomentum p0,
const LorentzMomentum p 
)
staticprotected

Return a small boost along the z-axis.

To cure rounding errors when making large boosts it is sometimes necessary to correct the plus (or minus) lightcone component with a small boost along the z-axis. The resulting boost is constructed so that the momentum p0 would be transformed to have the sam z-value as the momentum p.

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

Reimplemented from ThePEG::Decayer.

Reimplemented in ThePEG::SimpleBaryonRemnantDecayer.

virtual bool ThePEG::RemnantDecayer::needsFullStep ( ) const
virtual

Return true if this Decayer need to access the full current step when a particle is decayed.

If true is returned the standard Decay Handler will call the decay(const DecayMode&,const Particle&,Step&) function rather than the decay(const DecayMode&,const Particle&) function.

Reimplemented from ThePEG::Decayer.

RemnantDecayer& ThePEG::RemnantDecayer::operator= ( const RemnantDecayer )
private

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

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

Reimplemented from ThePEG::Decayer.

Reimplemented in ThePEG::SimpleBaryonRemnantDecayer.

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

Function used to write out object persistently.

Parameters:
osthe persistent output stream written to.

Reimplemented from ThePEG::Decayer.

Reimplemented in ThePEG::SimpleBaryonRemnantDecayer.


Member Data Documentation

AbstractClassDescription<RemnantDecayer> ThePEG::RemnantDecayer::initRemnantDecayer
staticprivate

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

Indicates that this is a concrete class with persistent data.

Definition at line 286 of file RemnantDecayer.h.


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