thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.1.4

The VertexBase class is the base class for all helicity amplitude vertices. More...

#include <VertexBase.h>

Inheritance diagram for ThePEG::Helicity::VertexBase:

Public Member Functions

Standard constructors and destructors.
 VertexBase (VertexType::T name, bool kine=false)
 Constructor for $n$-point vertices. 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...
 
unsigned int size () const
 Access to the particle information. More...
 
bool isIncoming (tPDPtr p) const
 Is a particle allowed as an incoming particle? More...
 
bool isOutgoing (tPDPtr p) const
 Is a particle allowed as an outgoing particle? More...
 
const set< tPDPtr > & incoming () const
 Get the list of incoming particles.
 
const set< tPDPtr > & outgoing () const
 Get the list of outgoing particles.
 
Complex norm () const
 Get the coupling.
 
vector< long > search (unsigned int ilist, long id) const
 Function to search the list. More...
 
vector< tPDPtrsearch (unsigned int ilist, tcPDPtr id) const
 Function to search the list. More...
 
bool allowed (long id1, long id2, long id3, long id4=0) const
 Is a given combination allowed. More...
 
VertexType::T getName () const
 Get name of Vertex.
 
unsigned int getNpoint () const
 Get number of lines on Vertex.
 
unsigned int orderInGem () const
 Get the order in $g_EM$.
 
unsigned int orderInGs () const
 Get the order in $g_s$.
 
Calculation of the strong, electromagnetic and weak couplings
double strongCoupling (Energy2 q2) const
 Strong coupling.
 
double electroMagneticCoupling (Energy2 q2) const
 Electromagnetic coupling.
 
double weakCoupling (Energy2 q2) const
 Weak coupling.
 
double sin2ThetaW () const
 
virtual void setCoupling (Energy2 q2, tcPDPtr part1, tcPDPtr part2, tcPDPtr part3)=0
 Set coupling methods. More...
 
virtual void setCoupling (Energy2 q2, tcPDPtr part1, tcPDPtr part2, tcPDPtr part3, tcPDPtr part4)=0
 Calculate the couplings for a four point interaction. More...
 
Kinematic invariants for loop diagrams
bool kinematics () const
 Whether or not to calculate the kinematics invariants.
 
void kinematics (bool kine)
 Set whether or not to calculate the kinematics invariants.
 
void calculateKinematics (const Lorentz5Momentum &p0, const Lorentz5Momentum &p1, const Lorentz5Momentum &p2)
 Calculate the kinematics for a 3-point vertex.
 
void calculateKinematics (const Lorentz5Momentum &p0, const Lorentz5Momentum &p1, const Lorentz5Momentum &p2, const Lorentz5Momentum &p3)
 Calculate the kinematics for a 4-point vertex.
 
void calculateKinematics (const vector< Lorentz5Momentum > &p)
 Calculate the kinematics for a n-point vertex.
 
Energy2 invariant (unsigned int ix, unsigned int iy) const
 Get one of the kinematic invariants.
 
- 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.
 
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 interfaces.
 
- 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

void orderInGem (unsigned int order)
 Set the order in $g_EM$. More...
 
void orderInGs (unsigned int order)
 Set the order in $g_s$. More...
 
Standard Interfaced functions.
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...
 
void addToList (const vector< long > &ids)
 Members to set-up the particles. More...
 
void addToList (long ida, long idb, long idc, long idd=0)
 Set up the lists of outer particles for the three-/four-point vertex. More...
 
void norm (const Complex &coup)
 Members for the amplitude calculations. More...
 
virtual Complex propagator (int iopt, Energy2 q2, tcPDPtr part, complex< Energy > mass=-GeV, complex< Energy > width=-GeV)
 Calculate the propagator for a diagram. More...
 
Complex normPropagator (int iopt, Energy2 q2, tcPDPtr part, complex< Energy > mass=-GeV, complex< Energy > width=-GeV)
 Calculate propagator multiplied by coupling. 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 doinitrun ()
 Initialize this object. More...
 
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

VertexBaseoperator= (const VertexBase &)
 Private and non-existent assignment operator.
 

Private Attributes

Complex _norm
 The overall coupling.
 
bool _calckinematics
 Whether or not to calculate the kinematic invariants for the vertex.
 
std::array< std::array< Energy2, 5 >, 5 > _kine
 Kinematica quantities needed for loop vertices.
 
VertexType::T _theName
 Name of vertex.
 
unsigned int _ordergEM
 Order of vertex in $g_EM$.
 
unsigned int _ordergS
 Order of vertex in $g_s$.
 
unsigned int _coupopt
 option for the coupling
 
double _gs
 Fixed value of strong coupling to use.
 
double _ee
 Fixed value of the electromagentic coupling to use.
 
double _sw
 Fixed value of $\sin\theta_W$ to use.
 
vector< vector< PDPtr > > _particles
 Storage of the particles. More...
 
unsigned int _npoint
 Number of particles at the vertex.
 
set< tPDPtr_inpart
 ParticleData pointers for the allowed incoming particles.
 
set< tPDPtr_outpart
 ParticleData pointers for the allowed outgoing particles.
 

Friends

ostream & operator<< (ostream &, const VertexBase &)
 The output operator is a friend to avoid the data being public.
 

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...
 
- 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

The VertexBase class is the base class for all helicity amplitude vertices.

In implements the storage of the particles which are allowed to interact at the vertex and some simple functions which are often needed by the classes which implement the specific vertices.

In practice little use is made of this information and it is mainly included for future extensions. It can also be used at the development and debugging stage.

Definition at line 51 of file VertexBase.h.

Constructor & Destructor Documentation

◆ VertexBase()

ThePEG::Helicity::VertexBase::VertexBase ( VertexType::T  name,
bool  kine = false 
)

Constructor for $n$-point vertices.

Parameters
nameThe type of vertex
kineWhether the kinematic invariants should be calculated.

Member Function Documentation

◆ addToList() [1/2]

void ThePEG::Helicity::VertexBase::addToList ( const vector< long > &  ids)
protected

Members to set-up the particles.

Set up the lists of outer particles for the vertex.

Parameters
idsA vector of PDG codes for the particles.

◆ addToList() [2/2]

void ThePEG::Helicity::VertexBase::addToList ( long  ida,
long  idb,
long  idc,
long  idd = 0 
)
protected

Set up the lists of outer particles for the three-/four-point vertex.

For small vertices, this form is much easier to use.

Parameters
idaThe PDG codes for the first set of particles.
idbThe PDG codes for the second set of particles.
idcThe PDG codes for the third set of particles.
iddThe PDG codes for the fourth set of particles.

◆ allowed()

bool ThePEG::Helicity::VertexBase::allowed ( long  id1,
long  id2,
long  id3,
long  id4 = 0 
) const

Is a given combination allowed.

Parameters
id1PDG code of the first particle.
id2PDG code of the second particle.
id3PDG code of the third particle.
id4PDG code of the fourth particle.

◆ doinit()

virtual void ThePEG::Helicity::VertexBase::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.

◆ getReferences()

virtual IVector ThePEG::Helicity::VertexBase::getReferences ( )
protectedvirtual

Return a vector of all pointers to Interfaced objects used in this object.

Returns
a vector of pointers.

Reimplemented from ThePEG::InterfacedBase.

◆ isIncoming()

bool ThePEG::Helicity::VertexBase::isIncoming ( tPDPtr  p) const
inline

Is a particle allowed as an incoming particle?

Parameters
pThe ParticleData pointer

Definition at line 108 of file VertexBase.h.

◆ isOutgoing()

bool ThePEG::Helicity::VertexBase::isOutgoing ( tPDPtr  p) const
inline

Is a particle allowed as an outgoing particle?

Parameters
pThe ParticleData pointer

Definition at line 116 of file VertexBase.h.

◆ norm()

void ThePEG::Helicity::VertexBase::norm ( const Complex coup)
inlineprotected

Members for the amplitude calculations.

Set the coupling.

Parameters
coupThe coupling.

Definition at line 327 of file VertexBase.h.

◆ normPropagator()

Complex ThePEG::Helicity::VertexBase::normPropagator ( int  iopt,
Energy2  q2,
tcPDPtr  part,
complex< Energy mass = -GeV,
complex< Energy width = -GeV 
)
inlineprotected

Calculate propagator multiplied by coupling.

Parameters
ioptThe option for the Breit-Wigner shape
q2The scale
partThe ParticleData pointer for the off-shell particle.
massThe mass if not to be taken from the ParticleData object
widthThe width if not to be taken from the ParticleData object

Definition at line 349 of file VertexBase.h.

◆ orderInGem()

void ThePEG::Helicity::VertexBase::orderInGem ( unsigned int  order)
inlineprotected

Set the order in $g_EM$.

Parameters
orderThe order of the vertex in $g_EM$

Definition at line 430 of file VertexBase.h.

◆ orderInGs()

void ThePEG::Helicity::VertexBase::orderInGs ( unsigned int  order)
inlineprotected

Set the order in $g_s$.

Parameters
orderThe order of the vertex in $g_s$

Definition at line 436 of file VertexBase.h.

◆ persistentInput()

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

◆ persistentOutput()

void ThePEG::Helicity::VertexBase::persistentOutput ( PersistentOStream os) const

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ propagator()

virtual Complex ThePEG::Helicity::VertexBase::propagator ( int  iopt,
Energy2  q2,
tcPDPtr  part,
complex< Energy mass = -GeV,
complex< Energy width = -GeV 
)
protectedvirtual

Calculate the propagator for a diagram.

Parameters
ioptThe option for the Breit-Wigner shape
q2The scale
partThe ParticleData pointer for the off-shell particle.
massThe mass if not to be taken from the ParticleData object
widthThe width if not to be taken from the ParticleData object

◆ rebind()

virtual void ThePEG::Helicity::VertexBase::rebind ( const TranslationMap trans)
protectedvirtual

Rebind pointer to other Interfaced objects.

Called in the setup phase after all objects used in an EventGenerator has been cloned so that the pointers will refer to the cloned objects afterwards.

Parameters
transa TranslationMap relating the original objects to their respective clones.
Exceptions
RebindExceptionif no cloned object was found for a given pointer.

Reimplemented from ThePEG::InterfacedBase.

◆ search() [1/2]

vector<long> ThePEG::Helicity::VertexBase::search ( unsigned int  ilist,
long  id 
) const

Function to search the list.

Parameters
ilistWhich list to search
idThe PDG code to look for.

◆ search() [2/2]

vector<tPDPtr> ThePEG::Helicity::VertexBase::search ( unsigned int  ilist,
tcPDPtr  id 
) const

Function to search the list.

Parameters
ilistWhich list to search
idThe particle to look for.

◆ setCoupling() [1/2]

virtual void ThePEG::Helicity::VertexBase::setCoupling ( Energy2  q2,
tcPDPtr  part1,
tcPDPtr  part2,
tcPDPtr  part3 
)
pure virtual

Set coupling methods.

Calculate the couplings for a three point interaction. This method is virtual and must be implemented in classes inheriting from this.

Parameters
q2The scale $q^2$ for the coupling at the vertex.
part1The ParticleData pointer for the first particle.
part2The ParticleData pointer for the second particle.
part3The ParticleData pointer for the third particle.

Implemented in ThePEG::Helicity::FFVVertex, ThePEG::Helicity::RFVVertex, ThePEG::Helicity::RFSVertex, ThePEG::Helicity::FFVTVertex, ThePEG::Helicity::VVVSVertex, ThePEG::Helicity::FFSVertex, ThePEG::Helicity::FFTVertex, ThePEG::Helicity::GeneralFFVVertex, ThePEG::Helicity::VVTVertex, ThePEG::Helicity::VVVTVertex, ThePEG::Helicity::GeneralVVSVertex, ThePEG::Helicity::SSTVertex, ThePEG::Helicity::VVSVertex, ThePEG::Helicity::VVSSVertex, ThePEG::Helicity::GeneralVSSVertex, ThePEG::Helicity::VVVVertex, ThePEG::Helicity::SSSVertex, and ThePEG::Helicity::SSSSVertex.

◆ setCoupling() [2/2]

virtual void ThePEG::Helicity::VertexBase::setCoupling ( Energy2  q2,
tcPDPtr  part1,
tcPDPtr  part2,
tcPDPtr  part3,
tcPDPtr  part4 
)
pure virtual

Calculate the couplings for a four point interaction.

This method is virtual and must be implemented in classes inheriting from this.

Parameters
q2The scale $q^2$ for the coupling at the vertex.
part1The ParticleData pointer for the first particle.
part2The ParticleData pointer for the second particle.
part3The ParticleData pointer for the third particle.
part4The ParticleData pointer for the fourth particle.

Implemented in ThePEG::Helicity::FFVVertex, ThePEG::Helicity::RFVVertex, ThePEG::Helicity::RFSVertex, ThePEG::Helicity::FFVTVertex, ThePEG::Helicity::VVVSVertex, ThePEG::Helicity::FFSVertex, ThePEG::Helicity::FFTVertex, ThePEG::Helicity::VVVTVertex, ThePEG::Helicity::GeneralFFVVertex, ThePEG::Helicity::VVTVertex, ThePEG::Helicity::GeneralVVSVertex, ThePEG::Helicity::VVSSVertex, ThePEG::Helicity::SSTVertex, ThePEG::Helicity::VVSVertex, ThePEG::Helicity::GeneralVSSVertex, ThePEG::Helicity::VVVVertex, ThePEG::Helicity::SSSSVertex, and ThePEG::Helicity::SSSVertex.

◆ size()

unsigned int ThePEG::Helicity::VertexBase::size ( ) const
inline

Access to the particle information.

Number of different particle combinations allowed.

Definition at line 101 of file VertexBase.h.

Member Data Documentation

◆ _particles

vector<vector<PDPtr> > ThePEG::Helicity::VertexBase::_particles
private

Storage of the particles.

Particles interacting at the vertex

Definition at line 454 of file VertexBase.h.


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