G4CrossSectionDataStore Class Reference

#include <G4CrossSectionDataStore.hh>

Public Member Functions
	G4CrossSectionDataStore ()
	~G4CrossSectionDataStore ()=default
G4double	GetCrossSection (const G4DynamicParticle *, const G4Material *)
G4double	ComputeCrossSection (const G4DynamicParticle *, const G4Material *)
G4double	GetCrossSection (const G4DynamicParticle *, const G4Element *, const G4Material *)
G4double	GetCrossSection (const G4DynamicParticle *, G4int Z, G4int A, const G4Isotope *, const G4Element *, const G4Material *)
const G4Element *	SampleZandA (const G4DynamicParticle *, const G4Material *, G4Nucleus &target)
void	BuildPhysicsTable (const G4ParticleDefinition &)
void	DumpPhysicsTable (const G4ParticleDefinition &)
void	DumpHtml (const G4ParticleDefinition &, std::ofstream &) const
void	PrintCrossSectionHtml (const G4VCrossSectionDataSet *cs) const
void	AddDataSet (G4VCrossSectionDataSet *)
void	AddDataSet (G4VCrossSectionDataSet *, std::size_t)
const std::vector< G4VCrossSectionDataSet * > &	GetDataSetList () const
void	SetVerboseLevel (G4int value)
void	SetForcedElement (const G4Element *)
G4CrossSectionDataStore &	operator= (const G4CrossSectionDataStore &right)=delete
	G4CrossSectionDataStore (const G4CrossSectionDataStore &)=delete

Detailed Description

Definition at line 61 of file G4CrossSectionDataStore.hh.

Constructor & Destructor Documentation

G4CrossSectionDataStore() [1/2]

G4CrossSectionDataStore::G4CrossSectionDataStore

(

)

Definition at line 61 of file G4CrossSectionDataStore.cc.

  : nist(G4NistManager::Instance())
{}

~G4CrossSectionDataStore()

G4CrossSectionDataStore::~G4CrossSectionDataStore ( )

default

G4CrossSectionDataStore() [2/2]

G4CrossSectionDataStore::G4CrossSectionDataStore ( const G4CrossSectionDataStore &  )

delete

Member Function Documentation

AddDataSet() [1/2]

void G4CrossSectionDataStore::AddDataSet

(

G4VCrossSectionDataSet *

p

)

Definition at line 398 of file G4CrossSectionDataStore.cc.

{
  if(p->ForAllAtomsAndEnergies()) { 
    dataSetList.clear();
    nDataSetList = 0;
  }
  dataSetList.push_back(p);
  ++nDataSetList;
}

Referenced by G4HadronicProcess::AddDataSet(), G4ElectronNuclearProcess::G4ElectronNuclearProcess(), G4PositronNuclearProcess::G4PositronNuclearProcess(), and G4HadronPhysicsShielding::Neutron().

AddDataSet() [2/2]

void G4CrossSectionDataStore::AddDataSet	(	G4VCrossSectionDataSet *	p,
		std::size_t	i
	)

Definition at line 410 of file G4CrossSectionDataStore.cc.

{
  if(p->ForAllAtomsAndEnergies()) {
    dataSetList.clear();
    dataSetList.push_back(p);
    nDataSetList = 1;
  } else if ( i >= dataSetList.size() ) {
    dataSetList.push_back(p);
    ++nDataSetList;
  } else {
    std::vector< G4VCrossSectionDataSet* >::iterator it = dataSetList.end() - i;
    dataSetList.insert(it , p);
    ++nDataSetList;
  }
}

BuildPhysicsTable()

void G4CrossSectionDataStore::BuildPhysicsTable

(

const G4ParticleDefinition &

part

)

Definition at line 272 of file G4CrossSectionDataStore.cc.

{
  if (nDataSetList == 0) {
    G4ExceptionDescription ed;
    ed << "No cross section is registered for " 
       << part.GetParticleName() << G4endl;
    G4Exception("G4CrossSectionDataStore::BuildPhysicsTable", "had001", 
                FatalException, ed);
    return;
  }
  matParticle = &part;
  for (G4int i=0; i<nDataSetList; ++i) {
    dataSetList[i]->BuildPhysicsTable(part);
  }
  const G4MaterialTable* theMatTable = G4Material::GetMaterialTable();
  std::size_t nelm = 0;
  std::size_t niso = 0;
  for(auto mat : *theMatTable) {
    std::size_t nElements = mat->GetNumberOfElements();
    nelm = std::max(nelm, nElements);
    for(G4int j=0; j<(G4int)nElements; ++j) {
      niso = std::max(niso, mat->GetElement(j)->GetNumberOfIsotopes());
    }
  }
  // define vectors for a run
  xsecelm.resize(nelm, 0.0);
  xseciso.resize(niso, 0.0);
}

Referenced by G4HadronicProcess::BuildPhysicsTable().

ComputeCrossSection()

G4double G4CrossSectionDataStore::ComputeCrossSection	(	const G4DynamicParticle *	dp,
		const G4Material *	mat
	)

Definition at line 68 of file G4CrossSectionDataStore.cc.

{
  currentMaterial = mat;
  matParticle = dp->GetDefinition();
  matKinEnergy = dp->GetKineticEnergy();
  matCrossSection = 0.0;
 
  std::size_t nElements = mat->GetNumberOfElements();
  const G4double* nAtomsPerVolume = mat->GetVecNbOfAtomsPerVolume();
 
  if(xsecelm.size() < nElements) { xsecelm.resize(nElements); }
 
  for(G4int i=0; i<(G4int)nElements; ++i) {
    G4double xs = 
      nAtomsPerVolume[i]*GetCrossSection(dp, mat->GetElement(i), mat);
    matCrossSection += std::max(xs, 0.0); 
    xsecelm[i] = matCrossSection;
  }
  return matCrossSection;
}

Referenced by G4GammaGeneralProcess::BuildPhysicsTable(), G4HadronicProcess::ComputeCrossSection(), GetCrossSection(), G4NeutrinoElectronProcess::GetMeanFreePath(), G4HadronicProcess::GetMeanFreePath(), G4ElNeutrinoNucleusProcess::GetMeanFreePath(), G4MuNeutrinoNucleusProcess::GetMeanFreePath(), G4TauNeutrinoNucleusProcess::GetMeanFreePath(), G4HadronXSDataTable::Initialise(), G4NeutronGeneralProcess::PostStepDoIt(), G4HadronicProcess::PostStepDoIt(), G4HadronElasticProcess::PostStepDoIt(), and G4GammaGeneralProcess::SelectHadProcess().

DumpHtml()

void G4CrossSectionDataStore::DumpHtml	(	const G4ParticleDefinition &	,
		std::ofstream &	outFile
	)		const

Definition at line 331 of file G4CrossSectionDataStore.cc.

{
  // Write cross section data set info to html physics list
  // documentation page
 
  G4double ehi = 0;
  G4double elo = 0;
  G4String physListName(std::getenv("G4PhysListName"));
  for (G4int i = nDataSetList-1; i > 0; i--) {
    elo = dataSetList[i]->GetMinKinEnergy()/GeV;
    ehi = dataSetList[i]->GetMaxKinEnergy()/GeV;
    outFile << "      <li><b><a href=\"" << physListName << "_"
        << dataSetList[i]->GetName() << ".html\"> "
            << dataSetList[i]->GetName() << "</a> from "
            << elo << " GeV to " << ehi << " GeV </b></li>\n";
    PrintCrossSectionHtml(dataSetList[i]);          
  }
 
  G4double defaultHi = dataSetList[0]->GetMaxKinEnergy()/GeV;
  if (ehi < defaultHi) {
    outFile << "      <li><b><a href=\"" << dataSetList[0]->GetName() 
        << ".html\"> "
            << dataSetList[0]->GetName() << "</a> from "
            << ehi << " GeV to " << defaultHi << " GeV </b></li>\n";
    PrintCrossSectionHtml(dataSetList[0]);          
  }
}

Referenced by G4HadronicProcessStore::PrintHtml().

DumpPhysicsTable()

void G4CrossSectionDataStore::DumpPhysicsTable

(

const G4ParticleDefinition &

part

)

Definition at line 304 of file G4CrossSectionDataStore.cc.

{
  // Print out all cross section data sets used and the energies at
  // which they apply
 
  if (nDataSetList == 0) {
    G4cout << "WARNING - G4CrossSectionDataStore::DumpPhysicsTable: "
       << " no data sets registered" << G4endl;
    return;
  }
 
  for (G4int i = nDataSetList-1; i >= 0; --i) {
    G4double e1 = dataSetList[i]->GetMinKinEnergy();
    G4double e2 = dataSetList[i]->GetMaxKinEnergy();
    G4cout
      << "     Cr_sctns: " << std::setw(25) << dataSetList[i]->GetName() << ": "
      << G4BestUnit(e1, "Energy") << " ---> "
      <<  G4BestUnit(e2, "Energy") << "\n";
    if (dataSetList[i]->GetName() == "G4CrossSectionPairGG") {
      dataSetList[i]->DumpPhysicsTable(part);
    }
    G4cout << G4endl;
  }
}

Referenced by G4ChargeExchangeProcess::DumpPhysicsTable(), and G4HadronicProcess::DumpPhysicsTable().

GetCrossSection() [1/3]

G4double G4CrossSectionDataStore::GetCrossSection	(	const G4DynamicParticle *	dp,
		const G4Element *	elm,
		const G4Material *	mat
	)

Definition at line 92 of file G4CrossSectionDataStore.cc.

{
  // first check the most last cross section
  G4int i = nDataSetList-1;
  G4int Z = elm->GetZasInt();
 
  if(elm->GetNaturalAbundanceFlag() &&
     dataSetList[i]->IsElementApplicable(dp, Z, mat))
  {
    // element wise cross section
    return dataSetList[i]->GetElementCrossSection(dp, Z, mat);
  }
 
  // isotope wise cross section
  G4int nIso = (G4int)elm->GetNumberOfIsotopes();
 
  // user-defined isotope abundances
  const G4double* abundVector = elm->GetRelativeAbundanceVector();
 
  G4double sigma = 0.0;
 
  // isotope and element wise cross sections
  for(G4int j = 0; j < nIso; ++j) 
  {
    const G4Isotope* iso = elm->GetIsotope(j);
    sigma += abundVector[j] *
      GetIsoCrossSection(dp, Z, iso->GetN(), iso, elm, mat, i);
  }
  return sigma;
}

GetCrossSection() [2/3]

G4double G4CrossSectionDataStore::GetCrossSection ( const G4DynamicParticle *  dp, const G4Material *  mat  )

inline

Definition at line 149 of file G4CrossSectionDataStore.hh.

{
  if(dp->GetKineticEnergy() != matKinEnergy || mat != currentMaterial ||
     dp->GetDefinition() != matParticle) {
    ComputeCrossSection(dp, mat);
  }
  return matCrossSection;
}

Referenced by ComputeCrossSection(), G4HadElementSelector::G4HadElementSelector(), G4ChargeExchangeProcess::GetElementCrossSection(), and G4HadronicProcess::GetElementCrossSection().

GetCrossSection() [3/3]

G4double G4CrossSectionDataStore::GetCrossSection	(	const G4DynamicParticle *	dp,
		G4int	Z,
		G4int	A,
		const G4Isotope *	iso,
		const G4Element *	elm,
		const G4Material *	mat
	)

Definition at line 164 of file G4CrossSectionDataStore.cc.

{
  for (G4int i = nDataSetList-1; i >= 0; --i) {
    if (dataSetList[i]->IsIsoApplicable(dp, Z, A, elm, mat) ) {
      return dataSetList[i]->GetIsoCrossSection(dp, Z, A, iso, elm, mat);
    } else if(dataSetList[i]->IsElementApplicable(dp, Z, mat)) {
      return dataSetList[i]->GetElementCrossSection(dp, Z, mat);
    }
  }
  G4ExceptionDescription ed;
  ed << "No isotope cross section found for " 
     << dp->GetDefinition()->GetParticleName()
     << " off target Element " << elm->GetName() 
     << " Z= " << Z << " A= " << A;
  if(nullptr != mat) ed << " from " << mat->GetName();
  ed << " E(MeV)=" << dp->GetKineticEnergy()/MeV << G4endl; 
  G4Exception("G4CrossSectionDataStore::GetCrossSection", "had001", 
              FatalException, ed);
  return 0.0;
}

GetDataSetList()

const std::vector< G4VCrossSectionDataSet * > & G4CrossSectionDataStore::GetDataSetList ( ) const

inline

Definition at line 143 of file G4CrossSectionDataStore.hh.

{
  return dataSetList;
}

operator=()

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

delete

PrintCrossSectionHtml()

void G4CrossSectionDataStore::PrintCrossSectionHtml

(

const G4VCrossSectionDataSet *

cs

)

const

Definition at line 362 of file G4CrossSectionDataStore.cc.

{
  G4String dirName(std::getenv("G4PhysListDocDir"));
  G4String physListName(std::getenv("G4PhysListName"));
 
  G4String pathName = dirName + "/" + physListName + "_" + HtmlFileName(cs->GetName());
  std::ofstream outCS;
  outCS.open(pathName);
  outCS << "<html>\n";
  outCS << "<head>\n";
  outCS << "<title>Description of " << cs->GetName() 
    << "</title>\n";
  outCS << "</head>\n";
  outCS << "<body>\n";
  
  cs->CrossSectionDescription(outCS);
  
  outCS << "</body>\n";
  outCS << "</html>\n";
}

Referenced by DumpHtml().

SampleZandA()

const G4Element * G4CrossSectionDataStore::SampleZandA	(	const G4DynamicParticle *	dp,
		const G4Material *	mat,
		G4Nucleus &	target
	)

Definition at line 192 of file G4CrossSectionDataStore.cc.

{
  if(nullptr != forcedElement) { return forcedElement; }
  std::size_t nElements = mat->GetNumberOfElements();
  const G4Element* anElement = mat->GetElement(0);
 
  // select element from a compound 
  if(1 < nElements) {
    G4double cross = matCrossSection*G4UniformRand();
    for(G4int i=0; i<(G4int)nElements; ++i) {
      if(cross <= xsecelm[i]) {
        anElement = mat->GetElement(i);
        break;
      }
    }
  }
 
  G4int Z = anElement->GetZasInt();
  const G4Isotope* iso = nullptr;
 
  G4int i = nDataSetList-1;
  if (dataSetList[i]->IsElementApplicable(dp, Z, mat)) {
 
    //----------------------------------------------------------------
    // element-wise cross section
    // isotope cross section is not computed
    //----------------------------------------------------------------
    std::size_t nIso = anElement->GetNumberOfIsotopes();
    iso = anElement->GetIsotope(0);
 
    // more than 1 isotope
    if(1 < nIso) { 
      iso = dataSetList[i]->SelectIsotope(anElement, 
                                          dp->GetKineticEnergy(),
                      dp->GetLogKineticEnergy());
    }
  } else {
 
    //----------------------------------------------------------------
    // isotope-wise cross section
    // isotope cross section is computed
    //----------------------------------------------------------------
    std::size_t nIso = anElement->GetNumberOfIsotopes();
    iso = anElement->GetIsotope(0);
 
    // more than 1 isotope
    if(1 < nIso) {
      const G4double* abundVector = anElement->GetRelativeAbundanceVector();
      if(xseciso.size() < nIso) { xseciso.resize(nIso); }
 
      G4double cross = 0.0;
      G4int j;
      for (j = 0; j<(G4int)nIso; ++j) {
    G4double xsec = 0.0;
    if(abundVector[j] > 0.0) {
      iso = anElement->GetIsotope(j);
      xsec = abundVector[j]*
        GetIsoCrossSection(dp, Z, iso->GetN(), iso, anElement, mat, i);
    }
    cross += xsec;
    xseciso[j] = cross;
      }
      cross *= G4UniformRand();
      for (j = 0; j<(G4int)nIso; ++j) {
    if(cross <= xseciso[j]) {
      iso = anElement->GetIsotope(j);
      break;
    }
      }
    }
  }
  target.SetIsotope(iso);
  return anElement;
}

Referenced by G4NeutrinoElectronProcess::PostStepDoIt(), G4HadronicProcess::PostStepDoIt(), and G4HadronElasticProcess::PostStepDoIt().

SetForcedElement()

void G4CrossSectionDataStore::SetForcedElement ( const G4Element *  ptr )

inline

Definition at line 137 of file G4CrossSectionDataStore.hh.

{
  forcedElement = ptr;
}

SetVerboseLevel()

void G4CrossSectionDataStore::SetVerboseLevel ( G4int  value )

inline

Definition at line 132 of file G4CrossSectionDataStore.hh.

{
  verboseLevel = value;
}

---

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

• G4CrossSectionDataStore.hh
• G4CrossSectionDataStore.cc