ThePEG is hosted by Hepforge, IPPP Durham
ThePEG  2.1.4
ThePEG::Helicity::AbstractSSSVertex Class Referenceabstract

The AbstractSSSVertex class is the base class for all scalar-scalar-scalar interactions in ThePEG. More...

#include <AbstractSSSVertex.h>

Inheritance diagram for ThePEG::Helicity::AbstractSSSVertex:

Public Member Functions

 AbstractSSSVertex ()
 Default constructor.
 
virtual Complex evaluate (Energy2 q2, const ScalarWaveFunction &sca1, const ScalarWaveFunction &sca2, const ScalarWaveFunction &sca3)=0
 Members to calculate the helicity amplitude expressions for vertices and off-shell particles. More...
 
virtual ScalarWaveFunction evaluate (Energy2 q2, int iopt, tcPDPtr out, const ScalarWaveFunction &sca1, const ScalarWaveFunction &sca2, complex< Energy > mass=-GeV, complex< Energy > width=-GeV)=0
 Evaluate the off-shell scalar coming from the vertex. More...
 
- Public Member Functions inherited from ThePEG::Helicity::VertexBase
 VertexBase (VertexType::T name, bool kine=false)
 Constructor for $n$-point vertices. 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...
 
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$.
 
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...
 
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 ()
 The standard Init function used to initialize the interfaces. More...
 
- Static Public Member Functions inherited from ThePEG::Helicity::VertexBase
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...
 

Private Member Functions

AbstractSSSVertexoperator= (const AbstractSSSVertex &)
 The assignment operator is private and must never be called. More...
 

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...
 
- Protected Member Functions inherited from ThePEG::Helicity::VertexBase
void orderInGem (unsigned int order)
 Set the order in $g_EM$. More...
 
void orderInGs (unsigned int order)
 Set the order in $g_s$. More...
 
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.
 
- 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 AbstractSSSVertex class is the base class for all scalar-scalar-scalar interactions in ThePEG.

Definition at line 19 of file AbstractSSSVertex.h.

Member Function Documentation

◆ evaluate() [1/2]

virtual Complex ThePEG::Helicity::AbstractSSSVertex::evaluate ( Energy2  q2,
const ScalarWaveFunction sca1,
const ScalarWaveFunction sca2,
const ScalarWaveFunction sca3 
)
pure virtual

Members to calculate the helicity amplitude expressions for vertices and off-shell particles.

Evaluate the vertex.

Parameters
q2The scale $q^2$ for the coupling at the vertex.
sca1The wavefunction for the first scalar.
sca2The wavefunction for the second scalar.
sca3The wavefunction for the third scalar.

Implemented in ThePEG::Helicity::SSSVertex.

Referenced by AbstractSSSVertex().

◆ evaluate() [2/2]

virtual ScalarWaveFunction ThePEG::Helicity::AbstractSSSVertex::evaluate ( Energy2  q2,
int  iopt,
tcPDPtr  out,
const ScalarWaveFunction sca1,
const ScalarWaveFunction sca2,
complex< Energy mass = -GeV,
complex< Energy width = -GeV 
)
pure virtual

Evaluate the off-shell scalar coming from the vertex.

Parameters
q2The scale $q^2$ for the coupling at the vertex.
ioptOption of the shape of the Breit-Wigner for the off-shell scalar.
outThe ParticleData pointer for the off-shell scalar.
sca1The wavefunction for the first scalar.
sca2The wavefunction for the second scalar.
massThe mass of the off-shell particle if not taken from the ParticleData object
widthThe width of the off-shell particle if not taken from the ParticleData object

Implemented in ThePEG::Helicity::SSSVertex.

◆ Init()

static void ThePEG::Helicity::AbstractSSSVertex::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 AbstractSSSVertex().

◆ operator=()

AbstractSSSVertex& ThePEG::Helicity::AbstractSSSVertex::operator= ( const AbstractSSSVertex )
private

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

Referenced by AbstractSSSVertex().


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