genie::RandomGen Class Reference

A singleton holding random number generator classes. All random number generation in GENIE should take place through this class. Ensures that the random number generator seed is set consistently to all GENIE modules and that all modules use the preferred rndm number generator. More...

#include <RandomGen.h>

Classes
struct	Cleaner

Public Member Functions
TRandom3 &	RndKine (void) const
	rnd number generator used by kinematics generators More...
TRandom3 &	RndHadro (void) const
	rnd number generator used by hadronization models More...
TRandom3 &	RndDec (void) const
	rnd number generator used by decay models More...
TRandom3 &	RndFsi (void) const
	rnd number generator used by intranuclear cascade monte carlos More...
TRandom3 &	RndLep (void) const
	rnd number generator used by final state primary lepton generators More...
TRandom3 &	RndISel (void) const
	rnd number generator used by interaction selectors More...
TRandom3 &	RndGeom (void) const
	rnd number generator used by geometry drivers More...
TRandom3 &	RndFlux (void) const
	rnd number generator used by flux drivers More...
TRandom3 &	RndEvg (void) const
	rnd number generator used by the event generation drivers More...
TRandom3 &	RndNum (void) const
	rnd number generator used by MC integrators & other numerical methods More...
TRandom3 &	RndGen (void) const
	rnd number generator for generic usage More...
long int	GetSeed (void) const
void	SetSeed (long int seed)

Static Public Member Functions
static RandomGen *	Instance ()
	Access instance. More...

Private Member Functions
	RandomGen ()
	RandomGen (const RandomGen &rgen)
virtual	~RandomGen ()
void	InitRandomGenerators (long int seed)

Private Attributes
TRandom3 *	fRandom3
	Mersenne Twistor. More...
long int	fCurrSeed
	random number generator seed number More...
bool	fInitalized
	done initializing singleton? More...

Static Private Attributes
static RandomGen *	fInstance = 0

Friends
struct	Cleaner

Detailed Description

A singleton holding random number generator classes. All random number generation in GENIE should take place through this class. Ensures that the random number generator seed is set consistently to all GENIE modules and that all modules use the preferred rndm number generator.

Author

Costas Andreopoulos <constantinos.andreopoulos cern.ch> University of Liverpool & STFC Rutherford Appleton Laboratory

September 22, 2004

Copyright (c) 2003-2020, The GENIE Collaboration For the full text of the license visit http://copyright.genie-mc.org

Definition at line 29 of file RandomGen.h.

Constructor & Destructor Documentation

genie::RandomGen::RandomGen ( )

private

Definition at line 27 of file RandomGen.cxx.

{
  LOG("Rndm", pINFO) << "RandomGen late initialization";

  fInitalized = false;
  fInstance = 0;
/*
  // try to get this job's random number seed from the environment
  const char * seed = gSystem->Getenv("GSEED");
  if(seed) {
    LOG("Rndm", pDEBUG) << "Reading RandomNumGenerator seed env. var $GSEED";
    fCurrSeed = atoi(seed);
  } else {
    LOG("Rndm", pINFO) << "Env. var. $GSEED is not set. Using default seed";
    fCurrSeed = kDefaultRandSeed; // default seed number
  }
  this->InitRandomGenerators(fCurrSeed);
*/

  if ( gSystem->Getenv("GSEED") ) {
    LOG("Rndm", pFATAL)
      << "\n\n"
      << "************************************************************************************** \n"
      << "The random number seed is no longer set via the $GSEED variable.\n"
      << "Please use the --seed option implemented in all GENIE apps or, if you access RandomGen \n"
      << "directly in your user code, use RandomGen::SetSeed(long int seed).\n"
      << "Unset $GSEED to continue running GENIE. \n"
      << "************************************************************************************** \n";
    gAbortingInErr = true;
    exit(1);
  }

  fCurrSeed = kDefaultRandSeed; // a default seed number is set a init
  this->InitRandomGenerators(fCurrSeed);

  fInitalized = true;
}

genie::RandomGen::RandomGen ( const RandomGen &  rgen )

private

genie::RandomGen::~RandomGen ( )

privatevirtual

Definition at line 65 of file RandomGen.cxx.

{
  fInstance = 0;
  if(fRandom3) delete fRandom3;
}

Member Function Documentation

long int genie::RandomGen::GetSeed ( void  ) const

inline

Definition at line 82 of file RandomGen.h.

{ return fCurrSeed; }

void genie::RandomGen::InitRandomGenerators ( long int  seed )

private

Definition at line 126 of file RandomGen.cxx.

{
  fRandom3 = new TRandom3();
  this->SetSeed(seed);
}

RandomGen * genie::RandomGen::Instance ( void  )

static

Access instance.

Definition at line 71 of file RandomGen.cxx.

{
  if(fInstance == 0) {
    static RandomGen::Cleaner cleaner;
    cleaner.DummyMethodAndSilentCompiler();

    fInstance = new RandomGen;
  }
  return fInstance;
}

TRandom3& genie::RandomGen::RndDec ( void  ) const

inline

rnd number generator used by decay models

Definition at line 56 of file RandomGen.h.

{ return *fRandom3; }

TRandom3& genie::RandomGen::RndEvg ( void  ) const

inline

rnd number generator used by the event generation drivers

Definition at line 74 of file RandomGen.h.

{ return *fRandom3; }

TRandom3& genie::RandomGen::RndFlux ( void  ) const

inline

rnd number generator used by flux drivers

Definition at line 71 of file RandomGen.h.

{ return *fRandom3; }

TRandom3& genie::RandomGen::RndFsi ( void  ) const

inline

rnd number generator used by intranuclear cascade monte carlos

Definition at line 59 of file RandomGen.h.

{ return *fRandom3; }

TRandom3& genie::RandomGen::RndGen ( void  ) const

inline

rnd number generator for generic usage

Definition at line 80 of file RandomGen.h.

{ return *fRandom3; }

TRandom3& genie::RandomGen::RndGeom ( void  ) const

inline

rnd number generator used by geometry drivers

Definition at line 68 of file RandomGen.h.

{ return *fRandom3; }

TRandom3& genie::RandomGen::RndHadro ( void  ) const

inline

rnd number generator used by hadronization models

Definition at line 53 of file RandomGen.h.

{ return *fRandom3; }

TRandom3& genie::RandomGen::RndISel ( void  ) const

inline

rnd number generator used by interaction selectors

Definition at line 65 of file RandomGen.h.

{ return *fRandom3; }

TRandom3& genie::RandomGen::RndKine ( void  ) const

inline

rnd number generator used by kinematics generators

Random number generators used by various GENIE modules. (See note at http://root.cern.ch/root/html//TRandom.html on using several TRandom objects each with each own "independent" run sequence). At this point, since the actual random number generator periodicity is very high, all the generators are in fact one! However, the option to use many generators is reserved. Currently, the preferred generator is the "Mersenne Twister" with a periodicity of 10**6000 See: http://root.cern.ch/root/html/TRandom3.html

Definition at line 50 of file RandomGen.h.

{ return *fRandom3; }

TRandom3& genie::RandomGen::RndLep ( void  ) const

inline

rnd number generator used by final state primary lepton generators

Definition at line 62 of file RandomGen.h.

{ return *fRandom3; }

TRandom3& genie::RandomGen::RndNum ( void  ) const

inline

rnd number generator used by MC integrators & other numerical methods

Definition at line 77 of file RandomGen.h.

{ return *fRandom3; }

void genie::RandomGen::SetSeed

(

long int

seed

)

Definition at line 82 of file RandomGen.cxx.

{
  LOG("Rndm", pNOTICE)
     << "Setting"
     << ((fInitalized) ? " " : " default ")
     << "random number seed"
     << ((fInitalized) ? ": " : " at random number generator initialization: ")
     << seed;

  // Set the seed number for all internal GENIE random number generators
  this->RndKine ().SetSeed(seed);
  this->RndHadro().SetSeed(seed);
  this->RndDec  ().SetSeed(seed);
  this->RndFsi  ().SetSeed(seed);
  this->RndLep  ().SetSeed(seed);
  this->RndISel ().SetSeed(seed);
  this->RndGeom ().SetSeed(seed);
  this->RndFlux ().SetSeed(seed);
  this->RndEvg  ().SetSeed(seed);
  this->RndNum  ().SetSeed(seed);
  this->RndGen  ().SetSeed(seed);

  // Set the seed number for ROOT's gRandom
  gRandom ->SetSeed (seed);

  // Set the PYTHIA6 seed number
  TPythia6 * pythia6 = TPythia6::Instance();
  pythia6->SetMRPY(1, seed);

  LOG("Rndm", pINFO) << "RndKine  seed = " << this->RndKine ().GetSeed();
  LOG("Rndm", pINFO) << "RndHadro seed = " << this->RndHadro().GetSeed();
  LOG("Rndm", pINFO) << "RndDec   seed = " << this->RndDec  ().GetSeed();
  LOG("Rndm", pINFO) << "RndFsi   seed = " << this->RndFsi  ().GetSeed();
  LOG("Rndm", pINFO) << "RndLep   seed = " << this->RndLep  ().GetSeed();
  LOG("Rndm", pINFO) << "RndISel  seed = " << this->RndISel ().GetSeed();
  LOG("Rndm", pINFO) << "RndGeom  seed = " << this->RndGeom ().GetSeed();
  LOG("Rndm", pINFO) << "RndFlux  seed = " << this->RndFlux ().GetSeed();
  LOG("Rndm", pINFO) << "RndEvg   seed = " << this->RndEvg  ().GetSeed();
  LOG("Rndm", pINFO) << "RndNum   seed = " << this->RndNum  ().GetSeed();
  LOG("Rndm", pINFO) << "RndGen   seed = " << this->RndGen  ().GetSeed();
  LOG("Rndm", pINFO) << "gRandom  seed = " << gRandom->GetSeed();
  LOG("Rndm", pINFO) << "PYTHIA6  seed = " << pythia6->GetMRPY(1);
}

Friends And Related Function Documentation

friend struct Cleaner

friend

Definition at line 109 of file RandomGen.h.

Member Data Documentation

long int genie::RandomGen::fCurrSeed

private

random number generator seed number

Definition at line 94 of file RandomGen.h.

bool genie::RandomGen::fInitalized

private

done initializing singleton?

Definition at line 95 of file RandomGen.h.

RandomGen * genie::RandomGen::fInstance = 0

staticprivate

Definition at line 91 of file RandomGen.h.

TRandom3* genie::RandomGen::fRandom3

private

Mersenne Twistor.

Definition at line 93 of file RandomGen.h.

---

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

• Generator/src/Framework/Numerical/RandomGen.h
• Generator/src/Framework/Numerical/RandomGen.cxx