herwig is hosted by Hepforge, IPPP Durham
Herwig 7.3.0
Herwig::MixingMatrix Class Reference

This class is desinged to store the mixing matrices needed for Susy studies. More...

#include <MixingMatrix.h>

Inheritance diagram for Herwig::MixingMatrix:

Classes

class  MixingMatrixError
 Exception class to indicate problem with mixing matrix . More...
 

Public Member Functions

Constructors
 MixingMatrix (const CMatrix &mix, const vector< long > &ids)
 Constructor that takes a mixing matrix and a vector id's as arguments.
 
 MixingMatrix (unsigned int row, unsigned int col)
 Contructor that initializes size of matrix.
 
 MixingMatrix ()
 Standard Constructor.
 
Get and Set functions.
void setMatrix (const CMatrix &mixing)
 Set the mixing matrix.
 
CMatrix getMatrix () const
 Get the mixing matrix.
 
void setIds (const vector< long > &mixingCodes)
 Set the vector containing mixing particles codes.
 
const vector< long > & getIds () const
 Get the vector containing mixing particles codes.
 
void adjustPhase (long id)
 Multiply row corresponding to id by \(i\).
 
const Complex operator() (unsigned int row, unsigned int col) const
 Access element of matrix.
 
Complexoperator() (unsigned int row, unsigned int col)
 Set element of matrix.
 
void addCode (long id)
 Add a PDG code to the stored vector.
 
MatrixSize size () const
 Return the size of the mixing matrix.
 
- 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.

CMatrix mixingMatrix_
 The mixing matrix.
 
vector< long > ids_
 The PDG codes of the mixing particles.
 
pair< unsigned int, unsigned int > size_
 Size of matrix.
 
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.
 
MixingMatrixoperator= (const MixingMatrix &)=delete
 The assignment operator is private and must never be called.
 
ostream & operator<< (ostream &os, const MixingMatrix &mix)
 Print the matrix to the stream.
 

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.
 

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 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 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 &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (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

This class is desinged to store the mixing matrices needed for Susy studies.

The actual matrix is stored as a nested complex vector. It also stores a vector of PDG codes correspoding to the mass states of mixing states.

See also
Interfaced

Definition at line 78 of file MixingMatrix.h.

Constructor & Destructor Documentation

◆ MixingMatrix() [1/3]

Herwig::MixingMatrix::MixingMatrix ( const CMatrix mix,
const vector< long > &  ids 
)
inline

Constructor that takes a mixing matrix and a vector id's as arguments.

Parameters
mixMixing matrix
idsThe ids of the mixing sparticles

Definition at line 92 of file MixingMatrix.h.

◆ MixingMatrix() [2/3]

Herwig::MixingMatrix::MixingMatrix ( unsigned int  row,
unsigned int  col 
)
inline

Contructor that initializes size of matrix.

Definition at line 99 of file MixingMatrix.h.

◆ MixingMatrix() [3/3]

Herwig::MixingMatrix::MixingMatrix ( )
inline

Standard Constructor.

Definition at line 106 of file MixingMatrix.h.

Member Function Documentation

◆ addCode()

void Herwig::MixingMatrix::addCode ( long  id)
inline

Add a PDG code to the stored vector.

Definition at line 201 of file MixingMatrix.h.

References ids_, size_, and ThePEG::Exception::warning.

◆ adjustPhase()

void Herwig::MixingMatrix::adjustPhase ( long  id)

Multiply row corresponding to id by \(i\).

Parameters
idPDG code of particle

◆ clone()

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

Make a simple clone of this object.

Returns
a pointer to the new object.

Implements ThePEG::InterfacedBase.

Definition at line 225 of file MixingMatrix.h.

◆ fullclone()

virtual IBPtr Herwig::MixingMatrix::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 ThePEG::InterfacedBase.

Definition at line 231 of file MixingMatrix.h.

◆ getIds()

const vector< long > & Herwig::MixingMatrix::getIds ( ) const
inline

Get the vector containing mixing particles codes.

Definition at line 175 of file MixingMatrix.h.

References ids_.

◆ getMatrix()

CMatrix Herwig::MixingMatrix::getMatrix ( ) const
inline

Get the mixing matrix.

Definition at line 149 of file MixingMatrix.h.

References mixingMatrix_.

◆ Init()

static void Herwig::MixingMatrix::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()() [1/2]

Complex & Herwig::MixingMatrix::operator() ( unsigned int  row,
unsigned int  col 
)
inline

Set element of matrix.

Definition at line 194 of file MixingMatrix.h.

References mixingMatrix_.

◆ operator()() [2/2]

const Complex Herwig::MixingMatrix::operator() ( unsigned int  row,
unsigned int  col 
) const
inline

Access element of matrix.

Definition at line 187 of file MixingMatrix.h.

References mixingMatrix_.

◆ operator=()

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

◆ setIds()

void Herwig::MixingMatrix::setIds ( const vector< long > &  mixingCodes)
inline

Set the vector containing mixing particles codes.

Parameters
mixingCodesvector containing PDG codes for mixing particles

Definition at line 155 of file MixingMatrix.h.

References ids_, size_, and ThePEG::Exception::warning.

◆ setMatrix()

void Herwig::MixingMatrix::setMatrix ( const CMatrix mixing)
inline

Set the mixing matrix.

Parameters
mixingThe Mixing matrix stored as nested complex vector

Definition at line 141 of file MixingMatrix.h.

References mixingMatrix_, and size_.

◆ size()

MatrixSize Herwig::MixingMatrix::size ( ) const
inline

Return the size of the mixing matrix.

Definition at line 215 of file MixingMatrix.h.

References size_.

Member Data Documentation

◆ ids_

vector<long> Herwig::MixingMatrix::ids_
private

The PDG codes of the mixing particles.

Definition at line 250 of file MixingMatrix.h.

Referenced by addCode(), getIds(), and setIds().

◆ mixingMatrix_

CMatrix Herwig::MixingMatrix::mixingMatrix_
private

The mixing matrix.

Definition at line 245 of file MixingMatrix.h.

Referenced by getMatrix(), operator()(), and setMatrix().

◆ size_

pair<unsigned int,unsigned int> Herwig::MixingMatrix::size_
private

Size of matrix.

Definition at line 255 of file MixingMatrix.h.

Referenced by addCode(), setIds(), setMatrix(), and size().


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