G4ParticleInelasticXS.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.          *
// ********************************************************************
//
// -------------------------------------------------------------------
//
// GEANT4 Class file
//
//
// File name:    G4ParticleInelasticXS
//
// Author  Ivantchenko, Geant4, 3-Aug-09
//
// Modifications:
//
 
#include "G4ParticleInelasticXS.hh"
#include "G4Neutron.hh"
#include "G4DynamicParticle.hh"
#include "G4ElementTable.hh"
#include "G4Material.hh"
#include "G4Element.hh"
#include "G4PhysicsLogVector.hh"
#include "G4CrossSectionDataSetRegistry.hh"
#include "G4ComponentGGHadronNucleusXsc.hh"
#include "G4ComponentGGNuclNuclXsc.hh"
#include "G4HadronicParameters.hh"
#include "G4Proton.hh"
#include "Randomize.hh"
#include "G4SystemOfUnits.hh"
#include "G4IsotopeList.hh"
#include "G4HadronicParameters.hh"
#include "G4AutoLock.hh"
 
#include <fstream>
#include <sstream>
#include <thread>
 
G4ElementData* G4ParticleInelasticXS::data[] = {nullptr, nullptr, nullptr, nullptr, nullptr};
G4double G4ParticleInelasticXS::coeff[MAXZINELP][5] = {{1.0}, {1.0}, {1.0}, {1.0}, {1.0}};
G4String G4ParticleInelasticXS::gDataDirectory[] = {"", "", "", "", ""};
 
static std::once_flag applyOnce;
 
namespace
{
  G4Mutex pInelasticXSMutex = G4MUTEX_INITIALIZER;
  G4String pname[5] = {"proton", "deuteron", "triton", "He3", "alpha"};
}
 
G4ParticleInelasticXS::G4ParticleInelasticXS(const G4ParticleDefinition* part) 
  : G4VCrossSectionDataSet("G4ParticleInelasticXS"),
    particle(part),
    elimit(20*CLHEP::MeV)
{
  if(nullptr == part) {
    G4Exception("G4ParticleInelasticXS::G4ParticleInelasticXS(..)","had015",
        FatalException, "NO particle definition in constructor");
  } else {
    verboseLevel = 0;
    const G4String& particleName = particle->GetParticleName();
    if(verboseLevel > 1) {
      G4cout << "G4ParticleInelasticXS::G4ParticleInelasticXS for " 
         << particleName << " on atoms with Z < " << MAXZINELP << G4endl;
    }
    auto xsr = G4CrossSectionDataSetRegistry::Instance();
    if(particleName == "proton") {
      highEnergyXsection = xsr->GetComponentCrossSection("Glauber-Gribov");
      if(highEnergyXsection == nullptr) {
    highEnergyXsection = new G4ComponentGGHadronNucleusXsc();
      }
    } else {
      highEnergyXsection = 
        xsr->GetComponentCrossSection("Glauber-Gribov Nucl-nucl");
      if(highEnergyXsection == nullptr) {
    highEnergyXsection = new G4ComponentGGNuclNuclXsc();
      }
      for (index=1; index<5; ++index) {
        if (particleName == pname[index]) { break; }
      }
      if (index == 5) {
        G4ExceptionDescription ed;
        ed << particleName << " is a wrong particle type";
    G4Exception("G4ParticleInelasticXS::BuildPhysicsTable(..)","had012",
            FatalException, ed, "");
      }
      if (1 < index) { SetMaxKinEnergy(25.6*CLHEP::PeV); }
    }
  }
  SetForAllAtomsAndEnergies(true);
  if (data[0] == nullptr) {
    for (G4int i=0; i<5; ++i) { 
      data[i] = new G4ElementData(MAXZINELP);
      data[i]->SetName(pname[i] + "IonInel");
    }
    FindDirectoryPath();
  }
}
 
void G4ParticleInelasticXS::CrossSectionDescription(std::ostream& outFile) const
{
  outFile << "G4ParticleInelasticXS calculates n, p, d, t, he3, he4 inelastic\n"
          << "cross section on nuclei using data from the high precision\n"
          << "neutron database.  These data are simplified and smoothed over\n"
          << "the resonance region in order to reduce CPU time.\n"
          << "For high energy Glauber-Gribov cross section model is used.\n";
}
 
G4bool 
G4ParticleInelasticXS::IsElementApplicable(const G4DynamicParticle*, 
                       G4int, const G4Material*)
{
  return true;
}
 
G4bool 
G4ParticleInelasticXS::IsIsoApplicable(const G4DynamicParticle*,
                       G4int, G4int,
                       const G4Element*, const G4Material*)
{
  return true;
}
 
G4double 
G4ParticleInelasticXS::GetElementCrossSection(const G4DynamicParticle* aParticle,
                                              G4int Z, const G4Material*)
{
  return ElementCrossSection(aParticle->GetKineticEnergy(),
                             aParticle->GetLogKineticEnergy(), Z);
}
 
G4double
G4ParticleInelasticXS::ComputeCrossSectionPerElement(G4double ekin, G4double loge,
                                                     const G4ParticleDefinition*,
                                                     const G4Element* elm,
                                                     const G4Material*)
{
  return ElementCrossSection(ekin, loge, elm->GetZasInt());
}
 
G4double G4ParticleInelasticXS::ElementCrossSection(G4double ekin, G4double loge, G4int ZZ)
{
  G4int Z = (ZZ >= MAXZINELP) ? MAXZINELP - 1 : ZZ; 
  auto pv = GetPhysicsVector(Z);
 
  G4double xs = (ekin <= pv->GetMaxEnergy()) ? pv->LogVectorValue(ekin, loge) 
    : coeff[Z][index]*highEnergyXsection->GetInelasticElementCrossSection(particle,
                    ekin, Z, aeff[Z]);
 
#ifdef G4VERBOSE
  if(verboseLevel > 1) {
    G4cout  << "ElmXS: Z= " << Z << " Ekin(MeV)= " << ekin/CLHEP::MeV 
        << " xs(bn)= " << xs/CLHEP::barn << " element data for "
        << particle->GetParticleName()
            << " idx= " << index << G4endl;
  }
#endif
  return xs;
}
 
G4double
G4ParticleInelasticXS::ComputeIsoCrossSection(G4double ekin, G4double loge,
                                              const G4ParticleDefinition*,
                                              G4int Z, G4int A, const G4Isotope*,
                                              const G4Element*, const G4Material*)
{
  return IsoCrossSection(ekin, loge, Z, A); 
}
 
G4double
G4ParticleInelasticXS::GetIsoCrossSection(const G4DynamicParticle* aParticle, 
                                          G4int Z, G4int A, const G4Isotope*,
                                          const G4Element*, const G4Material*)
{
  return IsoCrossSection(aParticle->GetKineticEnergy(), 
                         aParticle->GetLogKineticEnergy(), Z, A); 
}
 
G4double 
G4ParticleInelasticXS::IsoCrossSection(G4double ekin, G4double logE,
                                       G4int ZZ, G4int A)
{
  G4double xs = 0.0;
  G4int Z = (ZZ >= MAXZINELP) ? MAXZINELP - 1 : ZZ; 
  auto pv = GetPhysicsVector(Z);
 
  // compute isotope cross section if applicable 
  if (ekin <= elimit && data[index]->GetNumberOfComponents(Z) > 0) {
    auto pviso = data[index]->GetComponentDataByID(Z, A);
    if(pviso != nullptr) { 
      xs = pviso->LogVectorValue(ekin, logE);
#ifdef G4VERBOSE
      if(verboseLevel > 1) {
    G4cout << "G4ParticleInelasticXS::IsoXS: for " 
               << particle->GetParticleName() << " Ekin(MeV)= " 
               << ekin/CLHEP::MeV << "  xs(b)= " << xs/CLHEP::barn 
           << "  Z= " << Z << "  A= " << A 
               << " idx= " << index << G4endl;
      }
#endif
      return xs;
    }
  }
  // use element x-section
  xs = (ekin <= pv->GetMaxEnergy()) ? pv->LogVectorValue(ekin, logE) 
    : coeff[Z][index] *
      highEnergyXsection->GetInelasticElementCrossSection(particle,
              ekin, Z, aeff[Z]);
  xs *= A/aeff[Z];
#ifdef G4VERBOSE
  if(verboseLevel > 1) {
    G4cout  << "IsoXS for " << particle->GetParticleName() 
        << " Target Z= " << Z << " A= " << A 
        << " Ekin(MeV)= " << ekin/CLHEP::MeV 
        << " xs(bn)= " << xs/CLHEP::barn
            << " idx= " << index << G4endl;
  }
#endif
  return xs;
}
 
const G4Isotope* G4ParticleInelasticXS::SelectIsotope(
         const G4Element* anElement, G4double kinEnergy, G4double logE)
{
  G4int nIso = (G4int)anElement->GetNumberOfIsotopes();
  const G4Isotope* iso = anElement->GetIsotope(0);
 
  if (1 == nIso) { return iso; }
 
  // more than 1 isotope
  G4int Z = anElement->GetZasInt();
  if (nullptr == data[index]->GetElementData(Z)) { InitialiseOnFly(Z); }
 
  const G4double* abundVector = anElement->GetRelativeAbundanceVector();
  G4double q = G4UniformRand();
  G4double sum = 0.0;
  G4int j;
 
  // isotope wise cross section not available
  if (Z >= MAXZINELP || 0 == data[index]->GetNumberOfComponents(Z)) {
    for (j=0; j<nIso; ++j) {
      sum += abundVector[j];
      if(q <= sum) {
    iso = anElement->GetIsotope(j);
    break;
      }
    }
    return iso;
  }
 
  G4int nn = (G4int)temp.size();
  if (nn < nIso) { temp.resize(nIso, 0.); }
 
  for (j=0; j<nIso; ++j) {
    sum += abundVector[j]*IsoCrossSection(kinEnergy, logE, Z, 
                      anElement->GetIsotope(j)->GetN());
    temp[j] = sum;
  }
  sum *= q;
  for (j=0; j<nIso; ++j) {
    if (temp[j] >= sum) {
      iso = anElement->GetIsotope(j);
      break;
    }
  }
  return iso;
}
 
void 
G4ParticleInelasticXS::BuildPhysicsTable(const G4ParticleDefinition& p)
{
  if (verboseLevel > 0){
    G4cout << "G4ParticleInelasticXS::BuildPhysicsTable for " 
       << p.GetParticleName() << G4endl;
  }
  if (&p != particle) { 
    G4ExceptionDescription ed;
    ed << p.GetParticleName() << " is a wrong particle type -"
       << particle->GetParticleName() << " is expected";
    G4Exception("G4ParticleInelasticXS::BuildPhysicsTable(..)","had012",
        FatalException, ed, "");
    return; 
  }
 
  // it is possible re-initialisation for the new run
  const G4ElementTable* table = G4Element::GetElementTable();
 
  // initialise static tables only once
  std::call_once(applyOnce, [this]() { isInitializer = true; });
 
  if (isInitializer) {
    G4AutoLock l(&pInelasticXSMutex);
 
    // Access to elements
    for ( auto const & elm : *table ) {
      G4int Z = std::max( 1, std::min( elm->GetZasInt(), MAXZINELP-1) );
      for (G4int i=0; i<5; ++i) { 
    if ( nullptr == (data[i])->GetElementData(Z) ) { Initialise(Z, i); }
      }
    }
    l.unlock();
  }
  // prepare isotope selection
  std::size_t nIso = temp.size();
  for ( auto const & elm : *table ) {
    std::size_t n = elm->GetNumberOfIsotopes();
    if (n > nIso) { nIso = n; }
  }
  temp.resize(nIso, 0.0);
}
 
void G4ParticleInelasticXS::FindDirectoryPath()
{
  // build the complete string identifying the file with the data set
  if (gDataDirectory[0].empty()) {
    for (G4int i=0; i<5; ++i) {
      std::ostringstream ost;
      ost << G4HadronicParameters::Instance()->GetDirPARTICLEXS() << "/"
      << pname[i] << "/inel";
      gDataDirectory[i] = ost.str();
    }
  }
}
 
void G4ParticleInelasticXS::InitialiseOnFly(G4int Z)
{
  G4AutoLock l(&pInelasticXSMutex);
  for (G4int i=0; i<5; ++i) { 
    if ( nullptr == (data[i])->GetElementData(Z) ) { Initialise(Z, i); }
  }
  l.unlock();
}
 
void G4ParticleInelasticXS::Initialise(G4int Z, G4int idx)
{
  if (nullptr != data[idx]->GetElementData(Z)) { return; }
 
  // upload element data 
  std::ostringstream ost;
  ost << gDataDirectory[idx] << Z ;
  G4PhysicsVector* v = RetrieveVector(ost, true);
  data[idx]->InitialiseForElement(Z, v);
 
  // upload isotope data
  G4bool noComp = true;
  if (amin[Z] < amax[Z]) {
 
    for (G4int A=amin[Z]; A<=amax[Z]; ++A) {
      std::ostringstream ost1;
      ost1 << gDataDirectory[idx] << Z << "_" << A;
      G4PhysicsVector* v1 = RetrieveVector(ost1, false);
      if (nullptr != v1) {
    if (noComp) {
      G4int nmax = amax[Z] - A + 1;
      data[idx]->InitialiseForComponent(Z, nmax);
      noComp = false;
    }
    data[idx]->AddComponent(Z, A, v1);
      }
    }
  }
  // no components case
  if (noComp) { data[idx]->InitialiseForComponent(Z, 0); }
 
  // smooth transition 
  G4double sig1  = (*v)[v->GetVectorLength()-1];
  G4double ehigh = v->GetMaxEnergy();
  G4double sig2 = highEnergyXsection->GetInelasticElementCrossSection(
                  particle, ehigh, Z, aeff[Z]);
  coeff[Z][idx] = (sig2 > 0.) ? sig1/sig2 : 1.0;
}
 
G4PhysicsVector* 
G4ParticleInelasticXS::RetrieveVector(std::ostringstream& ost, G4bool warn)
{
  G4PhysicsLogVector* v = nullptr;
  std::ifstream filein(ost.str().c_str());
  if (!filein.is_open()) {
    if(warn) { 
      G4ExceptionDescription ed;
      ed << "Data file <" << ost.str().c_str()
     << "> is not opened!";
      G4Exception("G4ParticleInelasticXS::RetrieveVector(..)","had014",
          FatalException, ed, "Check G4PARTICLEXSDATA");
    }
  } else {
    if(verboseLevel > 1) {
      G4cout << "File " << ost.str() 
         << " is opened by G4ParticleInelasticXS" << G4endl;
    }
    // retrieve data from DB
    v = new G4PhysicsLogVector();
    if(!v->Retrieve(filein, true)) {
      G4ExceptionDescription ed;
      ed << "Data file <" << ost.str().c_str()
     << "> is not retrieved!";
      G4Exception("G4ParticleInelasticXS::RetrieveVector(..)","had015",
          FatalException, ed, "Check G4PARTICLEXSDATA");
    }
  }
  return v;
}