G4INCLRandom.cc

Go to the documentation of this file.

//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
// INCL++ intra-nuclear cascade model
// Alain Boudard, CEA-Saclay, France
// Joseph Cugnon, University of Liege, Belgium
// Jean-Christophe David, CEA-Saclay, France
// Pekka Kaitaniemi, CEA-Saclay, France, and Helsinki Institute of Physics, Finland
// Sylvie Leray, CEA-Saclay, France
// Davide Mancusi, CEA-Saclay, France
//
#define INCLXX_IN_GEANT4_MODE 1
 
#include "globals.hh"
 
/*
 * G4INCLRandom.cc
 *
 *  \date 7 June 2009
 * \author Pekka Kaitaniemi
 */
 
#include "G4INCLRandom.hh"
#include "G4INCLGlobals.hh"
// #include <cassert>
 
#include "G4INCLRanecu.hh"
#include "G4INCLRanecu3.hh"
#include "G4INCLGeant4Random.hh"
#include "G4INCLLogger.hh"
 
namespace G4INCL {
 
  namespace Random {
 
    namespace {
 
      G4ThreadLocal IRandomGenerator* theGenerator = NULL;
 
#ifdef INCL_COUNT_RND_CALLS
      G4ThreadLocal unsigned long long nCalls;
#endif
 
      G4ThreadLocal SeedVector *savedSeeds = NULL;
 
      G4ThreadLocal Adapter *theAdapter = NULL;
 
    }
 
    void setGenerator(G4INCL::IRandomGenerator *aGenerator) {
      if(isInitialized()) {
        INCL_ERROR("INCL random number generator already initialized." << '\n');
      } else {
#ifdef INCL_COUNT_RND_CALLS
        nCalls = 0;
#endif
        theGenerator = aGenerator;
      }
      if(!theAdapter)
        theAdapter = new Adapter();
    }
 
    void setSeeds(const SeedVector &sv) {
      theGenerator->setSeeds(sv);
    }
 
    SeedVector getSeeds() {
      return theGenerator->getSeeds();
    }
 
    G4double shoot() {
#ifdef INCL_COUNT_RND_CALLS
      nCalls++;
#endif
      return theGenerator->flat();
    }
 
    G4double shoot0() {
      G4double r;
      while( (r=shoot()) <= 0. ) /* Loop checking, 10.07.2015, D.Mancusi */
        ;
      return r;
    }
 
    G4double shoot1() {
      G4double r;
      while( (r=shoot()) >= 1. ) /* Loop checking, 10.07.2015, D.Mancusi */
        ;
      return r;
    }
 
#ifndef INCLXX_IN_GEANT4_MODE
    G4double gauss(G4double sigma) {
      // generate a Gaussian random number with standard deviation sigma
      // uses the flat() and flat0() methods
/*      static G4ThreadLocal G4bool generated = false;
      static G4ThreadLocal G4double u, v;
 
      if( !generated )
      {
        u = shoot0();
        v = Math::twoPi*shoot();
        generated = true;
        return sigma*std::sqrt(-2*std::log(u))*std::cos(v);
      }
      else
      {
        generated = false;
        return sigma*std::sqrt(-2*std::log(u))*std::sin(v);
      }*/
      
      return sigma*std::sqrt(-2*std::log(shoot0()))*std::cos(Math::twoPi*shoot());
    }
#else
      G4double gauss(G4double sigma) {
          return G4RandGauss::shoot(0.,sigma);
      }
      
      G4double gaussWithMemory(G4double sigma) {
          // generate a Gaussian random number with standard deviation sigma
          // uses the flat() and flat0() methods
          static G4ThreadLocal G4bool generated = false;
          static G4ThreadLocal G4double u, v;
          
          if( !generated )
          {
              u = shoot0();
              v = Math::twoPi*shoot();
              generated = true;
              return sigma*std::sqrt(-2*std::log(u))*std::cos(v);
          }
          else
          {
              generated = false;
              return sigma*std::sqrt(-2*std::log(u))*std::sin(v);
          }
      }
 
#endif
    ThreeVector normVector(G4double norm) {
 
      const G4double ctheta = (1.-2.*shoot());
      const G4double stheta = std::sqrt(1.-ctheta*ctheta);
      const G4double phi = Math::twoPi*shoot();
      return ThreeVector(
                         norm * stheta * std::cos(phi),
                         norm * stheta * std::sin(phi),
                         norm * ctheta);
 
    }
 
    ThreeVector sphereVector(G4double rmax) {
      return normVector( rmax*Math::pow13(shoot0()) );
    }
 
    ThreeVector gaussVector(G4double sigma) {
      const G4double sigmax = sigma * Math::oneOverSqrtThree;
      return ThreeVector(gauss(sigmax), gauss(sigmax), gauss(sigmax));
    }
 
    std::pair<G4double,G4double> correlatedGaussian(const G4double corrCoeff, const G4double x0, const G4double sigma) {
// assert(corrCoeff<=1. && corrCoeff>=-1.);
      G4double factor = 1.-corrCoeff*corrCoeff;
      if(factor<=0.)
        factor=0.;
#ifndef INCLXX_IN_GEANT4_MODE
      const G4double x = gauss(sigma) + x0;
      const G4double y = corrCoeff * x + gauss(sigma*std::sqrt(factor)) + x0;
#else
       const G4double x = gaussWithMemory(sigma) + x0;
       const G4double y = corrCoeff * x + gaussWithMemory(sigma*std::sqrt(factor)) + x0;
        
#endif
       return std::make_pair(x, y);
    }
 
    std::pair<G4double,G4double> correlatedUniform(const G4double corrCoeff) {
      std::pair<G4double,G4double> gaussians = correlatedGaussian(corrCoeff);
      return std::make_pair(Math::gaussianCDF(gaussians.first), Math::gaussianCDF(gaussians.second));
    }
 
    void deleteGenerator() {
      delete theGenerator;
      theGenerator = NULL;
      delete savedSeeds;
      savedSeeds = NULL;
      delete theAdapter;
      theAdapter = NULL;
    }
 
    G4bool isInitialized() {
      if(theGenerator == 0) return false;
      return true;
    }
 
#ifdef INCL_COUNT_RND_CALLS
    /// \brief Return the number of calls to the RNG
    unsigned long long getNumberOfCalls() {
      return nCalls;
    }
#endif
 
    void saveSeeds() {
      if(!savedSeeds)
        savedSeeds = new SeedVector;
 
      (*savedSeeds) = theGenerator->getSeeds();
    }
 
    SeedVector getSavedSeeds() {
      if(!savedSeeds)
        savedSeeds = new SeedVector;
 
      return *savedSeeds;
    }
 
    void initialize(Config const * const
#ifndef INCLXX_IN_GEANT4_MODE
                    theConfig
#endif
                    ) {
#ifdef INCLXX_IN_GEANT4_MODE
      Random::setGenerator(new Geant4RandomGenerator());
#else // INCLXX_IN_GEANT4_MODE
      RNGType rng = theConfig->getRNGType();
      if(rng == RanecuType)
        setGenerator(new Ranecu(theConfig->getRandomSeeds()));
      else if(rng == Ranecu3Type)
        setGenerator(new Ranecu3(theConfig->getRandomSeeds()));
      else
        setGenerator(NULL);
#endif // INCLXX_IN_GEANT4_MODE
    }
 
    Adapter const &getAdapter() {
      return *theAdapter;
    }
 
  }
 
}