herwig is hosted by Hepforge, IPPP Durham
Herwig  7.1.4

Here is the documentation of the BSMModel class. More...

#include <BSMModel.h>

Inheritance diagram for Herwig::BSMModel:

Public Member Functions

 BSMModel ()
 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 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.
 
 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())
 
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::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

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

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

Private Attributes

string decayFile_
 Name of the decay file.
 
bool readDecays_
 Read the decays from the file.
 
bool topModesFromFile_
 Whether or not to replace the top decay modes with those from the SLHA files.
 
double tolerance_
 Tolerance for branching ratios.
 
map< long, long > idMap_
 Map of ids from files to those used by Herwig.
 
bool allowedToResetSMWidths_
 Whether or not to allow the width of SM particles to be reset.
 

Additional Inherited Members

- Public Types inherited from ThePEG::InterfacedBase
enum  InitState
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 
- 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

Here is the documentation of the BSMModel class.

See also
The interfaces defined for BSMModel.

Definition at line 21 of file BSMModel.h.

Member Function Documentation

◆ createDecayMode()

void Herwig::BSMModel::createDecayMode ( string  tag,
double  brat 
) const
protected

Create a DecayMode object in the repository.

Parameters
tagThe tag identifying the decay mode including the prefix 'decaymode'
bratBranching ratio of this mode

◆ createWZDecayModes()

vector<pair<double,string> > Herwig::BSMModel::createWZDecayModes ( string  tag,
double  brat,
tcPDPtr  boson,
Energy  maxMass 
) const
protected

Create a DecayMode object in the repository.

Parameters
tagThe tag identifying the decay mode including the prefix 'decaymode'
bratBranching ratio of this mode

◆ doinit()

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

Reimplemented in Herwig::SusyBase, Herwig::ZprimeModel, Herwig::UEDBase, Herwig::LeptoquarkModel, Herwig::SextetModel, Herwig::LHModel, Herwig::TTbAModel, Herwig::ADDModel, Herwig::RSModel, Herwig::RPV, and Herwig::HiggsPair.

Referenced by Herwig::LHTPModel::kappaLepton().

◆ Init()

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

BSMModel& Herwig::BSMModel::operator= ( const BSMModel )
private

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

Referenced by Herwig::LHTPModel::kappaLepton().

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ readDecay()

void Herwig::BSMModel::readDecay ( CFileLineReader ifs,
string  decay 
) const
protected

Read decaymodes from LHA file.

Parameters
ifsinput stream containg data
decaystring containing name of parent and value of total width

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