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.
bool	extract (tPPtr parton, bool fixcolour=false)
	Modify the properties to reflect that the given parton was extracted.
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.
bool	remove (tPPtr parton)
	Modify the properties to reflect that the given parton which was previously extracted is removed.
const PVector &	extracted () const
	Acces the extracted partons.
Public Member Functions inherited from ThePEG::Particle
	Particle (tcEventPDPtr newData)
	Standard Constructor.
	Particle (const Particle &)
	Copy constructor.
virtual	~Particle ()
	Destructor.
bool	decayed () const
	Returns true if and only if this particle has decayed.
const ParticleVector &	children () 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 tParticleVector &	parents () const
	The list of parent particles.
tParticleSet	siblings () const
	Return a set of neighboring particles coming from the same decay as this one.
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.
tPPtr	previous () const
	Previous instance.
tcPPtr	original () const
	Original instance.
tPPtr	original ()
	Original instance.
tcPPtr	final () const
	Final instance.
tPPtr	final ()
	Final instance.
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.
int	status () const
	Get the status code of the particle.
void	status (int n)
	Set the status code of the particle.
const ParticleDataClass &	data () 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 Lorentz5Momentum &	momentum () const
	Return the momentum of this particle.
void	set3Momentum (const Momentum3 &p)
	Set the 3-momentum of this particle.
void	setMomentum (const LorentzMomentum &p)
	Set the momentum of this particle.
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 LorentzPoint &	vertex () const
	The creation vertex of this particle.
LorentzPoint	labVertex () const
	The creation vertex of this particle.
LorentzPoint	decayVertex () const
	The decay vertex of this particle.
LorentzPoint	labDecayVertex () const
	The decay vertex of this particle.
const Lorentz5Distance &	lifeLength () const
	The life time/length.
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.
void	setLifeLength (const LorentzDistance &d)
	Set the life time/length of a particle.
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.
void	boost (const Boost &b)
	Do Lorentz transformations on this particle.
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.
void	deepBoost (const Boost &b)
	Do Lorentz transformations on this particle and its decendants.
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.
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.
template<typename Iterator >
std::iterator_traits< Iterator >::value_type	antiColourNeighbour (Iterator first, Iterator last) const
	Get a pointer to the anti-colour neighbor.
void	colourNeighbour (tPPtr, bool anti=false)
	Set the colour neighbor.
void	antiColourNeighbour (tPPtr p)
	Set the anti-colour neighbor.
void	antiColourConnect (tPPtr neighbour)
	Connect colour.
void	colourConnect (tPPtr neighbour, bool anti=false)
	Connect colour.
tPPtr	incomingColour (bool anti=false) const
	Incoming colour.
tPPtr	incomingAntiColour () const
	Incoming anti-colour.
void	incomingColour (tPPtr p, bool anti=false)
	Set incoming colour.
void	incomingAntiColour (tPPtr p)
	Set incoming anti-colour.
tPPtr	outgoingColour (bool anti=false) const
	Outgoing colour.
tPPtr	outgoingAntiColour () const
	Outgoing anti-colour.
void	outgoingColour (tPPtr, bool anti=false)
	Set outgoing colour.
void	outgoingAntiColour (tPPtr p)
	Set outgoing anti-colour.
void	colourFlow (tPPtr child, bool anti=false)
	Specify colour flow.
void	antiColourFlow (tPPtr child)
	Specify anticolour flow.
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 EIVector &	getInfo () const
	Access user-defined information as a vector of EventInfoBase pointers.
EIVector &	getInfo ()
	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.
ostream &	print (ostream &os, tcStepPtr step=tcStepPtr()) const
	Print particle info to a stream os.
virtual void	debugme () const
	Print out debugging information for this object on std::cerr.
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.

Friends
class	RemnantDecayer
	RemnantDecayer is a friend.

Functions used by the persistent I/O system.
struct	ClassTraits< RemnantParticle >
	The ClassTraits<RemnantParticle> class must be a friend to be able to use the private default constructor.
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 ClassDescription< RemnantParticle >	initRemnantParticle
	The static object used to initialize the description of this class.
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 ()
	The standard Init function used to initialize the interfaces.
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.
RemnantParticle &	operator= (const RemnantParticle &)=delete
	The assignment operator is private and must never be called.

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::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.
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.
Static Public Attributes inherited from ThePEG::Particle
static string	outputFormat
	Specify how to print particles.
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.
ReferenceCounted &	operator= (const ReferenceCounted &)
	Assignment.

Detailed Description

Here is the documentation of the RemnantParticle class.

Definition at line 25 of file RemnantParticle.h.

Constructor & Destructor Documentation

RemnantParticle() [1/2]

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.

RemnantParticle() [2/2]

ThePEG::RemnantParticle::RemnantParticle ( )

inlineprotected

Private default constructor must only be used by the PersistentIStream class via the ClassTraits<RemnantParticle> class.

Definition at line 133 of file RemnantParticle.h.

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.

extracted()

const PVector & ThePEG::RemnantParticle::extracted ( ) const

inline

Acces the extracted partons.

Definition at line 73 of file RemnantParticle.h.

References theExtracted.

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.

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

is	the persistent input stream read from.
version	the version number of the object when written.

persistentOutput()

void ThePEG::RemnantParticle::persistentOutput

(

PersistentOStream &

os

)

const

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

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.

Friends And Related Function Documentation

ClassTraits< RemnantParticle >

friend struct ClassTraits< RemnantParticle >

friend

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

Definition at line 133 of file RemnantParticle.h.

RemnantDecayer

friend class RemnantDecayer

friend

RemnantDecayer is a friend.

Definition at line 32 of file RemnantParticle.h.

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.

parent

tcPPtr ThePEG::RemnantParticle::parent

private

The parent from which this remnant resulted.

Definition at line 120 of file RemnantParticle.h.

remData

RemPDPtr ThePEG::RemnantParticle::remData

private

The RemnantData object associated to this remnant.

Definition at line 115 of file RemnantParticle.h.

theExtracted

PVector ThePEG::RemnantParticle::theExtracted

private

The set of extracted partons.

Definition at line 125 of file RemnantParticle.h.

Referenced by extracted().

---

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

• RemnantParticle.h