gen::P8RndmEngine Class Reference

#include <P8RndmEngine.h>

Inheritance diagram for gen::P8RndmEngine:

Public Member Functions
double	flat () override
	P8RndmEngine ()
void	setRandomEngine (CLHEP::HepRandomEngine *v)

Private Member Functions
void	throwNullPtr () const

Private Attributes
CLHEP::HepRandomEngine *	randomEngine_

Detailed Description

Description: Used to set an external random number engine in Pythia 8. Pythia 8 recognizes a class that has Pythia8::RndmEngine as a base class and a virtual flat method. If you pass a pointer to an object of this class to Pythia 8 it will use it to generate random numbers.

Independent of Pythia 8, one can set the CLHEP engine that this class uses in its flat method.

Author

W. David Dagenhart, created 26 November 2013

Definition at line 27 of file P8RndmEngine.h.

Constructor & Destructor Documentation

P8RndmEngine()

gen::P8RndmEngine::P8RndmEngine ( )

inline

Definition at line 29 of file P8RndmEngine.h.

: randomEngine_(nullptr) {}

Member Function Documentation

flat()

double gen::P8RndmEngine::flat ( void  )

override

Definition at line 7 of file P8RndmEngine.cc.

References randomEngine_, and throwNullPtr().

Referenced by gen::Py8PtAndDxyGun::generatePartonsAndHadronize(), gen::Py8PtotGun::generatePartonsAndHadronize(), gen::Py8PtGun::generatePartonsAndHadronize(), gen::Py8PtAndLxyGun::generatePartonsAndHadronize(), gen::Py8JetGun::generatePartonsAndHadronize(), gen::Py8MassGun::generatePartonsAndHadronize(), and gen::Py8EGun::generatePartonsAndHadronize().

                                {
    if (randomEngine_ == nullptr) {
      throwNullPtr();
    }
    return randomEngine_->flat();
  }

setRandomEngine()

void gen::P8RndmEngine::setRandomEngine ( CLHEP::HepRandomEngine *  v )

inline

Definition at line 34 of file P8RndmEngine.h.

References randomEngine_, and gen::v.

Referenced by gen::Py8HMC3InterfaceBase::p8SetRandomEngine(), and gen::Py8InterfaceBase::p8SetRandomEngine().

{ randomEngine_ = v; }

throwNullPtr()

void gen::P8RndmEngine::throwNullPtr ( ) const

private

Definition at line 14 of file P8RndmEngine.cc.

References Exception, and edm::errors::LogicError.

Referenced by flat().

                                        {
    throw edm::Exception(edm::errors::LogicError) << "The Pythia 8 code attempted to a generate random number while\n"
                                                  << "the engine pointer was null. This might mean that the code\n"
                                                  << "was modified to generate a random number outside the event and\n"
                                                  << "beginLuminosityBlock methods, which is not allowed.\n";
  }

Member Data Documentation

randomEngine_

CLHEP::HepRandomEngine* gen::P8RndmEngine::randomEngine_

private

Definition at line 39 of file P8RndmEngine.h.

Referenced by flat(), and setRandomEngine().