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

#include <NMSSM.h>

Inheritance diagram for Herwig::NMSSM:

[legend]

Public Member Functions
	NMSSM ()
	The default constructor.

double	lambda () const
	The NMSSM couplings.

double	kappa () const
	Superpotential \(\kappa\) coupling.

Energy	lambdaVEV () const
	The V.E.V of the extra singlet field scaled by \( lambda\),.

Energy	trilinearLambda () const
	Soft trilinear \(SH_2 H_1\) coupling.

Energy	trilinearKappa () const
	Soft cubic \(S\) coupling.

Energy	MQ3 () const
	left 3rd generation scalar quark mass

Energy	MU2 () const
	right scalar top mass

Public Member Functions inherited from Herwig::MSSM
	MSSM ()
	Default constructor.

double	higgsMixingAngle () const
	Value of Higgs mixing angle \(\alpha\).

const complex< Energy > &	topTrilinear () const
	Value of up-type trilinear couplings.

const complex< Energy > &	bottomTrilinear () const
	Value of down-type trilinear couplings.

const complex< Energy > &	tauTrilinear () const
	Value of lepton trilinear couplings.

const MixingMatrixPtr &	stopMix () const
	The stop mixing matrix.

const MixingMatrixPtr &	sbottomMix () const
	The sbottom chargino mixing matrix.

const MixingMatrixPtr &	stauMix () const
	The stau mixing matrix.

const MixingMatrixPtr &	CPevenHiggsMix () const
	Mixing matrix for the neutral CP-even Higgs bosons.

const MixingMatrixPtr &	CPoddHiggsMix () const
	Mixing matrix for the neutral CP-odd Higgs bosons.

const MixingMatrixPtr &	ChargedHiggsMix () const
	Mixing matrix for the charged Higgs bosons.

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

Public Member Functions inherited from Herwig::SusyBase
	SusyBase ()
	The default constructor.

double	tanBeta () const
	Value of \(\tan\beta\).

Energy	muParameter () const
	Value of \(\mu\) parameter.

const MixingMatrixPtr &	neutralinoMix () const
	The neutralino mixing matrix.

const MixingMatrixPtr &	charginoUMix () const
	The U-type chargino mixing matrix.

const MixingMatrixPtr &	charginoVMix () const
	The V-type chargino mixing matrix.

const Complex &	gluinoPhase () const
	The phase for gluino vertices.

bool	majoranaNeutrinos () const
	Treatment of neutrinos.

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

const Energy &	M1 () const
	Soft breaking parameters.

const Energy &	M2 () const
	The bilinear breaking mass term for the wino.

const Energy &	M3 () const
	The bilinear breaking mass term for the gluinos.

const Energy2 &	Mh12 () const
	The soft breaking mass squared for \(H_1\).

const Energy2 &	Mh22 () const
	The soft breaking mass squared for \(H_2\).

const Energy &	MeL () const
	Soft breaking mass for the first generation lepton doublet.

const Energy &	MmuL () const
	Soft breaking mass for the second generation lepton doublet.

const Energy &	MtauL () const
	Soft breaking mass for the third generation lepton doublet.

const Energy &	MeR () const
	Soft breaking mass for the first generation lepton singlet.

const Energy &	MmuR () const
	Soft breaking mass for the second generation lepton singlet.

const Energy &	MtauR () const
	Soft breaking mass for the third generation lepton singlet.

const Energy &	Mq1L () const
	Soft breaking mass for the first generation quark doublet.

const Energy &	Mq2L () const
	Soft breaking mass for the second generation quark doublet.

const Energy &	Mq3L () const
	Soft breaking mass for the third generation quark doublet.

const Energy &	MdR () const
	Soft breaking mass for the down singlet.

const Energy &	MuR () const
	Soft breaking mass for the up singlet.

const Energy &	MsR () const
	Soft breaking mass for the strange singlet.

const Energy &	McR () const
	Soft breaking mass for the charm singlet.

const Energy &	MbR () const
	Soft breaking mass for the bottom singlet.

const Energy &	MtR () const
	Soft breaking mass for the top singlet.

const Energy &	MPlanck () const
	Planck mass.

Public Member Functions inherited from Herwig::BSMModel
	BSMModel ()
	The default constructor.

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

Public Member Functions inherited from Herwig::StandardModel
	StandardModel ()
	Default constructor.

	StandardModel (const StandardModel &)
	Copy-constructor.

virtual	~StandardModel ()
	Destructor.

void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

double	lnu () const
	The left and right couplings of the Z^0 including sin and cos theta_W.

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.

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.

Energy	mass (Energy2 scale, tcPDPtr part) const
	Return the running mass for a given scale \(q^2\) and particle type.

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.

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

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)

virtual bool	preInitialize () const

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

Public Member Functions inherited from ThePEG::InterfacedBase
string	fullName () const

string	name () const

string	path () const

string	comment () const

void	setup (istream &is)

void	update ()

void	init ()

virtual bool	preInitialize () const

void	initrun ()

void	finish ()

void	touch ()

void	reset ()

void	clear ()

InitState	state () const

bool	locked () const

bool	touched () const

virtual IBPtr	fullclone () const

void	persistentOutput (PersistentOStream &os) const

void	persistentInput (PersistentIStream &is, int version)

virtual void	debugme () const

void	update ()

void	init ()

virtual bool	preInitialize () const

void	initrun ()

void	finish ()

void	touch ()

void	reset ()

void	clear ()

InitState	state () const

bool	locked () const

bool	touched () const

virtual IBPtr	fullclone () const

Public Member Functions inherited from ThePEG::Base
void	debug () const

virtual void	debugme () 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

Clone Methods.
double	_lambda
	The NMSSM couplings.

double	_kappa
	Superpotential \(\kappa\) coupling.

Energy	_theAlambda
	Soft trilinear \(SH_2 H_1\) coupling.

Energy	_theAkappa
	Soft cubic \(S\) coupling.

Energy	_lambdaVEV
	The V.E.V of the extra singlet field scaled by \( lambda\).

Energy	_MQ3
	left 3rd generation scalar quark mass

Energy	_MU2
	right scalar top mass

virtual IBPtr	clone () const
	Make a simple clone of this object.

virtual IBPtr	fullclone () const
	Make a clone of this object, possibly modifying the cloned object to make it sane.

NMSSM &	operator= (const NMSSM &)=delete
	The assignment operator is private and must never be called.

Functions used by the persistent I/O system.
void	persistentOutput (PersistentOStream &os) const
	Function used to write out object persistently.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

static void	Init ()
	The standard Init function used to initialize the interfaces.

virtual void	extractParameters (bool checkModel=true)
	Extract the parameters from the input blocks.

virtual void	createMixingMatrices ()
	Create the mixing matrices for the model.

Additional Inherited Members
Public Types inherited from ThePEG::InterfacedBase
enum	InitState

Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int	CounterType

Static Public Member Functions inherited from Herwig::MSSM
static void	Init ()
	The standard Init function used to initialize the interfaces.

Static Public Member Functions inherited from Herwig::SusyBase
static void	Init ()
	The standard Init function used to initialize the interfaces.

Static Public Member Functions inherited from Herwig::BSMModel
static void	Init ()
	The standard Init function used to initialize the interfaces.

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 ()

Public Attributes inherited from ThePEG::InterfacedBase
	initializing

	uninitialized

	initialized

	runready

Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long	uniqueId

Protected Member Functions inherited from Herwig::MSSM
virtual void	adjustMixingMatrix (long id)
	Adjust row of Mixing Matrix if a negative mass occurs in LHA file.

void	CPevenHiggsMix (MixingMatrixPtr in)
	Mixing matrix for the neutral CP-even Higgs bosons.

void	CPoddHiggsMix (MixingMatrixPtr in)
	Mixing matrix for the neutral CP-odd Higgs bosons.

void	ChargedHiggsMix (MixingMatrixPtr in)
	Mixing matrix for the charged Higgs bosons.

void	stopMix (MixingMatrixPtr in)
	Set the stop mixing matrix.

void	sbottomMix (MixingMatrixPtr in)
	The sbottom chargino mixing matrix.

void	stauMix (MixingMatrixPtr in)
	The stau mixing matrix.

void	higgsMixingAngle (double in)
	Value of Higgs mixing angle \(\alpha\).

Protected Member Functions inherited from Herwig::SusyBase
virtual void	doinit ()
	Initialize this object after the setup phase before saving an EventGenerator to disk.

virtual void	readSetup (istream &is)
	Function to read information from a setup file.

void	createMixingMatrix (MixingMatrixPtr &matrix, string name, const MixingVector &values, MatrixSize size)
	Create a object MixingMatrix in the repository.

void	resetRepositoryMasses ()
	Reset masses in the repository to values read from LHA file.

const map< string, ParamMap > &	parameters () const
	Access to the mixings and parameters for the inheriting classes.

const map< string, StringMap > &	info () const
	Info blocks.

const map< string, pair< MatrixSize, MixingVector > > &	mixings () const
	Mixing blocks.

void	neutralinoMix (MixingMatrixPtr nm)
	Reset neutralino mixing matrix.

void	charginoUMix (MixingMatrixPtr um)
	Reset the U-type chargino mixing matrix.

void	charginoVMix (MixingMatrixPtr vm)
	Reset the V-type chargino mixing matrix.

double	findValue (const map< string, ParamMap >::const_iterator pit, int iloc, const string &block, const string &name)
	Read a parameter from a block, checking that the entry exists.

Protected Member Functions inherited from Herwig::BSMModel
virtual bool	preInitialize () const
	Overloaded function from Interfaced.

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.

void	createDecayMode (string tag, double brat) const
	Create a DecayMode object in the repository.

vector< pair< double, string > >	createWZDecayModes (string tag, double brat, tcPDPtr boson, Energy maxMass) const
	Create a DecayMode object in the repository.

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.

Protected Member Functions inherited from Herwig::StandardModel
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.

virtual bool	registerDefaultVertices () const
	Should the default vertices be considered for generic diagrams.

virtual IBPtr	clone () const

virtual IBPtr	fullclone () const

virtual void	doinit ()

virtual IBPtr	clone () const

virtual IBPtr	fullclone () const

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
virtual void	readSetup (istream &is)

virtual void	doupdate ()

virtual void	doinit ()

virtual void	doinitrun ()

virtual void	dofinish ()

virtual IVector	getReferences ()

virtual void	rebind (const TranslationMap &)

virtual IBPtr	clone () const=0

	InterfacedBase (string newName)

	InterfacedBase (const InterfacedBase &i)

virtual void	readSetup (istream &is)

virtual void	doupdate ()

virtual void	doinit ()

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 &)

ReferenceCounted &	operator= (const ReferenceCounted &)

Protected Member Functions inherited from ThePEG::Named
const Named &	operator= (const Named &other)

const string &	name (const string &newName)

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

See also: The interfaces defined for NMSSM.

Definition at line 20 of file NMSSM.h.

Constructor & Destructor Documentation

◆ NMSSM()

Herwig::NMSSM::NMSSM ( )

inline

The default constructor.

Definition at line 27 of file NMSSM.h.

Member Function Documentation

◆ clone()

virtual IBPtr Herwig::NMSSM::clone ( ) const

inlineprotectedvirtual

Make a simple clone of this object.

Returns: a pointer to the new object.

Reimplemented from Herwig::MSSM.

Definition at line 134 of file NMSSM.h.

◆ createMixingMatrices()

virtual void Herwig::NMSSM::createMixingMatrices ( )

protectedvirtual

Create the mixing matrices for the model.

Reimplemented from Herwig::MSSM.

◆ extractParameters()

virtual void Herwig::NMSSM::extractParameters ( bool checkModel = true )

protectedvirtual

Extract the parameters from the input blocks.

Reimplemented from Herwig::MSSM.

◆ fullclone()

virtual IBPtr Herwig::NMSSM::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::MSSM.

Definition at line 140 of file NMSSM.h.

◆ Init()

static void Herwig::NMSSM::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.

◆ kappa()

double Herwig::NMSSM::kappa ( ) const

inline

Superpotential \(\kappa\) coupling.

Definition at line 48 of file NMSSM.h.

References _kappa.

◆ lambda()

double Herwig::NMSSM::lambda ( ) const

inline

The NMSSM couplings.

Superpotential \(\lambda\) term

Definition at line 41 of file NMSSM.h.

References _lambda.

◆ lambdaVEV()

Energy Herwig::NMSSM::lambdaVEV ( ) const

inline

The V.E.V of the extra singlet field scaled by \( lambda\),.

Definition at line 56 of file NMSSM.h.

References _lambdaVEV.

◆ MQ3()

Energy Herwig::NMSSM::MQ3 ( ) const

inline

left 3rd generation scalar quark mass

Definition at line 76 of file NMSSM.h.

References _MQ3.

◆ MU2()

Energy Herwig::NMSSM::MU2 ( ) const

inline

right scalar top mass

Definition at line 83 of file NMSSM.h.

References _MU2.

◆ operator=()

NMSSM & Herwig::NMSSM::operator= ( const NMSSM & )

privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

void Herwig::NMSSM::persistentInput	(	PersistentIStream &	is,
		int	version
	)

Function used to read in object persistently.

Parameters

is	the persistent input stream read from.
version	the version number of the object when written.

◆ persistentOutput()

void Herwig::NMSSM::persistentOutput ( PersistentOStream & os ) const

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

◆ trilinearKappa()

Energy Herwig::NMSSM::trilinearKappa ( ) const

inline

Soft cubic \(S\) coupling.

Definition at line 70 of file NMSSM.h.

References _theAkappa.

◆ trilinearLambda()

Energy Herwig::NMSSM::trilinearLambda ( ) const

inline

Soft trilinear \(SH_2 H_1\) coupling.

Definition at line 63 of file NMSSM.h.

References _theAlambda.

Member Data Documentation

◆ _kappa

double Herwig::NMSSM::_kappa

private

Superpotential \(\kappa\) coupling.

Definition at line 165 of file NMSSM.h.

Referenced by kappa().

◆ _lambda

double Herwig::NMSSM::_lambda

private

The NMSSM couplings.

Superpotential \(\lambda\) term

Definition at line 160 of file NMSSM.h.

Referenced by lambda().

◆ _lambdaVEV

Energy Herwig::NMSSM::_lambdaVEV

private

The V.E.V of the extra singlet field scaled by \( lambda\).

Definition at line 181 of file NMSSM.h.

Referenced by lambdaVEV().

◆ _MQ3

Energy Herwig::NMSSM::_MQ3

private

left 3rd generation scalar quark mass

Definition at line 185 of file NMSSM.h.

Referenced by MQ3().

◆ _MU2

Energy Herwig::NMSSM::_MU2

private

right scalar top mass

Definition at line 190 of file NMSSM.h.

Referenced by MU2().

◆ _theAkappa

Energy Herwig::NMSSM::_theAkappa

private

Soft cubic \(S\) coupling.

Definition at line 175 of file NMSSM.h.

Referenced by trilinearKappa().

◆ _theAlambda

Energy Herwig::NMSSM::_theAlambda

private

Soft trilinear \(SH_2 H_1\) coupling.

Definition at line 170 of file NMSSM.h.

Referenced by trilinearLambda().

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

NMSSM.h

Public Member Functions

Clone Methods.

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NMSSM()

Member Function Documentation

◆ clone()

◆ createMixingMatrices()

◆ extractParameters()

◆ fullclone()

◆ Init()

◆ kappa()

◆ lambda()

◆ lambdaVEV()

◆ MQ3()

◆ MU2()

◆ operator=()

◆ persistentInput()

◆ persistentOutput()

◆ trilinearKappa()

◆ trilinearLambda()

Member Data Documentation

◆ _kappa

◆ _lambda

◆ _lambdaVEV

◆ _MQ3

◆ _MU2

◆ _theAkappa

◆ _theAlambda