Migrate Code to New Random Service Interface

Migrate FastSimulation code to use the new interface
of the random number generator service designed to work
with the multithreaded Framework. The main interface
change is to require a StreamID or LuminosityBlockIndex
argument to the getEngine function. These objects are only
available during the event or beginLuminosityBlock method.

Author: wddgit

FastSimulation/MaterialEffects/interface/NuclearInteractionSimulator.h

@@ -97,6 +97,8 @@ class NuclearInteractionSimulator : public MaterialEffectsSimulator
   std::ofstream myOutputFile;
   unsigned myOutputBuffer;
 
+  bool currentValuesWereSet;
+
   //  DaqMonitorBEInterface * dbe;
   //  MonitorElement* hAfter;
   //  MonitorElement* hAfter2;

FastSimulation/MaterialEffects/src/NuclearInteractionSimulator.cc

@@ -42,12 +42,9 @@ NuclearInteractionSimulator::NuclearInteractionSimulator(
   theRatios(ratios),
   theIDMap(idMap),
   theDistAlgo(distAlgo),
-  theDistCut(distCut)
-
+  theDistCut(distCut),
+  currentValuesWereSet(false)
 {
-
-  gROOT->cd();
-
   std::string fullPath;
 
   // Prepare the map of files
@@ -86,8 +83,8 @@ NuclearInteractionSimulator::NuclearInteractionSimulator(
   } 
 
   // Read the information from a previous run (to keep reproducibility)
-  bool input = this->read(inputFile);
-  if ( input ) 
+  currentValuesWereSet = this->read(inputFile);
+  if ( currentValuesWereSet )
     std::cout << "***WARNING*** You are reading nuclear-interaction information from the file "
 	      << inputFile << " created in an earlier run."
 	      << std::endl;
@@ -132,33 +129,12 @@ NuclearInteractionSimulator::NuclearInteractionSimulator(
       //
       theNumberOfEntries[iname][iene] = theTrees[iname][iene]->GetEntries();
 
-      // Add some randomness (if there was no input file)
-      if ( !input ) {
-        // RANDOM_NUMBER_ERROR
-        // Random numbers should only be generated in the beginLuminosityBlock method
-        // or event methods of a module
-        RandomEngineAndDistribution random;
-	theCurrentEntry[iname][iene] = (unsigned) (theNumberOfEntries[iname][iene] * random.flatShoot());
+      if(currentValuesWereSet) {
+        theTrees[iname][iene]->GetEntry(theCurrentEntry[iname][iene]);
+        unsigned NInteractions = theNUEvents[iname][iene]->nInteractions();
+        theNumberOfInteractions[iname][iene] = NInteractions;
       }
-      theTrees[iname][iene]->GetEntry(theCurrentEntry[iname][iene]);
-      unsigned NInteractions = theNUEvents[iname][iene]->nInteractions();
-      theNumberOfInteractions[iname][iene] = NInteractions;
-      // Add some randomness (if there was no input file)
-      if ( !input ) {
-        // RANDOM_NUMBER_ERROR
-        // Random numbers should only be generated in the beginLuminosityBlock method
-        // or event methods of a module
-        RandomEngineAndDistribution random;
-	theCurrentInteraction[iname][iene] = (unsigned) (theNumberOfInteractions[iname][iene] * random.flatShoot());
-      }
-      /*
-      std::cout << "File " << theFileNames[iname][iene]
-		<< " is opened with " << theNumberOfEntries[iname][iene] 
-		<< " entries and will be read from Entry/Interaction "
-		<< theCurrentEntry[iname][iene] << "/" << theCurrentInteraction[iname][iene] 
-		<< std::endl;
-      */
-      
+
       //
       // Compute the corresponding cm energies of the nuclear interactions
       XYZTLorentzVector Proton(0.,0.,0.,0.986);
@@ -178,7 +154,6 @@ NuclearInteractionSimulator::NuclearInteractionSimulator(
   ien4 = 0;
   while ( thePionEN[ien4] < 4.0 ) ++ien4;
 
-  // Return Loot in the same state as it was when entering. 
   gROOT->cd();
 
   // Information (Should be on LogInfo)
@@ -212,15 +187,26 @@ NuclearInteractionSimulator::~NuclearInteractionSimulator() {
   // Close the output file
   myOutputFile.close();
 
-  // And return Loot in the same state as it was when entering. 
-  gROOT->cd();
-
   //  dbe->save("test.root");
 
 }
 
 void NuclearInteractionSimulator::compute(ParticlePropagator& Particle, RandomEngineAndDistribution const* random)
 {
+  if(!currentValuesWereSet) {
+    currentValuesWereSet = true;
+    for ( unsigned iname=0; iname<thePionNA.size(); ++iname ) {
+      for ( unsigned iene=0; iene<thePionEN.size(); ++iene ) {
+        theCurrentEntry[iname][iene] = (unsigned) (theNumberOfEntries[iname][iene] * random->flatShoot());
+
+        theTrees[iname][iene]->GetEntry(theCurrentEntry[iname][iene]);
+        unsigned NInteractions = theNUEvents[iname][iene]->nInteractions();
+        theNumberOfInteractions[iname][iene] = NInteractions;
+
+        theCurrentInteraction[iname][iene] = (unsigned) (theNumberOfInteractions[iname][iene] * random->flatShoot());
+      }
+    }
+  }
 
   // Read a Nuclear Interaction in a random manner
 
@@ -511,6 +497,10 @@ void NuclearInteractionSimulator::compute(ParticlePropagator& Particle, RandomEn
 	  }
 	  */
 
+         // ERROR The way this loops through the events breaks
+         // replay. Which events are retrieved depends on
+         // which previous events were processed.
+
 	  // Increment for next time
 	  ++aCurrentInteraction[ene];
 

FastSimulation/PileUpProducer/plugins/PileUpProducer.cc

@@ -1,6 +1,8 @@
 #include "FWCore/Framework/interface/Event.h"
+#include "FWCore/Framework/interface/LuminosityBlock.h"
 #include "FWCore/Framework/interface/MakerMacros.h"
 #include "FWCore/ServiceRegistry/interface/Service.h"
+#include "FWCore/Utilities/interface/Exception.h"
 #include "FWCore/Utilities/interface/RandomNumberGenerator.h"
 
 #include "SimDataFormats/GeneratorProducts/interface/HepMCProduct.h"
@@ -24,7 +26,7 @@
 #include <sys/stat.h>
 #include <cmath>
 
-PileUpProducer::PileUpProducer(edm::ParameterSet const & p) : hprob(0)
+PileUpProducer::PileUpProducer(edm::ParameterSet const & p) : hprob(0), currentValuesWereSet(false)
 {    
 
   // This producer produces an object PileupMixingContent, needed by PileupSummaryInfo
@@ -138,14 +140,11 @@ PileUpProducer::~PileUpProducer() {
 
 void PileUpProducer::beginRun(edm::Run const&, edm::EventSetup const&)
 {
-  
-  gROOT->cd();
-  
   std::string fullPath;
 
   // Read the information from a previous run (to keep reproducibility)
-  bool input = this->read(inputFile);
-  if ( input ) 
+  currentValuesWereSet = this->read(inputFile);
+  if ( currentValuesWereSet )
     std::cout << "***WARNING*** You are reading pile-up information from the file "
 	      << inputFile << " created in an earlier run."
 	      << std::endl;
@@ -181,37 +180,36 @@ void PileUpProducer::beginRun(edm::Run const&, edm::EventSetup const&)
     theBranches[file]->SetAddress(&thePUEvents[file]);
     //
     theNumberOfEntries[file] = theTrees[file]->GetEntries();
-    // RANDOM_NUMBER_ERROR
-    // Random numbers should only be generated in the beginLuminosityBlock method
-    // or event methods of a module
-    RandomEngineAndDistribution random;
-    // Add some randomness (if there was no input file)
-    if ( !input ) 
-      theCurrentEntry[file] 
-	= (unsigned) (theNumberOfEntries[file] * random.flatShoot());
-
-    theTrees[file]->GetEntry(theCurrentEntry[file]);
-    unsigned NMinBias = thePUEvents[file]->nMinBias();
-    theNumberOfMinBiasEvts[file] = NMinBias;
-    // Add some randomness (if there was no input file)
-    if ( !input )
-	theCurrentMinBiasEvt[file] = 
-	  (unsigned) (theNumberOfMinBiasEvts[file] * random.flatShoot());
-    
-    /*
-    std::cout << "File " << theFileNames[file]
-	      << " is opened with " << theNumberOfEntries[file] 
-	      << " entries and will be read from Entry/Event "
-	      << theCurrentEntry[file] << "/" << theCurrentMinBiasEvt[file]
-	      << std::endl;
-    */
+
+    if ( currentValuesWereSet ) {
+      theTrees[file]->GetEntry(theCurrentEntry[file]);
+      unsigned NMinBias = thePUEvents[file]->nMinBias();
+      theNumberOfMinBiasEvts[file] = NMinBias;
+    }
   }
-  
-  // Return Loot in the same state as it was when entering. 
   gROOT->cd();
-  
 }
- 
+
+void PileUpProducer::beginLuminosityBlock(edm::LuminosityBlock const& lumi, edm::EventSetup const&) {
+  if ( !currentValuesWereSet ) {
+    currentValuesWereSet = true;
+
+    RandomEngineAndDistribution random(lumi.index());
+
+    for ( unsigned file=0; file < theNumberOfFiles; ++file ) {
+      theCurrentEntry[file] =
+        (unsigned) (theNumberOfEntries[file] * random.flatShoot());
+
+      theTrees[file]->GetEntry(theCurrentEntry[file]);
+      unsigned NMinBias = thePUEvents[file]->nMinBias();
+      theNumberOfMinBiasEvts[file] = NMinBias;
+
+      theCurrentMinBiasEvt[file] =
+        (unsigned) (theNumberOfMinBiasEvts[file] * random.flatShoot());
+    }
+  }
+}
+
 void PileUpProducer::endRun(edm::Run const&, edm::EventSetup const&)
 { 
   // Close all local files
@@ -226,10 +224,6 @@ void PileUpProducer::endRun(edm::Run const&, edm::EventSetup const&)
 
   // Close the output file
   myOutputFile.close();
-  
-  // And return Loot in the same state as it was when entering. 
-  gROOT->cd();
-  
 }
 
 void PileUpProducer::produce(edm::Event & iEvent, const edm::EventSetup & es)
@@ -383,7 +377,11 @@ void PileUpProducer::produce(edm::Event & iEvent, const edm::EventSetup & es)
 
     }
     // End of particle loop
-    
+
+    // ERROR The way this loops through the pileup events breaks
+    // replay. Which events are retrieved for pileup depends on
+    // which previous events were processed.
+
     // Increment for next time
     ++theCurrentMinBiasEvt[file];
 

FastSimulation/PileUpProducer/plugins/PileUpProducer.h

@@ -9,9 +9,13 @@
 #include <fstream>
 #include "TH1F.h"
 
-class ParameterSet;
-class Event;
-class EventSetup;
+namespace edm {
+  class Event;
+  class EventSetup;
+  class LuminosityBlock;
+  class ParameterSet;
+  class Run;
+}
 
 class TFile;
 class TTree;
@@ -28,6 +32,7 @@ class PileUpProducer : public edm::EDProducer
   explicit PileUpProducer(edm::ParameterSet const & p);
   virtual ~PileUpProducer();
   virtual void beginRun(edm::Run const&, edm::EventSetup const&) override;
+  virtual void beginLuminosityBlock(edm::LuminosityBlock const&, edm::EventSetup const&) override;
   virtual void endRun(edm::Run const&, edm::EventSetup const&) override;
   virtual void produce(edm::Event & e, const edm::EventSetup & c) override;
 
@@ -66,6 +71,8 @@ class PileUpProducer : public edm::EDProducer
   std::vector<double> dataProb;
   int varSize;
   int probSize;
+
+  bool currentValuesWereSet;
 };
 
 #endif

FastSimulation/Utilities/interface/RandomEngineAndDistribution.h

@@ -22,12 +22,6 @@ class RandomEngineAndDistribution {
   RandomEngineAndDistribution(edm::StreamID const&);
   RandomEngineAndDistribution(edm::LuminosityBlockIndex const&);
 
-  // This is strongly deprecated, it exists for backward compatibility
-  // for cases where the above two functions cannot be used easily.
-  // It is the intent fix all those cases and delete this function
-  // as soon as possible.
-  RandomEngineAndDistribution();
-
   ~RandomEngineAndDistribution();
 
   CLHEP::HepRandomEngine& theEngine() const { return *engine_; }

FastSimulation/Utilities/src/RandomEngineAndDistribution.cc

@@ -41,22 +41,5 @@ RandomEngineAndDistribution::RandomEngineAndDistribution(edm::LuminosityBlockInd
     rootEngine_ = ( (edm::TRandomAdaptor*) engine_ )->getRootEngine();
 }
 
-RandomEngineAndDistribution::RandomEngineAndDistribution() :
-  engine_(nullptr),
-  rootEngine_(nullptr) {
-  edm::Service<edm::RandomNumberGenerator> rng;
-  if ( ! rng.isAvailable() ) {
-    throw cms::Exception("Configuration") <<
-      "RandomNumberGenerator service is not available.\n"
-      "You must add the service in the configuration file\n"
-      "or remove the module that requires it.";
-  }
-  engine_ = &rng->getEngine();
-
-  // Get the TRandom3 egine, to benefit from Root functional random generation
-  if ( engine_->name() == "TRandom3" )
-    rootEngine_ = ( (edm::TRandomAdaptor*) engine_ )->getRootEngine();
-}
-
 RandomEngineAndDistribution::~RandomEngineAndDistribution() {
 }