herwig is hosted by Hepforge, IPPP Durham
Herwig  7.2.1
Herwig::UEDBase Class Reference

This class serves as a base class for all UED models. More...

#include <UEDBase.h>

Inheritance diagram for Herwig::UEDBase:

Public Types

typedef pair< long, Energy > IDMassPair
 Typedef for ID-Mass pair. More...
 
typedef map< unsigned int, double > WAMap
 Typedef for unsigned int/double map to store Weinburg angles. More...
 
- Public Types inherited from ThePEG::InterfacedBase
enum  InitState
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 

Public Member Functions

 UEDBase ()
 The 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 Access Functions.
InvEnergy compactRadius () const
 Return the compactification radius.
 
double sinThetaN (const unsigned int n) const
 Return the Weinburg mixing angle for any level.
 
double sinThetaOne () const
 Return the Weinburg mixing angle for $n = 1$.
 
- Public Member Functions inherited from Herwig::BSMModel
 BSMModel ()
 The default constructor.
 
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 Herwig::StandardModel
Energy mass (Energy2 scale, tcPDPtr part) const
 Return the running mass for a given scale $q^2$ and particle type. More...
 
trunPtr massPtr () const
 Return a pointer to the object handling the running mass.
 
const map< string, pair< unsigned int, int > > & couplings () const
 Set the couplings in the model.
 
 StandardModel ()
 Default constructor.
 
 StandardModel (const StandardModel &)
 Copy-constructor.
 
virtual ~StandardModel ()
 Destructor.
 
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...
 
double lnu () const
 The left and right couplings of the Z^0 including sin and cos theta_W. More...
 
double le () const
 The left-handed coupling of a charged lepton.
 
double lu () const
 The left-handed coupling of an up type quark.
 
double ld () const
 The left-handed coupling of a down type quark.
 
double rnu () const
 The right-handed coupling of a neutrino.
 
double re () const
 The right-handed coupling of a charged lepton.
 
double ru () const
 The right-handed coupling of an up type quark.
 
double rd () const
 The right-handed coupling of a down type quark.
 
virtual tAbstractFFVVertexPtr vertexFFZ () const
 Pointers to the objects handling the vertices. More...
 
virtual tAbstractFFVVertexPtr vertexFFP () const
 Pointer to the fermion-fermion-photon vertex.
 
virtual tAbstractFFVVertexPtr vertexFFG () const
 Pointer to the fermion-fermion-gluon vertex.
 
virtual tAbstractFFVVertexPtr vertexFFW () const
 Pointer to the fermion-fermion-W vertex.
 
virtual tAbstractFFSVertexPtr vertexFFH () const
 Pointer to the fermion-fermion-Higgs vertex.
 
virtual tAbstractVVVVertexPtr vertexGGG () const
 Pointer to the triple gluon vertex.
 
virtual tAbstractVVVVertexPtr vertexWWW () const
 Pointer to the triple electroweak gauge boson vertex.
 
virtual tAbstractVVSVertexPtr vertexWWH () const
 Pointer to the two electroweak gauge boson Higgs vertex.
 
virtual tAbstractVVVVVertexPtr vertexWWWW () const
 Pointer to the quartic electroweak gauge boson vertex.
 
virtual tAbstractVVVVVertexPtr vertexGGGG () const
 Pointer to the quartic gluon vertex.
 
virtual tAbstractVVSVertexPtr vertexHGG () const
 Pointer to the quartic gluon vertex.
 
virtual tAbstractVVSVertexPtr vertexHPP () const
 Pointer to the quartic gluon vertex.
 
virtual tAbstractSSSVertexPtr vertexHHH () const
 Pointer to the triple Higgs vertex.
 
virtual tAbstractVVSSVertexPtr vertexWWHH () const
 Pointer to the WWHH vertex.
 
unsigned int numberOfVertices () const
 Total number of vertices.
 
tVertexBasePtr vertex (size_t ix) const
 Access to a vertex from the list.
 
- Public Member Functions inherited from ThePEG::StandardModelBase
unsigned int families () const
 
unsigned int ewScheme () const
 
void ewScheme (unsigned int s)
 
double alphaEM () const
 
double alphaEMMZ () const
 
double alphaEMME (Energy2 scale) const
 
double alphaEM (Energy2 scale) const
 
tAEMPtr alphaEMPtr () const
 
double sin2ThetaW () const
 
InvEnergy2 fermiConstant () const
 
double enu () const
 
double ee () const
 
double eu () const
 
double ed () const
 
double vnu () const
 
double ve () const
 
double vu () const
 
double vd () const
 
double anu () const
 
double ae () const
 
double au () const
 
double ad () const
 
tCKMPtr CKM () const
 
double CKM (unsigned int uf, unsigned int df) const
 
double CKM (const ParticleData &uType, const ParticleData &dType) const
 
unsigned int Nc () const
 
unsigned int Nf (Energy2 scale) const
 
double alphaS () const
 
double alphaS (Energy2 scale) const
 
tASPtr alphaSPtr () const
 
Energy LambdaQCD (unsigned int nflav) const
 
Energy LambdaQCD (Energy2 scale) const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
unsigned int ewScheme () const
 
void ewScheme (unsigned int s)
 
double alphaEM () const
 
double alphaEMMZ () const
 
double alphaEMME (Energy2 scale) const
 
double alphaEM (Energy2 scale) const
 
tAEMPtr alphaEMPtr () const
 
double sin2ThetaW () const
 
InvEnergy2 fermiConstant () const
 
double enu () const
 
double ee () const
 
double eu () const
 
double ed () const
 
double vnu () const
 
double ve () const
 
double vu () const
 
double vd () const
 
double anu () const
 
double ae () const
 
double au () const
 
double ad () const
 
tCKMPtr CKM () const
 
double CKM (unsigned int uf, unsigned int df) const
 
double CKM (const ParticleData &uType, const ParticleData &dType) const
 
unsigned int Nc () const
 
unsigned int Nf (Energy2 scale) const
 
double alphaS () const
 
double alphaS (Energy2 scale) const
 
tASPtr alphaSPtr () const
 
Energy LambdaQCD (unsigned int nflav) const
 
Energy LambdaQCD (Energy2 scale) const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
- Public Member Functions inherited from ThePEG::Interfaced
virtual bool defaultInit ()
 
PPtr getParticle (PID) const
 
PDPtr getParticleData (PID) const
 
bool used () const
 
void useMe () const
 
tEGPtr generator () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
PPtr getParticle (PID) const
 
PDPtr getParticleData (PID) const
 
bool used () const
 
void useMe () const
 
tEGPtr generator () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
- Public Member Functions inherited from ThePEG::InterfacedBase
string fullName () const
 
string name () const
 
string path () const
 
string comment () const
 
void setup (istream &is)
 
virtual void debugme () const
 
void update ()
 
void init ()
 
void initrun ()
 
void finish ()
 
void touch ()
 
void reset ()
 
void clear ()
 
InitState state () const
 
bool locked () const
 
bool touched () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
void update ()
 
void init ()
 
void initrun ()
 
void finish ()
 
void touch ()
 
void reset ()
 
void clear ()
 
InitState state () const
 
bool locked () const
 
bool touched () const
 
void persistentOutput (PersistentOStream &os) const
 
void persistentInput (PersistentIStream &is, int version)
 
- Public Member Functions inherited from ThePEG::Base
void debug () const
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 
 Named (const Named &)=default
 
const string & name () const
 
bool operator== (const Named &other) const
 
bool operator< (const Named &other) const
 

Static Public Member Functions

static void Init ()
 The standard Init function used to initialize the interfaces. More...
 
- Static Public Member Functions inherited from Herwig::BSMModel
static void Init ()
 The standard Init function used to initialize the interfaces. More...
 
- Static Public Member Functions inherited from Herwig::StandardModel
static void Init ()
 Standard Init function used to initialize the interfaces.
 
- Static Public Member Functions inherited from ThePEG::StandardModelBase
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::Interfaced
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::InterfacedBase
static void Init ()
 
- Static Public Member Functions inherited from ThePEG::Base
static void Init ()
 

Protected Member Functions

void addMassElement (IDMassPair elem)
 Add a new ID,mass pair to the mass storage. More...
 
void addMixingAngle (const unsigned int n, const double val)
 Add a new mixing angle to the storage. More...
 
Clone Methods.
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...
 
Standard Interfaced functions.
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk. More...
 
- Protected Member Functions inherited from Herwig::BSMModel
const string & decayFile () const
 Get name of SLHA decay file.
 
void decayFile (string in)
 Set name of SLHA decay file.
 
void decayRead ()
 Read the decays.
 
void readDecay (CFileLineReader &ifs, string decay) const
 Read decaymodes from LHA file. More...
 
void createDecayMode (string tag, double brat) const
 Create a DecayMode object in the repository. More...
 
vector< pair< double, string > > createWZDecayModes (string tag, double brat, tcPDPtr boson, Energy maxMass) const
 Create a DecayMode object in the repository. More...
 
bool readDecays () const
 read the decays
 
void readDecays (bool in)
 set the reading of the decays
 
map< long, long > & idMap ()
 Map of PDG ids from file to those used internally.
 
PDPtr getBSMParticleData (PID id) const
 Get ParticleData object with Id mapping.
 
virtual bool preInitialize () const
 Overloaded function from Interfaced.
 
- Protected Member Functions inherited from Herwig::StandardModel
virtual bool registerDefaultVertices () const
 Should the default vertices be considered for generic diagrams.
 
void addVertex (VertexBasePtr in)
 Add a vertex to the list.
 
void resetMass (long id, Energy mass, tPDPtr particle=tPDPtr())
 Helper function to reset the mass of a ParticleData object in BSM models.
 
void setCouplings (string name, pair< unsigned int, int > vals)
 Set the couplings in the model.
 
- Protected Member Functions inherited from ThePEG::Interfaced
void reporeg (IBPtr object, string name) const
 
bool setDefaultReference (PtrT &ptr, string classname, string objectname)
 
 Interfaced (const string &newName)
 
 Interfaced (const Interfaced &i)
 
void setGenerator (tEGPtr generator)
 
- Protected Member Functions inherited from ThePEG::InterfacedBase
 InterfacedBase (string newName)
 
 InterfacedBase (const InterfacedBase &i)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinitrun ()
 
virtual void dofinish ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
virtual void readSetup (istream &is)
 
virtual void doupdate ()
 
virtual void doinitrun ()
 
virtual void dofinish ()
 
virtual IVector getReferences ()
 
virtual void rebind (const TranslationMap &)
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (const Named &other)
 
const string & name (const string &newName)
 

Private Member Functions

void writeSpectrum ()
 Write out a spectrum file ordered in mass (name can be set by an interface).
 
UEDBaseoperator= (const UEDBase &)=delete
 The assignment operator is private and must never be called. More...
 
Utility Functions for calculating masses.
void calculateKKMasses (const unsigned int n)
 Calculate the radiative corrections to the masses of the KK excitations. More...
 
void bosonMasses (const unsigned int n)
 Calculate the radiative corrections to the spin-0 and spin-1 masses of the KK excitations. More...
 
void fermionMasses (const unsigned int n)
 Calculate the radiative corrections to the spin-1/2 masses of the KK excitations. More...
 
void resetMass (long id, Energy value)
 Reset the mass of the ParticleData object. More...
 
double calculateMixingAngle (const unsigned int n)
 Calculate the Weinburg Mixing angle for the appropriate level. More...
 

Static Private Member Functions

static bool lowerMass (const pair< long, Energy > &p1, const pair< long, Energy > &p2)
 A predicate for sorting the list of masses.
 

Private Attributes

bool theRadCorr
 Whether to calculate the radiative corrections to the KK masses.
 
Energy theInvRadius
 Store the radius of the compactified dimension.
 
double theLambdaR
 The value of $\Lambda R $.
 
Energy theMbarH
 The boundary mass term for the Higgs.
 
WAMap theMixingAngles
 The values of $\sin\theta_N$.
 
double theSinThetaOne
 Store $\sin\theta_1$ for faster access.
 
vector< IDMassPairtheMasses
 Store the masses of the new particles.
 
Energy theVeV
 The value of the vacuum expectation value of the higgs field.
 
bool includeSMMass_
 Include SM masses in calculation of KK masses.
 
bool fixedCouplings_
 Use fixed couplings for the mass calculation.
 
bool includeGaugeMixing_
 Include gauge boson mixing.
 
The level 1 UED vertices.
AbstractFFVVertexPtr theF1F1Z0Vertex
 The $\bar{f}^{(1)}f^{(1)}Z^{(0)}$.
 
AbstractFFVVertexPtr theF1F1G0Vertex
 The $\bar{f}^{(1)}f^{(1)}g^{(0)}$.
 
AbstractFFVVertexPtr theF1F0G1Vertex
 The $\bar{f}^{(1)}f^{(0)}g^{(1)}$.
 
AbstractVVVVertexPtr theG1G1G0Vertex
 The $g^{(1)}g^{(1)}g$ vertex.
 
AbstractVVVVVertexPtr theG0G0G1G1Vertex
 The $g\,g\,g^{(1)},g^{(1)}$ vertex.
 
AbstractFFVVertexPtr theF1F1P0Vertex
 The $\bar{f}^{(1)}f^{(1)}\gamma$.
 
AbstractFFVVertexPtr theF1F1W0Vertex
 The $\bar{f}^{(1)}f^{(1)}W$.
 
AbstractFFVVertexPtr theF1F0W1Vertex
 The $\bar{f}^{(1)}f^{(0)}W^{(1)}$.
 
AbstractFFSVertexPtr theF1F0H1Vertex
 The $\bar{f}^{(1)}f^{(0)}H^{(1)}$.
 
AbstractVSSVertexPtr theP0H1H1Vertex
 The $ A^\mu_{(0)}H^+_{(1)}H-_{(1)}$.
 
AbstractVSSVertexPtr theZ0H1H1Vertex
 The $ Z^\mu_{(0)}H^+_{(1)}H-_{(1)}$.
 
AbstractVSSVertexPtr theW0A1H1Vertex
 The $ W^\pm_{\mu(0)}A_{(1)}H^\mp_{(1)}$.
 
AbstractVSSVertexPtr theZ0A1h1Vertex
 The $ Z^\mu_{\mu(0)}A_{(1)}h_{(1)}$.
 
AbstractVVVVertexPtr theW0W1W1Vertex
 The $W^{(1)}Z^{(1)}W_{(0)}$ vertex.
 

Additional Inherited Members

- Public Attributes inherited from ThePEG::InterfacedBase
 initializing
 
 uninitialized
 
 initialized
 
 runready
 
- Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long uniqueId
 
- Static Protected Member Functions inherited from ThePEG::Interfaced
static void registerRepository (IBPtr)
 
static void registerRepository (IBPtr, string newName)
 

Detailed Description

This class serves as a base class for all UED models.

It stores the values of the inverse radius and the product $\Lambda R $ and has functions to calculate the radiative corrections to the nth level KK excitations.

To use this class for n > 1 simply inherit off it, calculate the necessary masses using the provided functions for the new excitations and add the appropriate vertices.

See also
The interfaces defined for UEDBase.

Definition at line 38 of file UEDBase.h.

Member Typedef Documentation

◆ IDMassPair

typedef pair<long, Energy> Herwig::UEDBase::IDMassPair

Typedef for ID-Mass pair.

Definition at line 43 of file UEDBase.h.

◆ WAMap

typedef map<unsigned int, double> Herwig::UEDBase::WAMap

Typedef for unsigned int/double map to store Weinburg angles.

Definition at line 46 of file UEDBase.h.

Member Function Documentation

◆ addMassElement()

void Herwig::UEDBase::addMassElement ( IDMassPair  elem)
inlineprotected

Add a new ID,mass pair to the mass storage.

Parameters
elemThe element to add in to storage

Definition at line 109 of file UEDBase.h.

◆ addMixingAngle()

void Herwig::UEDBase::addMixingAngle ( const unsigned int  n,
const double  val 
)
inlineprotected

Add a new mixing angle to the storage.

Parameters
nThe level
valThe value

Definition at line 118 of file UEDBase.h.

◆ bosonMasses()

void Herwig::UEDBase::bosonMasses ( const unsigned int  n)
private

Calculate the radiative corrections to the spin-0 and spin-1 masses of the KK excitations.

Parameters
nThe KK-level for which to calculate the masses.

◆ calculateKKMasses()

void Herwig::UEDBase::calculateKKMasses ( const unsigned int  n)
private

Calculate the radiative corrections to the masses of the KK excitations.

Parameters
nThe KK-level for which to calculate the masses.

◆ calculateMixingAngle()

double Herwig::UEDBase::calculateMixingAngle ( const unsigned int  n)
private

Calculate the Weinburg Mixing angle for the appropriate level.

Parameters
nThe KK-level for which to calculate the mixing angle.

◆ clone()

virtual IBPtr Herwig::UEDBase::clone ( ) const
inlineprotectedvirtual

Make a simple clone of this object.

Returns
a pointer to the new object.

Reimplemented from Herwig::StandardModel.

Definition at line 182 of file UEDBase.h.

◆ doinit()

virtual void Herwig::UEDBase::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 Herwig::BSMModel.

◆ fermionMasses()

void Herwig::UEDBase::fermionMasses ( const unsigned int  n)
private

Calculate the radiative corrections to the spin-1/2 masses of the KK excitations.

Parameters
nThe KK-level for which to calculate the masses.

◆ fullclone()

virtual IBPtr Herwig::UEDBase::fullclone ( ) const
inlineprotectedvirtual

Make a clone of this object, possibly modifying the cloned object to make it sane.

Returns
a pointer to the new object.

Reimplemented from Herwig::StandardModel.

Definition at line 188 of file UEDBase.h.

◆ Init()

static void Herwig::UEDBase::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=()

UEDBase& Herwig::UEDBase::operator= ( const UEDBase )
privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

void Herwig::UEDBase::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 Herwig::UEDBase::persistentOutput ( PersistentOStream os) const

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ resetMass()

void Herwig::UEDBase::resetMass ( long  id,
Energy  value 
)
private

Reset the mass of the ParticleData object.

Parameters
idThe id of the particles mass to reset
valueThe new mass

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