thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.2.1
ThePEG::StandardModelBase Class Reference

StandardModelBase is used to handle standard model parameters in an EventGenerator. More...

#include <StandardModelBase.h>

Inheritance diagram for ThePEG::StandardModelBase:

Public Member Functions

unsigned int families () const
 Return the number of families assumed in the standard model.
 
virtual bool preInitialize () const
 Overloaded function from Interfaced.
 
Standard constructors and destructors.
 StandardModelBase ()
 Default constructor.
 
virtual ~StandardModelBase ()
 Destructor.
 
Functions accessing electro-weak parameters.
unsigned int ewScheme () const
 Return the electroweak scheme used.
 
void ewScheme (unsigned int s)
 Set the electroweak scheme used.
 
double alphaEM () const
 Constant $\alpha_{EM}(q^2=0)$.
 
double alphaEMMZ () const
 Constant $\alpha_{EM}(q^2=m_Z^2)$.
 
double alphaEMME (Energy2 scale) const
 The electromagnetic coupling for vertex classes in a well defined self-consistent EW scheme if requested.
 
double alphaEM (Energy2 scale) const
 Running $\alpha_{EM}$.
 
tAEMPtr alphaEMPtr () const
 Return a pointer to the object handling $\alpha_{EM}$.
 
double sin2ThetaW () const
 Return $\sin^2(\theta_W)$.
 
InvEnergy2 fermiConstant () const
 The Fermi constant.
 
double enu () const
 The neutrino-photon coupling.
 
double ee () const
 The charged lepton-photon coupling.
 
double eu () const
 The up-type-photon coupling.
 
double ed () const
 The down-type-photon coupling.
 
double vnu () const
 The vector neutrino- $Z^0$ coupling.
 
double ve () const
 The vector charged lepton- $Z^0$ coupling.
 
double vu () const
 The vector up-type- $Z^0$ coupling.
 
double vd () const
 The vector down-type- $Z^0$ coupling.
 
double anu () const
 The axial neutrino- $Z^0$ coupling.
 
double ae () const
 The axial charged lepton- $Z^0$ coupling.
 
double au () const
 The axial up-type- $Z^0$ coupling.
 
double ad () const
 The axial down-type- $Z^0$ coupling.
 
tCKMPtr CKM () const
 Return a pointer to the CKMBase object used.
 
double CKM (unsigned int uf, unsigned int df) const
 Return a square of the element of the Cabibbo-Kobayashi-Maskawa Matrix. More...
 
double CKM (const ParticleData &uType, const ParticleData &dType) const
 Return the square of the elements of the Cabibbo-Kobayashi-Maskawa Matrix.
 
Functions accessing QCD parameters.
unsigned int Nc () const
 Return the number of colours.
 
unsigned int Nf (Energy2 scale) const
 Return the number of avtive quark flavours for a given scale.
 
double alphaS () const
 Return the constant strong coupling constant.
 
double alphaS (Energy2 scale) const
 Return the running strong coupling for a given scale.
 
tASPtr alphaSPtr () const
 Return a pointer to the object handling $\alpha_S$.
 
Energy LambdaQCD (unsigned int nflav) const
 Return the $\Lambda_{QCD}$ for nflav active flavours.
 
Energy LambdaQCD (Energy2 scale) const
 Return the $\Lambda_{QCD}$ for the given scale.
 
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::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.
 
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.
 
 Named (const Named &)=default
 Explicit default copy-constructor (too avoid compiler warnings)
 
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.
 
- 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

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 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 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...
 
virtual IVector getReferences ()
 Return a vector of all pointers to Interfaced objects used in this object. More...
 
virtual void rebind (const TranslationMap &)
 Rebind pointer to other Interfaced objects. 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 Types

typedef Ptr< AlphaEMBase >::pointer AEMPtr
 Declare a pointer to an AlphaEMBase object. More...
 
typedef Ptr< AlphaSBase >::pointer ASPtr
 Declare a pointer to an AlphaSBase object. More...
 
typedef Ptr< CKMBase >::pointer CKMPtr
 Declare a pointer to n CKMBase object. More...
 
typedef Ptr< AlphaEMBase >::transient_pointer tAEMPtr
 Declare a transient pointer to an AlphaEMBase object. More...
 
typedef Ptr< AlphaSBase >::transient_pointer tASPtr
 Declare a transient pointer to an AlphaSBase object. More...
 
typedef Ptr< CKMBase >::transient_pointer tCKMPtr
 Declare a transient pointer to a CKMBase object. More...
 

Private Member Functions

StandardModelBaseoperator= (const StandardModelBase &)=delete
 Private and non-existent assignment operator.
 

Private Attributes

unsigned int theFamilies
 The number of families.
 
double theAlphaEM
 The constant $\alpha_{EM}$.
 
double theAlphaEMMZ
 The constant $\alpha_{EM}$.
 
AEMPtr theRunningAlphaEM
 Pointer to an object capable of calculating the running $\alpha_{EM}$.
 
double theSin2ThetaW
 The $\sin^2(\theta_W)$.
 
InvEnergy2 theGF
 The Fermi contants $G_F$.
 
double theEnu
 Coupling between a fundamental fermion and the photon.
 
double theEe
 Coupling between a fundamental fermion and the photon.
 
double theEu
 Coupling between a fundamental fermion and the photon.
 
double theEd
 Coupling between a fundamental fermion and the photon.
 
double theVnu
 Vector coupling between a fundamental fermion and Z^0.
 
double theVe
 Vector coupling between a fundamental fermion and Z^0.
 
double theVu
 Vector coupling between a fundamental fermion and Z^0.
 
double theVd
 Vector coupling between a fundamental fermion and Z^0.
 
double theAnu
 Axial coupling between a fundamental fermions and Z^0.
 
double theAe
 Axial coupling between a fundamental fermions and Z^0.
 
double theAu
 Axial coupling between a fundamental fermions and Z^0.
 
double theAd
 Axial coupling between a fundamental fermions and Z^0.
 
long recalculateEW
 If true, the electro-weak couplings are derived from $\theta_W$ in the initialization.
 
CKMPtr theCKM
 A pointer to an object representing the Cabibbo-Kobayashi-Maskawa matrix.
 
vector< vector< double > > theCKM2Matrix
 The matrix of squared CKM elements set from theCKM at initialization.
 
unsigned int theNc
 The number of colours;.
 
double theAlphaS
 The fixed strong coupling.
 
ASPtr theRunningAlphaS
 Pointer to an object capable of calculating the running $\alpha_{S}$.
 
unsigned int theElectroWeakScheme
 Electroweak scheme.
 
unsigned int theBosonWidthOption
 Option for the calculation of the W/Z widths.
 

Static Private Attributes

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

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

StandardModelBase is used to handle standard model parameters in an EventGenerator.

It uses AlphaEMBase, AlphaSBase and CKMBase to help with the implementation of the electro-magnetic and QCD couplings and the flavour mixing matrix. This means that StandardModelBase does not need to be inherited from when it comes to standard model parameters. Beyond the standard model parameters should be implemented as sub-classes.

See also
The interfaces defined for StandardModelBase.
EventGenerator
AlphaEMBase
AlphaSBase
CKMBase

Definition at line 38 of file StandardModelBase.h.

Member Typedef Documentation

◆ AEMPtr

Declare a pointer to an AlphaEMBase object.

Definition at line 41 of file StandardModelBase.h.

◆ ASPtr

typedef Ptr<AlphaSBase>::pointer ThePEG::StandardModelBase::ASPtr
private

Declare a pointer to an AlphaSBase object.

Definition at line 43 of file StandardModelBase.h.

◆ CKMPtr

typedef Ptr<CKMBase>::pointer ThePEG::StandardModelBase::CKMPtr
private

Declare a pointer to n CKMBase object.

Definition at line 45 of file StandardModelBase.h.

◆ tAEMPtr

typedef Ptr<AlphaEMBase>::transient_pointer ThePEG::StandardModelBase::tAEMPtr
private

Declare a transient pointer to an AlphaEMBase object.

Definition at line 47 of file StandardModelBase.h.

◆ tASPtr

typedef Ptr<AlphaSBase>::transient_pointer ThePEG::StandardModelBase::tASPtr
private

Declare a transient pointer to an AlphaSBase object.

Definition at line 49 of file StandardModelBase.h.

◆ tCKMPtr

typedef Ptr<CKMBase>::transient_pointer ThePEG::StandardModelBase::tCKMPtr
private

Declare a transient pointer to a CKMBase object.

Definition at line 51 of file StandardModelBase.h.

Member Function Documentation

◆ CKM()

double ThePEG::StandardModelBase::CKM ( unsigned int  uf,
unsigned int  df 
) const

Return a square of the element of the Cabibbo-Kobayashi-Maskawa Matrix.

The fatrix element for the uf up-type family and df down-type family.

◆ clone()

virtual IBPtr ThePEG::StandardModelBase::clone ( ) const
protectedvirtual

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

Referenced by preInitialize().

◆ doinit()

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

Referenced by preInitialize().

◆ fullclone()

virtual IBPtr ThePEG::StandardModelBase::fullclone ( ) const
protectedvirtual

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

Returns
a pointer to the new object.

Reimplemented from ThePEG::InterfacedBase.

Referenced by preInitialize().

◆ persistentInput()

void ThePEG::StandardModelBase::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 LambdaQCD().

◆ persistentOutput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

Referenced by LambdaQCD().


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