thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.1.4

ConstituentParticleData inherits from the ParticleData class and is used for quarks, diquarks and gluons to store information about their constituent mass. More...

#include <ConstituentParticleData.h>

Inheritance diagram for ThePEG::ConstituentParticleData:

Public Member Functions

virtual Energy constituentMass () const
 Return the constituent mass of this parton.
 
Standard constructors and destructors.
 ConstituentParticleData ()
 Default constructor.
 
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::ParticleData
Energy mass (Energy)
 Set the nominal mass.
 
Energy mass () const
 Return the nominal mass.
 
Energy hardProcessMass () const
 Return the mass to be used when evaluating hard process cross sections.
 
Energy massMax () const
 Return the maximum possible mass of this particle type.
 
Energy massMin () const
 Return the minimum possible mass of this particle type.
 
Energy width (Energy)
 Set the width.
 
Energy width () const
 Get the width. More...
 
Energy widthCut (Energy wci)
 Set the width cut. More...
 
Energy widthCut () const
 Get the width cut.
 
Energy widthUpCut (Energy)
 Set the upper width cut.
 
Energy widthUpCut () const
 Get the upper width cut.
 
Energy widthLoCut (Energy)
 Set the lower width cut.
 
Energy widthLoCut () const
 Get the lower width cut.
 
Length cTau (Length)
 Set the life time cTau.
 
Length cTau () const
 Get the life time cTau cTau. More...
 
Energy hardProcessWidth () const
 Return the width to be used when evaluating hard process cross sections.
 
PDT::Charge iCharge (PDT::Charge)
 Set the charge. More...
 
Charge charge () const
 Get the charge. More...
 
PDT::Charge iCharge () const
 Get the charge. More...
 
bool charged () const
 Return true if charged.
 
bool positive () const
 Return true if positively charged.
 
bool negative () const
 Return true if negatively charged.
 
PDT::Spin iSpin (PDT::Spin)
 Set the spin. More...
 
AngularMomentum spin () const
 Get the spin.The spin is returned in standard units.
 
PDT::Spin iSpin () const
 Get the spin. More...
 
PDT::Colour iColour (PDT::Colour)
 Set the colour of the particle in units of PDT::Colour.
 
PDT::Colour iColour () const
 Get the colour of the particle in units of PDT::Colour.
 
bool coloured () const
 Return true if coloured.
 
bool hasColour (bool anti=false) const
 Return true if (anti) coloured or colour-octet.
 
bool hasAntiColour () const
 Return true if anti coloured or colour-octet.
 
void stable (bool stab)
 Specify if particle is to be considered stable according to stab.
 
bool stable () const
 Return true if particle is to be considered stable. More...
 
tPDPtr CC () const
 Get the pointer to the corresponding anti partner.
 
void synchronized (bool sync)
 Specify if the anti partner chould be changed automatically when this object is changed according to sync.
 
bool synchronized () const
 Return true if the anti partner chould be changed automatically when this object is changed.
 
void synchronize ()
 If there is an anti-partner, update this object to have correct anti-properties.
 
void massGenerator (tMassGenPtr)
 Set the mass generator object.
 
tMassGenPtr massGenerator () const
 Get the mass generator object.
 
void widthGenerator (tWidthGeneratorPtr)
 Set the width generator object.
 
tWidthGeneratorPtr widthGenerator () const
 Get the width generator object.
 
void variableRatio (bool varRatio)
 Specify if the branching ratio of the Particle instances should vary with their masses.
 
bool variableRatio () const
 Return true if the branching ratio should vary with the mass of the Particle instance.
 
 ParticleData ()
 Default constructor.
 
virtual ~ParticleData ()
 Destructor.
 
long id () const
 Return the PDG id number.
 
const string & PDGName () const
 Return the generic PDG name. More...
 
const string & genericName () const
 Return the generic PDG name. More...
 
PPtr produceParticle (const Lorentz5Momentum &) const
 Produce a particle specifying momentum.
 
PPtr produceParticle (const LorentzMomentum &) const
 Produce a particle specifying momentum.
 
PPtr produceParticle (const LorentzMomentum &, Energy m) const
 Produce a particle specifying 4-momentum and a mass.
 
PPtr produceParticle (const Momentum3 &pp=Momentum3()) const
 Produce a particle specifying 3-momentum.
 
PPtr produceParticle (Energy m, const Momentum3 &pp=Momentum3()) const
 Produce a particle specifying mass and 3-momentum.
 
PPtr produceParticle (Energy plus, Energy minus, Energy px, Energy py) const
 Produce a particle specifying light-cone momentum components and transverse momentum components.
 
Energy generateMass () const
 Generate a mass for an instance of this particle type.
 
Energy generateWidth (Energy mass) const
 Generate a width for an instance of this particle type. More...
 
Length generateLifeTime (Energy mass, Energy width) const
 Generate a mass for an instance of this particle type. More...
 
const DecaySelectordecaySelector () const
 Return the nominal decay selector for this particle. More...
 
tDMPtr selectMode (Particle &p) const
 Selects a decay mode randomly according to the branching ratios. More...
 
const DecaySet & decayModes () const
 Access all the decay modes, including those which are switched off, or have zero branching ratio.
 
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::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 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.
 
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.
 
The Create methods are special interfaces for ParticleData

classes.

static PDPtr Create (long newId, string newPDGName)
 Create a Particle which is its own anti-particle.
 
static PDPair Create (long newId, string newPDGName, string newAntiPDGName)
 Create a particle - anti particle pair.
 
- Static Public Member Functions inherited from ThePEG::ParticleData
static void Init ()
 
static PDPtr Create (PID newId, const string &newPDGName)
 Create a Particle which is its own anti-particle.
 
static PDPair Create (PID newId, const string &newPDGName, const string &newAntiPDGName)
 Create a particle - anti particle pair.
 
- 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 Member Functions

 ConstituentParticleData (long newId, string newPDGName)
 Protected constructor only to be used by subclasses or by the Create method.
 
virtual void readSetup (istream &is)
 Read setup info from a standard stream. More...
 
virtual PDPtr pdclone () const
 ParticleData clone method.
 
- Protected Member Functions inherited from ThePEG::ParticleData
 ParticleData (PID newId, const string &newPDGName)
 Protected constructor only to be used by subclasses or by the Create method.
 
void addDecayMode (tDMPtr)
 Add a decay mode for this particle.
 
void removeDecayMode (tDMPtr)
 Remove a decay mode for this particle.
 
virtual IBPtr clone () const
 Make a simple clone of this object. More...
 
virtual IBPtr fullclone () const
 Make a clone of this object, possibly modifying the cloned object to make it sane. More...
 
virtual void doupdate ()
 Check sanity of the object during the setup phase.
 
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk. More...
 
virtual void rebind (const TranslationMap &trans)
 Rebind pointer to other Interfaced objects. More...
 
virtual IVector getReferences ()
 Return a vector of all pointers to Interfaced objects used in this object. More...
 
virtual void doinitrun ()
 Initialize this object. 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
 InterfacedBase ()
 Protected default constructor.
 
 InterfacedBase (string newName)
 Protected constructor with the name given as argument.
 
 InterfacedBase (const InterfacedBase &i)
 Protected copy-constructor.
 
virtual void dofinish ()
 Finalize this object. 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.
 

Private Member Functions

void setConstituentMass (Energy m)
 Utility function for the interface.
 
Energy defConstituentMass () const
 Utility function for the interface.
 
ConstituentParticleDataoperator= (const ConstituentParticleData &)
 Private and non-existent assignment operator.
 

Private Attributes

Energy theConstituentMass
 The constituent mass of this parton.
 
Energy theDefaultConstituentMass
 The default constituent mass of this parton.
 

Static Private Attributes

static ClassDescription< ConstituentParticleDatainitConstituentParticleData
 Describe a concrete class with persistent data.
 

Additional Inherited Members

- Public Types inherited from ThePEG::ParticleData
typedef Selector< tDMPtrDecaySelector
 A selector of DecayMode objects. More...
 
- 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...
 
- Static Protected Member Functions inherited from ThePEG::ParticleData
static void antiSetup (const PDPair &pap)
 Used by subclasses or by the Create method to setup anti-relationship.
 
- 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

ConstituentParticleData inherits from the ParticleData class and is used for quarks, diquarks and gluons to store information about their constituent mass.

See also
The interfaces defined for ConstituentParticleData.

Definition at line 25 of file ConstituentParticleData.h.

Member Function Documentation

◆ persistentInput()

void ThePEG::ConstituentParticleData::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 constituentMass().

◆ persistentOutput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

Referenced by constituentMass().

◆ readSetup()

virtual void ThePEG::ConstituentParticleData::readSetup ( istream &  is)
protectedvirtual

Read setup info from a standard stream.

The information that must be supplied is the same as for ParticleData::readSetup with an additional constituent mass (in GeV) added in the end.

Reimplemented from ThePEG::ParticleData.

Referenced by constituentMass().


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