thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.1.5
ThePEG::RemnantParticle Class Reference

Here is the documentation of the RemnantParticle class. More...

#include <RemnantParticle.h>

Inheritance diagram for ThePEG::RemnantParticle:

Public Member Functions

Standard constructors and destructors.
 RemnantParticle (const Particle &particle, RemDecPtr decayer, tPPtr parton=tPPtr())
 The standard constructor takes as argument the particle for which this is the remnant and a decayer capable of performing the decay. More...
 
bool extract (tPPtr parton, bool fixcolour=false)
 Modify the properties to reflect that the given parton was extracted. More...
 
bool reextract (tPPtr oldp, tPPtr newp, bool fixcolour=false)
 Modify the properties to reflect that the previously extracted parton, oldp, was evolved backwards to the the parton newp. More...
 
bool remove (tPPtr parton)
 Modify the properties to reflect that the given parton which was previously extracted is removed.
 
const PVectorextracted () const
 Acces the extracted partons.
 
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::Particle
 Particle (tcEventPDPtr newData)
 Standard Constructor. More...
 
 Particle (const Particle &)
 Copy constructor.
 
virtual ~Particle ()
 Destructor.
 
ostream & print (ostream &os, tcStepPtr step=tcStepPtr()) const
 Print particle info to a stream os. More...
 
virtual void debugme () const
 Print out debugging information for this object on std::cerr. More...
 
bool decayed () const
 Returns true if and only if this particle has decayed.
 
const ParticleVectorchildren () const
 The list of decay products.
 
void addChild (tPPtr c)
 Add a child (the childs parent pointer will be set accordingly).
 
void abandonChild (tPPtr child)
 Remove the given child from the list of children of this particle (the corresponding parent pointer of the child will also be removed).
 
const tParticleVectorparents () const
 The list of parent particles.
 
tParticleSet siblings () const
 Return a set of neighboring particles coming from the same decay as this one. More...
 
void undecay ()
 Undo the decay of this particle, removing all children (and grand children ...) from the event record.
 
void decayMode (tDMPtr dm)
 If this particle has decayed set the corresponding decay mode.
 
tDMPtr decayMode () const
 If this particle has decayed get the corresponding decay mode.
 
tPPtr next () const
 Next instance. More...
 
tPPtr previous () const
 Previous instance. More...
 
tcPPtr original () const
 Original instance. More...
 
tPPtr original ()
 Original instance. More...
 
tcPPtr final () const
 Final instance. More...
 
tPPtr final ()
 Final instance. More...
 
tStepPtr birthStep () const
 Get the first Step object where this particle occurred.
 
int number () const
 Get the order-number for this particle in the current event.
 
const ParticleDataClassdata () const
 Access the ParticleData object of this particle type.
 
tcEventPDPtr dataPtr () const
 Access the ParticleData object of this particle type.
 
const string & PDGName () const
 Return the PDG name of this particle.
 
long id () const
 Return the PDG id number of this particle.
 
const Lorentz5Momentummomentum () const
 Return the momentum of this particle.
 
void set3Momentum (const Momentum3 &p)
 Set the 3-momentum of this particle. More...
 
void setMomentum (const LorentzMomentum &p)
 Set the momentum of this particle. More...
 
void set5Momentum (const Lorentz5Momentum &p)
 Set the momentum and mass.
 
Energy mass () const
 Acces the mass of this particle.
 
Energy nominalMass () const
 Acces the mass of this particle type.
 
Energy2 scale () const
 Get the scale at which this particle is considered resolved.
 
void scale (Energy2 q2)
 Set the scale at which this particle is considered resolved.
 
Energy2 vetoScale () const
 Get the scale above which this particle should not radiate.
 
void vetoScale (Energy2 q2)
 Set the scale above which this particle should not radiate.
 
Energy2 mt2 () const
 Return the transverse mass (squared), calculated from the energy and the longitudinal momentum.
 
Energy mt () const
 Return the transverse mass (squared), calculated from the energy and the longitudinal momentum.
 
Energy2 perpmass2 () const
 Return the transverse mass (squared), calculated from the mass and the transverse momentum.
 
Energy perpmass () const
 Return the transverse mass (squared), calculated from the mass and the transverse momentum.
 
double rapidity () const
 Return the (pseudo) rapidity.
 
double eta () const
 Return the (pseudo) rapidity.
 
Energy Pplus () const
 Return the positive and negative light-cone momenta.
 
Energy Pminus () const
 Return the positive and negative light-cone momenta.
 
const LorentzPointvertex () const
 The creation vertex of this particle. More...
 
LorentzPoint labVertex () const
 The creation vertex of this particle. More...
 
LorentzPoint decayVertex () const
 The decay vertex of this particle. More...
 
LorentzPoint labDecayVertex () const
 The decay vertex of this particle. More...
 
const Lorentz5DistancelifeLength () const
 The life time/length. More...
 
void setVertex (const LorentzPoint &p)
 Set the creation vertex relative to the collision vertex.
 
void setLabVertex (const LorentzPoint &)
 Set the creation vertex in the lab frame of this particle.
 
void setLifeLength (const Distance &d)
 Set the life length of this particle. More...
 
void setLifeLength (const LorentzDistance &d)
 Set the life time/length of a particle. More...
 
void setLifeLength (const Lorentz5Distance &d)
 Set the life time/length of a particle.
 
Time lifeTime () const
 The invariant life time of this particle.
 
void transform (const LorentzRotation &r)
 Do Lorentz transformations on this particle.
 
void boost (double bx, double by, double bz)
 Do Lorentz transformations on this particle. More...
 
void boost (const Boost &b)
 Do Lorentz transformations on this particle. More...
 
void rotateX (double a)
 Rotate around the x-axis.
 
void rotateY (double a)
 Rotate around the y-axis.
 
void rotateZ (double a)
 Rotate around the z-axis.
 
void rotate (double a, const Axis &axis)
 Rotate around the given axis.
 
void mirror ()
 Mirror in the xy-plane.
 
void deepTransform (const LorentzRotation &r)
 Do Lorentz transformations on this particle and its decendants.
 
void deepBoost (double bx, double by, double bz)
 Do Lorentz transformations on this particle and its decendants. More...
 
void deepBoost (const Boost &b)
 Do Lorentz transformations on this particle and its decendants. More...
 
void deepRotateX (double a)
 Rotate this particle and its decendants around the x-axis.
 
void deepRotateY (double a)
 Rotate this particle and its decendants around the y-axis.
 
void deepRotateZ (double a)
 Rotate this particle and its decendants around the z-axis.
 
void deepRotate (double a, const Axis &axis)
 Rotate this particle and its decendants around the given axis.
 
double massError () const
 Return the relative inconsistency in the mass component.
 
double energyError () const
 Return the relative inconsistency in the energy component.
 
double rhoError () const
 Return the relative inconsistency in the spatial components.
 
void rescaleEnergy ()
 Rescale energy, so that the invariant length/mass of the LorentzVector agrees with the current one.
 
void rescaleRho ()
 Rescale spatial component, so that the invariant length/mass of the LorentzVector agrees with the current one.
 
void rescaleMass ()
 Set the invariant length/mass member, so that it agrees with the invariant length/mass of the LorentzVector.
 
bool hasColourInfo () const
 True if this particle has colour information. More...
 
tColinePtr antiColourLine () const
 Return the colour lines to which this particles anti-colour is connected.
 
tColinePtr colourLine (bool anti=false) const
 Return the colour lines to which this particles (anti-)colour is connected.
 
bool hasColourLine (tcColinePtr line, bool anti=false) const
 Return true if the particle is connected to the given (anti-) colour line.
 
bool hasAntiColourLine (tcColinePtr line) const
 Return true if the particle is connected to the given anti-colour line.
 
bool coloured () const
 True if this particle type is not a colour singlet.
 
bool hasColour (bool anti=false) const
 True if this particle type carries (anti-)colour.
 
bool hasAntiColour () const
 True if this particle type carries anti-colour.
 
tcCBPtr colourInfo () const
 Get the ColourBase object.
 
tCBPtr colourInfo ()
 Get the ColourBase object.
 
void colourInfo (tCBPtr c)
 Set the ColourBase object.
 
template<typename Iterator >
std::iterator_traits< Iterator >::value_type colourNeighbour (Iterator first, Iterator last, bool anti=false) const
 Get a pointer to the colour neighbor. More...
 
template<typename Iterator >
std::iterator_traits< Iterator >::value_type antiColourNeighbour (Iterator first, Iterator last) const
 Get a pointer to the anti-colour neighbor. More...
 
void colourNeighbour (tPPtr, bool anti=false)
 Set the colour neighbor. More...
 
void antiColourNeighbour (tPPtr p)
 Set the anti-colour neighbor. More...
 
void antiColourConnect (tPPtr neighbour)
 Connect colour. More...
 
void colourConnect (tPPtr neighbour, bool anti=false)
 Connect colour. More...
 
tPPtr incomingColour (bool anti=false) const
 Incoming colour. More...
 
tPPtr incomingAntiColour () const
 Incoming anti-colour. More...
 
void incomingColour (tPPtr p, bool anti=false)
 Set incoming colour. More...
 
void incomingAntiColour (tPPtr p)
 Set incoming anti-colour. More...
 
tPPtr outgoingColour (bool anti=false) const
 Outgoing colour. More...
 
tPPtr outgoingAntiColour () const
 Outgoing anti-colour. More...
 
void outgoingColour (tPPtr, bool anti=false)
 Set outgoing colour. More...
 
void outgoingAntiColour (tPPtr p)
 Set outgoing anti-colour. More...
 
void colourFlow (tPPtr child, bool anti=false)
 Specify colour flow. More...
 
void antiColourFlow (tPPtr child)
 Specify anticolour flow. More...
 
void resetColour ()
 Remove all colour information;.
 
tcSpinPtr spinInfo () const
 Return the Spin object.
 
tSpinPtr spinInfo ()
 Return the Spin object.
 
void spinInfo (tSpinPtr s)
 Set the Spin object.
 
const EIVectorgetInfo () const
 Access user-defined information as a vector of EventInfoBase pointers.
 
EIVectorgetInfo ()
 Access user-defined information as a vector of EventInfoBase pointers.
 
bool hasRep () const
 True if this particle has instantiated the object with information other than type and momentum.
 
void initFull ()
 If this particle has only a type and momentum, instantiate the rest of the information.
 
void persistentOutput (PersistentOStream &) const
 Standard function for writing to a persistent stream.
 
void persistentInput (PersistentIStream &, int)
 Standard function for reading from a persistent stream.
 
- 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.
 

Static Public Member Functions

static void Init ()
 The standard Init function used to initialize the interfaces. More...
 
- Static Public Member Functions inherited from ThePEG::Particle
template<typename Iterator >
static void PrintParticles (ostream &os, Iterator first, Iterator last, tcStepPtr step=tcStepPtr())
 Print a range of particles.
 
template<typename Cont >
static void PrintParticles (ostream &os, const Cont &c, tcStepPtr step=tcStepPtr())
 Print a container of particles.
 
static void Init ()
 Standard Init function. More...
 
- Static Public Member Functions inherited from ThePEG::Base
static void Init ()
 The standard Init function used to initialize the interfaces. More...
 

Protected Member Functions

void fixColourLines (tPPtr parton)
 If necessary, colour-connect this remnant to the given parton.
 
 RemnantParticle ()
 Private default constructor must only be used by the PersistentIStream class via the ClassTraits<RemnantParticle> class.
 
- Protected Member Functions inherited from ThePEG::Particle
 Particle ()
 Private default constructor must only be used by the PersistentIStream class via the ClassTraits<Particle> class.
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted ()
 Default constructor.
 
 ReferenceCounted (const ReferenceCounted &)
 Copy-constructor.
 
ReferenceCountedoperator= (const ReferenceCounted &)
 Assignment.
 

Private Member Functions

RemnantParticleoperator= (const RemnantParticle &)=delete
 The assignment operator is private and must never be called. More...
 

Private Attributes

RemPDPtr remData
 The RemnantData object associated to this remnant.
 
tcPPtr parent
 The parent from which this remnant resulted.
 
PVector theExtracted
 The set of extracted partons.
 

Static Private Attributes

static ClassDescription< RemnantParticleinitRemnantParticle
 The static object used to initialize the description of this class. More...
 

Friends

class RemnantDecayer
 RemnantDecayer is a friend.
 
struct ClassTraits< RemnantParticle >
 The ClassTraits<RemnantParticle> class must be a friend to be able to use the private default constructor.
 

Additional Inherited Members

- 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...
 
- Static Public Attributes inherited from ThePEG::Particle
static string outputFormat
 Specify how to print particles. More...
 

Detailed Description

Here is the documentation of the RemnantParticle class.

Definition at line 25 of file RemnantParticle.h.

Constructor & Destructor Documentation

◆ RemnantParticle()

ThePEG::RemnantParticle::RemnantParticle ( const Particle particle,
RemDecPtr  decayer,
tPPtr  parton = tPPtr() 
)

The standard constructor takes as argument the particle for which this is the remnant and a decayer capable of performing the decay.

Optionally a parton that has been extracted. Note that if the parton is given, the extraction may silently fail.

Member Function Documentation

◆ extract()

bool ThePEG::RemnantParticle::extract ( tPPtr  parton,
bool  fixcolour = false 
)

Modify the properties to reflect that the given parton was extracted.

If fixcolour is true a colour line is drawn from the remnant to the extracted parton.

◆ Init()

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

Referenced by extracted().

◆ operator=()

RemnantParticle& ThePEG::RemnantParticle::operator= ( const RemnantParticle )
privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

void ThePEG::RemnantParticle::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 extracted().

◆ persistentOutput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

Referenced by extracted().

◆ reextract()

bool ThePEG::RemnantParticle::reextract ( tPPtr  oldp,
tPPtr  newp,
bool  fixcolour = false 
)

Modify the properties to reflect that the previously extracted parton, oldp, was evolved backwards to the the parton newp.

If fixcolour is true a colour line is drawn from the remnant to the extracted parton.

Member Data Documentation

◆ initRemnantParticle

ClassDescription<RemnantParticle> ThePEG::RemnantParticle::initRemnantParticle
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 147 of file RemnantParticle.h.


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