#include <G4NeutronElasticXS.hh>

Inheritance diagram for G4NeutronElasticXS:

Public Member Functions
void	BuildPhysicsTable (const G4ParticleDefinition &) final

G4double	ComputeCrossSection (const G4DynamicParticle , const G4Element , const G4Material *mat=nullptr)

void	CrossSectionDescription (std::ostream &) const final

virtual void	DumpPhysicsTable (const G4ParticleDefinition &)

bool	ForAllAtomsAndEnergies () const

	G4NeutronElasticXS ()

	G4NeutronElasticXS (const G4NeutronElasticXS &)=delete

G4double	GetCrossSection (const G4DynamicParticle , const G4Element , const G4Material *mat=nullptr)

G4double	GetElementCrossSection (const G4DynamicParticle , G4int Z, const G4Material ) final

G4double	GetIsoCrossSection (const G4DynamicParticle , G4int Z, G4int A, const G4Isotope iso, const G4Element elm, const G4Material mat) final

G4double	GetMaxKinEnergy () const

G4double	GetMinKinEnergy () const

const G4String &	GetName () const

virtual G4int	GetVerboseLevel () const

G4bool	IsElementApplicable (const G4DynamicParticle , G4int Z, const G4Material ) final

G4bool	IsIsoApplicable (const G4DynamicParticle , G4int Z, G4int A, const G4Element , const G4Material *) final

G4NeutronElasticXS &	operator= (const G4NeutronElasticXS &right)=delete

const G4Isotope *	SelectIsotope (const G4Element *, G4double kinEnergy, G4double logE) final

void	SetForAllAtomsAndEnergies (G4bool val)

void	SetMaxKinEnergy (G4double value)

void	SetMinKinEnergy (G4double value)

void	SetName (const G4String &nam)

virtual void	SetVerboseLevel (G4int value)

	~G4NeutronElasticXS () final

Static Public Member Functions
static const char *	Default_Name ()

Protected Attributes
G4String	name

G4int	verboseLevel

Private Member Functions
const G4String &	FindDirectoryPath ()

G4PhysicsVector *	GetPhysicsVector (G4int Z)

void	Initialise (G4int Z)

void	InitialiseOnFly (G4int Z)

Private Attributes
G4VComponentCrossSection *	ggXsection = nullptr

G4bool	isForAllAtomsAndEnergies

G4bool	isMaster = false

G4double	maxKinEnergy

G4double	minKinEnergy

const G4ParticleDefinition *	neutron

G4CrossSectionDataSetRegistry *	registry

Static Private Attributes
static G4double	coeff [MAXZEL] = {0.0}

static G4PhysicsVector *	data [MAXZEL] = {nullptr}

static G4String	gDataDirectory = ""

static const G4int	MAXZEL = 93

Detailed Description

Definition at line 56 of file G4NeutronElasticXS.hh.

Constructor & Destructor Documentation

◆ G4NeutronElasticXS() [1/2]

G4NeutronElasticXS::G4NeutronElasticXS ( )

explicit

Definition at line 62 of file G4NeutronElasticXS.cc.

 : G4VCrossSectionDataSet(Default_Name()),
   neutron(G4Neutron::Neutron())
{
  //  verboseLevel = 0;
  if(verboseLevel > 0){
    G4cout  << "G4NeutronElasticXS::G4NeutronElasticXS Initialise for Z < " 
        << MAXZEL << G4endl;
  }
  ggXsection = G4CrossSectionDataSetRegistry::Instance()->GetComponentCrossSection("Glauber-Gribov");
  if(ggXsection == nullptr) ggXsection = new G4ComponentGGHadronNucleusXsc();
  SetForAllAtomsAndEnergies(true);
}

References G4cout, G4endl, G4CrossSectionDataSetRegistry::GetComponentCrossSection(), ggXsection, G4CrossSectionDataSetRegistry::Instance(), MAXZEL, G4VCrossSectionDataSet::SetForAllAtomsAndEnergies(), and G4VCrossSectionDataSet::verboseLevel.

◆ ~G4NeutronElasticXS()

G4NeutronElasticXS::~G4NeutronElasticXS ( )

final

Definition at line 76 of file G4NeutronElasticXS.cc.

{
  if(isMaster) {
    for(G4int i=0; i<MAXZEL; ++i) {
      delete data[i];
      data[i] = nullptr;
    }
  }
}

References data, isMaster, and MAXZEL.

◆ G4NeutronElasticXS() [2/2]

G4NeutronElasticXS::G4NeutronElasticXS ( const G4NeutronElasticXS & )

delete

Member Function Documentation

◆ BuildPhysicsTable()

void G4NeutronElasticXS::BuildPhysicsTable ( const G4ParticleDefinition & p )

finalvirtual

Reimplemented from G4VCrossSectionDataSet.

Definition at line 177 of file G4NeutronElasticXS.cc.

{
  if(verboseLevel > 0){
    G4cout << "G4NeutronElasticXS::BuildPhysicsTable for " 
       << p.GetParticleName() << G4endl;
  }
  if(p.GetParticleName() != "neutron") { 
    G4ExceptionDescription ed;
    ed << p.GetParticleName() << " is a wrong particle type -"
       << " only neutron is allowed";
    G4Exception("G4NeutronElasticXS::BuildPhysicsTable(..)","had012",
        FatalException, ed, "");
    return; 
  }
  if(0. == coeff[0]) { 
#ifdef G4MULTITHREADED
    G4MUTEXLOCK(&neutronElasticXSMutex);
    if(0. == coeff[0]) { 
#endif
      coeff[0] = 1.0;
      isMaster = true;
      FindDirectoryPath();
#ifdef G4MULTITHREADED
    }
    G4MUTEXUNLOCK(&neutronElasticXSMutex);
#endif
  }
 
  // it is possible re-initialisation for the second run
  if(isMaster) {
 
    // Access to elements
    const G4ElementTable* table = G4Element::GetElementTable();
    for ( auto & elm : *table ) {
      G4int Z = std::max( 1, std::min( elm->GetZasInt(), MAXZEL-1) );
      if ( nullptr == data[Z] ) { Initialise(Z); }
    }
  }
}

References coeff, data, FatalException, FindDirectoryPath(), G4cout, G4endl, G4Exception(), G4MUTEXLOCK, G4MUTEXUNLOCK, G4Element::GetElementTable(), G4ParticleDefinition::GetParticleName(), Initialise(), isMaster, G4INCL::Math::max(), MAXZEL, G4INCL::Math::min(), G4VCrossSectionDataSet::verboseLevel, and Z.

◆ ComputeCrossSection()

G4double G4VCrossSectionDataSet::ComputeCrossSection	(	const G4DynamicParticle *	part,
		const G4Element *	elm,
		const G4Material *	mat = `nullptr`
	)

inherited

Definition at line 81 of file G4VCrossSectionDataSet.cc.

{
  G4int Z = elm->GetZasInt();
 
  if (IsElementApplicable(part, Z, mat)) { 
    return GetElementCrossSection(part, Z, mat);
  }
 
  // isotope-wise cross section making sum over available
  // isotope cross sections, which may be incomplete, so
  // the result is corrected 
  size_t nIso = elm->GetNumberOfIsotopes();    
  G4double fact = 0.0;
  G4double xsec = 0.0;
 
  // user-defined isotope abundances        
  const G4IsotopeVector* isoVector = elm->GetIsotopeVector();
  const G4double* abundVector = elm->GetRelativeAbundanceVector();
 
  for (size_t j=0; j<nIso; ++j) {
    const G4Isotope* iso = (*isoVector)[j];
    G4int A = iso->GetN();
    if(abundVector[j] > 0.0 && IsIsoApplicable(part, Z, A, elm, mat)) {
      fact += abundVector[j];
      xsec += abundVector[j]*GetIsoCrossSection(part, Z, A, iso, elm, mat);
    }
  }
  return (fact > 0.0) ? xsec/fact : 0.0; 
}

References A, G4VCrossSectionDataSet::GetElementCrossSection(), G4VCrossSectionDataSet::GetIsoCrossSection(), G4Element::GetIsotopeVector(), G4Isotope::GetN(), G4Element::GetNumberOfIsotopes(), G4Element::GetRelativeAbundanceVector(), G4Element::GetZasInt(), G4VCrossSectionDataSet::IsElementApplicable(), G4VCrossSectionDataSet::IsIsoApplicable(), and Z.

Referenced by G4VCrossSectionDataSet::GetCrossSection().

◆ CrossSectionDescription()

void G4NeutronElasticXS::CrossSectionDescription ( std::ostream & outFile ) const

finalvirtual

Reimplemented from G4VCrossSectionDataSet.

Definition at line 86 of file G4NeutronElasticXS.cc.

{
  outFile << "G4NeutronElasticXS calculates the neutron elastic scattering\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 energies Glauber-Gribiv cross section is used.\n";
}

◆ Default_Name()

static const char * G4NeutronElasticXS::Default_Name ( )

inlinestatic

Definition at line 64 of file G4NeutronElasticXS.hh.

64{return "G4NeutronElasticXS";}

◆ DumpPhysicsTable()

void G4VCrossSectionDataSet::DumpPhysicsTable ( const G4ParticleDefinition & )

virtualinherited

Reimplemented in G4CrossSectionElastic, G4CrossSectionInelastic, G4LENDCrossSection, G4ParticleHPCaptureData, G4ParticleHPElasticData, G4ParticleHPFissionData, G4ParticleHPInelasticData, G4ParticleHPJENDLHEData, G4ParticleHPThermalScatteringData, and G4UPiNuclearCrossSection.

Definition at line 174 of file G4VCrossSectionDataSet.cc.

175{}

◆ FindDirectoryPath()

const G4String & G4NeutronElasticXS::FindDirectoryPath ( )

private

Definition at line 217 of file G4NeutronElasticXS.cc.

{
  // check environment variable
  // build the complete string identifying the file with the data set
  if(gDataDirectory.empty()) {
    char* path = std::getenv("G4PARTICLEXSDATA");
    if (nullptr != path) {
      std::ostringstream ost;
      ost << path << "/neutron/el";
      gDataDirectory = ost.str();
    } else {
      G4Exception("G4NeutronElasticXS::Initialise(..)","had013",
          FatalException,
          "Environment variable G4PARTICLEXSDATA is not defined");
    }
  }
  return gDataDirectory;
}

References FatalException, G4Exception(), and gDataDirectory.

Referenced by BuildPhysicsTable(), and Initialise().

◆ ForAllAtomsAndEnergies()

bool G4VCrossSectionDataSet::ForAllAtomsAndEnergies ( ) const

inlineinherited

Definition at line 230 of file G4VCrossSectionDataSet.hh.

{
  return isForAllAtomsAndEnergies;
}

References G4VCrossSectionDataSet::isForAllAtomsAndEnergies.

Referenced by G4CrossSectionDataStore::AddDataSet().

◆ GetCrossSection()

G4double G4VCrossSectionDataSet::GetCrossSection	(	const G4DynamicParticle *	dp,
		const G4Element *	elm,
		const G4Material *	mat = `nullptr`
	)

inlineinherited

Definition at line 187 of file G4VCrossSectionDataSet.hh.

{
  return ComputeCrossSection(dp, elm, mat);
}

References G4VCrossSectionDataSet::ComputeCrossSection().

◆ GetElementCrossSection()

G4double G4NeutronElasticXS::GetElementCrossSection	(	const G4DynamicParticle *	aParticle,
		G4int	Z,
		const G4Material *
	)

finalvirtual

Reimplemented from G4VCrossSectionDataSet.

Definition at line 110 of file G4NeutronElasticXS.cc.

{
  G4double xs = 0.0;
  G4double ekin = aParticle->GetKineticEnergy();
 
  G4int Z = (ZZ >= MAXZEL) ? MAXZEL - 1 : ZZ; 
 
  auto pv = GetPhysicsVector(Z);
  if(pv == nullptr) { return xs; }
  //  G4cout  << "G4NeutronElasticXS::GetCrossSection e= " << ekin 
  // << " Z= " << Z << G4endl;
 
  if(ekin <= pv->Energy(1)) { 
    xs = (*pv)[1];
  } else if(ekin <= pv->GetMaxEnergy()) { 
    xs = pv->LogVectorValue(ekin, aParticle->GetLogKineticEnergy()); 
  } else {          
    xs = coeff[Z]*ggXsection->GetElasticElementCrossSection(neutron, 
                  ekin, Z, aeff[Z]);
  }
 
#ifdef G4VERBOSE
  if(verboseLevel > 1) {
    G4cout  << "Z= " << Z << " Ekin(MeV)= " << ekin/CLHEP::MeV 
        << ",  nElmXSel(b)= " << xs/CLHEP::barn 
        << G4endl;
  }
#endif
  return xs;
}

References aeff, CLHEP::barn, coeff, G4cout, G4endl, G4VComponentCrossSection::GetElasticElementCrossSection(), G4DynamicParticle::GetKineticEnergy(), G4DynamicParticle::GetLogKineticEnergy(), GetPhysicsVector(), ggXsection, MAXZEL, CLHEP::MeV, neutron, G4VCrossSectionDataSet::verboseLevel, and Z.

Referenced by GetIsoCrossSection().

◆ GetIsoCrossSection()

G4double G4NeutronElasticXS::GetIsoCrossSection	(	const G4DynamicParticle *	aParticle,
		G4int	Z,
		G4int	A,
		const G4Isotope *	iso,
		const G4Element *	elm,
		const G4Material *	mat
	)

finalvirtual

Reimplemented from G4VCrossSectionDataSet.

Definition at line 142 of file G4NeutronElasticXS.cc.

{
  return GetElementCrossSection(aParticle, Z, mat) * A/aeff[Z];
} 

References A, aeff, GetElementCrossSection(), and Z.

◆ GetMaxKinEnergy()

G4double G4VCrossSectionDataSet::GetMaxKinEnergy ( ) const

inlineinherited

Definition at line 220 of file G4VCrossSectionDataSet.hh.

{
  return maxKinEnergy;
}

References G4VCrossSectionDataSet::maxKinEnergy.

Referenced by G4CrossSectionElastic::IsElementApplicable(), G4CrossSectionInelastic::IsElementApplicable(), G4LENDCrossSection::IsIsoApplicable(), G4ParticleHPCaptureData::IsIsoApplicable(), G4ParticleHPElasticData::IsIsoApplicable(), G4ParticleHPFissionData::IsIsoApplicable(), and G4ParticleHPInelasticData::IsIsoApplicable().

◆ GetMinKinEnergy()

G4double G4VCrossSectionDataSet::GetMinKinEnergy ( ) const

inlineinherited

Definition at line 210 of file G4VCrossSectionDataSet.hh.

{
  return minKinEnergy;
}

References G4VCrossSectionDataSet::minKinEnergy.

Referenced by G4CrossSectionElastic::IsElementApplicable(), G4CrossSectionInelastic::IsElementApplicable(), G4LENDCrossSection::IsIsoApplicable(), G4ParticleHPCaptureData::IsIsoApplicable(), G4ParticleHPElasticData::IsIsoApplicable(), G4ParticleHPFissionData::IsIsoApplicable(), and G4ParticleHPInelasticData::IsIsoApplicable().

◆ GetName()

const G4String & G4VCrossSectionDataSet::GetName ( ) const

inlineinherited

Definition at line 225 of file G4VCrossSectionDataSet.hh.

{
  return name;
}

References G4VCrossSectionDataSet::name.

Referenced by G4LENDCrossSection::DumpLENDTargetInfo(), G4LENDCrossSection::DumpPhysicsTable(), G4LENDCrossSection::GetIsoCrossSection(), and G4CrossSectionDataStore::PrintCrossSectionHtml().

◆ GetPhysicsVector()

G4PhysicsVector * G4NeutronElasticXS::GetPhysicsVector ( G4int Z )

inlineprivate

Definition at line 116 of file G4NeutronElasticXS.hh.

{
  if(nullptr == data[Z]) { InitialiseOnFly(Z); }
  return data[Z];
}

References data, InitialiseOnFly(), and Z.

Referenced by GetElementCrossSection().

◆ GetVerboseLevel()

G4int G4VCrossSectionDataSet::GetVerboseLevel ( ) const

inlinevirtualinherited

Reimplemented in G4ParticleHPCaptureData, G4ParticleHPElasticData, G4ParticleHPFissionData, and G4ParticleHPInelasticData.

Definition at line 195 of file G4VCrossSectionDataSet.hh.

{
  return verboseLevel;
}

References G4VCrossSectionDataSet::verboseLevel.

◆ Initialise()

void G4NeutronElasticXS::Initialise ( G4int Z )

private

Definition at line 249 of file G4NeutronElasticXS.cc.

{
  if(data[Z] != nullptr) { return; }
 
  // upload data from file
  data[Z] = new G4PhysicsLogVector();
 
  std::ostringstream ost;
  ost << FindDirectoryPath() << Z ;
  std::ifstream filein(ost.str().c_str());
  if (!filein.is_open()) {
    G4ExceptionDescription ed;
    ed << "Data file <" << ost.str().c_str()
       << "> is not opened!";
    G4Exception("G4NeutronElasticXS::Initialise(..)","had014",
                FatalException, ed, "Check G4PARTICLEXSDATA");
    return;
  }
  if(verboseLevel > 1) {
    G4cout << "file " << ost.str() 
       << " is opened by G4NeutronElasticXS" << G4endl;
  }
    
  // retrieve data from DB
  if(!data[Z]->Retrieve(filein, true)) {
    G4ExceptionDescription ed;
    ed << "Data file <" << ost.str().c_str()
       << "> is not retrieved!";
    G4Exception("G4NeutronElasticXS::Initialise(..)","had015",
        FatalException, ed, "Check G4PARTICLEXSDATA");
    return;
  }
  // smooth transition 
  G4double sig1  = (*(data[Z]))[data[Z]->GetVectorLength()-1];
  G4double ehigh = data[Z]->GetMaxEnergy();
  G4double sig2  = ggXsection->GetElasticElementCrossSection(neutron, 
                               ehigh, Z, aeff[Z]);
  coeff[Z] = (sig2 > 0.) ? sig1/sig2 : 1.0;  
}

References aeff, coeff, data, FatalException, FindDirectoryPath(), G4cout, G4endl, G4Exception(), G4VComponentCrossSection::GetElasticElementCrossSection(), G4PhysicsVector::GetMaxEnergy(), G4PhysicsVector::GetVectorLength(), ggXsection, neutron, G4VCrossSectionDataSet::verboseLevel, and Z.

Referenced by BuildPhysicsTable(), and InitialiseOnFly().

◆ InitialiseOnFly()

void G4NeutronElasticXS::InitialiseOnFly ( G4int Z )

private

Definition at line 236 of file G4NeutronElasticXS.cc.

{
#ifdef G4MULTITHREADED
   G4MUTEXLOCK(&neutronElasticXSMutex);
   if(data[Z] == nullptr) { 
#endif
     Initialise(Z);
#ifdef G4MULTITHREADED
   }
   G4MUTEXUNLOCK(&neutronElasticXSMutex);
#endif
}

References data, G4MUTEXLOCK, G4MUTEXUNLOCK, Initialise(), and Z.

Referenced by GetPhysicsVector().

◆ IsElementApplicable()

G4bool G4NeutronElasticXS::IsElementApplicable	(	const G4DynamicParticle *	,
		G4int	Z,
		const G4Material *
	)

finalvirtual

Reimplemented from G4VCrossSectionDataSet.

Definition at line 96 of file G4NeutronElasticXS.cc.

{
  return true;
}

◆ IsIsoApplicable()

G4bool G4NeutronElasticXS::IsIsoApplicable	(	const G4DynamicParticle *	,
		G4int	Z,
		G4int	A,
		const G4Element *	,
		const G4Material *
	)

finalvirtual

Reimplemented from G4VCrossSectionDataSet.

Definition at line 102 of file G4NeutronElasticXS.cc.

{
  return false;
}

◆ operator=()

G4NeutronElasticXS & G4NeutronElasticXS::operator= ( const G4NeutronElasticXS & right )

delete

◆ SelectIsotope()

const G4Isotope * G4NeutronElasticXS::SelectIsotope	(	const G4Element *	anElement,
		G4double	kinEnergy,
		G4double	logE
	)

finalvirtual

Reimplemented from G4VCrossSectionDataSet.

Definition at line 151 of file G4NeutronElasticXS.cc.

{
  size_t nIso = anElement->GetNumberOfIsotopes();
  const G4Isotope* iso = anElement->GetIsotope(0);
 
  //G4cout << "SelectIsotope NIso= " << nIso << G4endl;
  if(1 == nIso) { return iso; }
 
  const G4double* abundVector = anElement->GetRelativeAbundanceVector();
  G4double q = G4UniformRand();
  G4double sum = 0.0;
  size_t j;
 
  // isotope wise cross section not used
  for (j=0; j<nIso; ++j) {
    sum += abundVector[j];
    if(q <= sum) {
      iso = anElement->GetIsotope(j);
      break;
    }
  }
  return iso;
}