C++ interface for the FORTRAN 4-fermion final state generator KoralW. More...

#include <KoralW.h>

Public Member Functions
	KoralW ()
	Constructor.

	~KoralW ()
	Destructor.

void	setCMSEnergy (double cmsEnergy)
	Sets the CMS energy.

void	init (const std::string &dataPath, const std::string &userDataFile)
	Initializes the generator.

void	generateEvent (MCParticleGraph &mcGraph, ROOT::Math::XYZVector vertex, ROOT::Math::LorentzRotation boost)
	Generates one single event.

void	term ()
	Terminates the generator.

double	getCrossSection ()
	Returns the total cross section of the generated process.

double	getCrossSectionError ()
	Returns the error on the total cross section of the generated process.

Protected Member Functions
void	storeParticle (MCParticleGraph &mcGraph, const float mom, const float vtx, int pdg, ROOT::Math::XYZVector vertex, ROOT::Math::LorentzRotation boost, bool isVirtual=false, bool isInitial=false)
	Store a single generated particle into the MonteCarlo graph.

Protected Attributes
double	m_crossSection
	The cross section of the generated KoralW events.

double	m_crossSectionError
	The error on the cross section of the generated KoralW events.

double	m_cmsEnergy
	CMS Energy = 2*Ebeam [GeV].

Private Attributes
double	m_XPar [m_numXPar]
	Values of parameters for KoralW.

unsigned int	m_seed1
	First seed for the random number generator.

unsigned int	m_seed2
	Second seed for the random number generator.

unsigned int	m_seed3
	Third seed for the random number generator.

Static Private Attributes
static constexpr int	m_numXPar = 10000
	Number of parameters for KoralW.

Detailed Description

C++ interface for the FORTRAN 4-fermion final state generator KoralW.

Definition at line 30 of file KoralW.h.

Constructor & Destructor Documentation

◆ KoralW()

KoralW ( )

inline

Constructor.

Definition at line 35 of file KoralW.h.

             :
      m_crossSection(0.0),
      m_crossSectionError(0.0),
      m_cmsEnergy(0.0),
      m_seed1(900000000),
      m_seed2(10000),
      m_seed3(1000)
    {for (int i = 0; i < m_numXPar; i++) m_XPar[i] = 0.0;}

◆ ~KoralW()

~KoralW ( )

inline

Destructor.

Definition at line 46 of file KoralW.h.

46{};

Member Function Documentation

◆ generateEvent()

void generateEvent	(	MCParticleGraph &	mcGraph,
		ROOT::Math::XYZVector	vertex,
		ROOT::Math::LorentzRotation	boost
	)

Generates one single event.

Parameters

mcGraph	Reference to the MonteCarlo graph into which the generated particles will be stored.
vertex	generated vertex.
boost	generated boost.

Definition at line 107 of file KoralW.cc.

{
  kw_make_();
 
  //Store the particles with status id 3 and 2 as virtual particles, the particles with status id 1 as real particles
  for (int iPart = 0; iPart < hepevt_.nhep; ++iPart) {
    if (hepevt_.isthep[iPart] > 1) {
      storeParticle(mcGraph, hepevt_.phep[iPart], hepevt_.vhep[iPart], hepevt_.idhep[iPart], vertex, boost, true);
    } else {
      storeParticle(mcGraph, hepevt_.phep[iPart], hepevt_.vhep[iPart], hepevt_.idhep[iPart], vertex, boost);
    }
  }
}

◆ getCrossSection()

double getCrossSection ( )

inline

Returns the total cross section of the generated process.

Returns: The total cross section.

Definition at line 75 of file KoralW.h.

75{ return m_crossSection; }

◆ getCrossSectionError()

double getCrossSectionError ( )

inline

Returns the error on the total cross section of the generated process.

Returns: The error on the total cross section.

Definition at line 80 of file KoralW.h.

80{ return m_crossSectionError; }

◆ init()

void init	(	const std::string &	dataPath,
		const std::string &	userDataFile
	)

Initializes the generator.

Parameters

dataPath	The path to the default input data file for KoralW.
userDataFile	The path and filename of the user input data file, which defines the user settings for the generator.

Definition at line 71 of file KoralW.cc.

{
  if (dataPath.empty()) B2FATAL("KoralW: The specified data path is empty !");
  if (userDataFile.empty()) B2FATAL("KoralW: The specified user data file is empty !");
 
  //Make sure the dataPath ends with an "/"
  string dataPathNew = dataPath;
  if (dataPath[dataPath.length() - 1] != '/') dataPathNew += "/";
 
  //Set the path to the data files
  size_t pathLength = dataPathNew.size();
  kw_setdatapath_(dataPathNew.c_str(), &pathLength);
 
  //Load the default KoralW input data
  int reset = 1;
  const string defaultDataFile = dataPathNew + "KoralW_Default.data";
  pathLength = defaultDataFile.size();
  kw_readatax_(defaultDataFile.c_str(), &pathLength, &reset, &m_numXPar, m_XPar);
 
  //Load the user KoralW input data
  reset = 0;
  pathLength = userDataFile.size();
  kw_readatax_(userDataFile.c_str(), &pathLength, &reset, &m_numXPar, m_XPar);
 
  //Initialize KoralW
  kw_initialize_(&m_cmsEnergy, m_XPar);
 
  //Initialize random number generator
  unsigned int mar1 = gRandom->Integer(m_seed1); //The range for this seed seems to be [0, 900000000]
  unsigned int mar2 = gRandom->Integer(m_seed2);
  unsigned int mar3 = gRandom->Integer(m_seed3);
  marini_(&mar1, &mar2, &mar3);
  rmarin_(&mar1, &mar2, &mar3);
}

◆ setCMSEnergy()

void setCMSEnergy ( double cmsEnergy )

inline

Sets the CMS energy.

Parameters

cmsEnergy The CMS energy in [GeV].

Definition at line 51 of file KoralW.h.

51{ m_cmsEnergy = cmsEnergy; }

◆ storeParticle()

void storeParticle	(	MCParticleGraph &	mcGraph,
		const float *	mom,
		const float *	vtx,
		int	pdg,
		ROOT::Math::XYZVector	vertex,
		ROOT::Math::LorentzRotation	boost,
		bool	isVirtual = `false`,
		bool	isInitial = `false`
	)

protected

Store a single generated particle into the MonteCarlo graph.

Parameters

mcGraph	Reference to the MonteCarlo graph into which the particle should be stored.
mom	The 3-momentum of the particle in [GeV].
vtx	The vertex of the particle in [mm].
pdg	The PDG code of the particle.
vertex	The vertex of the particle in [mm].
boost	Lorentz boost vector.
isVirtual	If the particle is a virtual particle, such as the incoming particles, set this to true.
isInitial	If the particle is a initial particle for ISR, set this to true.

Definition at line 134 of file KoralW.cc.

{
  // //Create particle
  //MCParticleGraph::GraphParticle& part = mcGraph.addParticle();
  //if (!isVirtual) {
  //  part.setStatus(MCParticle::c_PrimaryParticle);
  //} else {
  //  part.setStatus(MCParticle::c_IsVirtual);
  //}
 
  //  RG 6/25/14 Add new flag for ISR "c_Initial"
  MCParticleGraph::GraphParticle& part = mcGraph.addParticle();
  if (isVirtual) {
    part.setStatus(MCParticle::c_IsVirtual);
  } else if (isInitial) {
    part.setStatus(MCParticle::c_Initial);
  }
 
  //every particle from a generator is primary, TF
  part.addStatus(MCParticle::c_PrimaryParticle);
  part.setPDG(pdg);
  part.setFirstDaughter(0);
  part.setLastDaughter(0);
  part.setMomentum(ROOT::Math::XYZVector(mom[0], mom[1], mom[2]));
  part.setEnergy(mom[3]);
  part.setMass(mom[4]);
  part.setProductionVertex(vtx[0]*Unit::mm, vtx[1]*Unit::mm, vtx[2]*Unit::mm);
 
  //boost, TF
  ROOT::Math::PxPyPzEVector p4 = part.get4Vector();
  p4 = boost * p4;
  part.set4Vector(p4);
 
  //set vertex, TF
  if (!isInitial) {
    ROOT::Math::XYZVector v3 = part.getProductionVertex();
    v3 = v3 + vertex;
    part.setProductionVertex(v3);
    part.setValidVertex(true);
  }
}

◆ term()

void term ( )

Terminates the generator.

Closes the internal Fortran generator and retrieves the total cross section.

Definition at line 122 of file KoralW.cc.

{
  kw_finalize_();
 
  //Get the cross section
  kw_getxsecmc_(&m_crossSection, &m_crossSectionError);
}

Member Data Documentation

◆ m_cmsEnergy

double m_cmsEnergy

protected

CMS Energy = 2*Ebeam [GeV].

Definition at line 89 of file KoralW.h.

◆ m_crossSection

double m_crossSection

protected

The cross section of the generated KoralW events.

Definition at line 85 of file KoralW.h.

◆ m_crossSectionError

double m_crossSectionError

protected

The error on the cross section of the generated KoralW events.

Definition at line 87 of file KoralW.h.

◆ m_numXPar

constexpr int m_numXPar = 10000

staticconstexprprivate

Number of parameters for KoralW.

Definition at line 107 of file KoralW.h.

◆ m_seed1

unsigned int m_seed1

private

First seed for the random number generator.

Definition at line 111 of file KoralW.h.

◆ m_seed2

unsigned int m_seed2

private

Second seed for the random number generator.

Definition at line 113 of file KoralW.h.

◆ m_seed3

unsigned int m_seed3

private

Third seed for the random number generator.

Definition at line 115 of file KoralW.h.

◆ m_XPar

double m_XPar[m_numXPar]

private

Values of parameters for KoralW.

Definition at line 109 of file KoralW.h.

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

generators/koralw/include/KoralW.h
generators/koralw/src/KoralW.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KoralW()

◆ ~KoralW()

Member Function Documentation

◆ generateEvent()

◆ getCrossSection()

◆ getCrossSectionError()

◆ init()

◆ setCMSEnergy()

◆ storeParticle()

◆ term()

Member Data Documentation

◆ m_cmsEnergy

◆ m_crossSection

◆ m_crossSectionError

◆ m_numXPar

◆ m_seed1

◆ m_seed2

◆ m_seed3

◆ m_XPar