G4NeutronCaptureXS Class Reference

#include <G4NeutronCaptureXS.hh>

Inheritance diagram for G4NeutronCaptureXS:

Collaboration diagram for G4NeutronCaptureXS:

Public Member Functions
	G4NeutronCaptureXS ()
virtual	~G4NeutronCaptureXS ()
virtual G4bool	IsElementApplicable (const G4DynamicParticle *, G4int Z, const G4Material *)
virtual G4bool	IsIsoApplicable (const G4DynamicParticle *, G4int Z, G4int A, const G4Element *, const G4Material *)
virtual G4double	GetElementCrossSection (const G4DynamicParticle *, G4int Z, const G4Material *mat=0)
virtual G4double	GetIsoCrossSection (const G4DynamicParticle *, G4int Z, G4int A, const G4Isotope *iso, const G4Element *elm, const G4Material *mat)
virtual G4Isotope *	SelectIsotope (const G4Element *, G4double kinEnergy)
virtual void	BuildPhysicsTable (const G4ParticleDefinition &)
virtual void	CrossSectionDescription (std::ostream &) const
Public Member Functions inherited from G4VCrossSectionDataSet
	G4VCrossSectionDataSet (const G4String &nam="")
virtual	~G4VCrossSectionDataSet ()
G4double	GetCrossSection (const G4DynamicParticle *, const G4Element *, const G4Material *mat=0)
G4double	ComputeCrossSection (const G4DynamicParticle *, const G4Element *, const G4Material *mat=0)
virtual void	DumpPhysicsTable (const G4ParticleDefinition &)
virtual G4int	GetVerboseLevel () const
virtual void	SetVerboseLevel (G4int value)
G4double	GetMinKinEnergy () const
void	SetMinKinEnergy (G4double value)
G4double	GetMaxKinEnergy () const
void	SetMaxKinEnergy (G4double value)
const G4String &	GetName () const

Static Public Member Functions
static const char *	Default_Name ()

Private Member Functions
void	Initialise (G4int Z, const char *=0)
G4PhysicsVector *	RetrieveVector (std::ostringstream &in, G4bool warn)
G4double	IsoCrossSection (G4double ekin, G4int Z, G4int A)
G4NeutronCaptureXS &	operator= (const G4NeutronCaptureXS &right)
	G4NeutronCaptureXS (const G4NeutronCaptureXS &)

Private Attributes
G4double	emax
G4double	elimit
G4bool	isMaster
std::vector< G4double >	temp

Static Private Attributes
static G4ElementData *	data = 0
static const G4int	amin [MAXZCAPTURE]
static const G4int	amax [MAXZCAPTURE]

Additional Inherited Members
Protected Member Functions inherited from G4VCrossSectionDataSet
void	SetName (const G4String &)
Protected Attributes inherited from G4VCrossSectionDataSet
G4int	verboseLevel

Detailed Description

Definition at line 61 of file G4NeutronCaptureXS.hh.

Constructor & Destructor Documentation

G4NeutronCaptureXS() [1/2]

G4NeutronCaptureXS::G4NeutronCaptureXS

(

)

Definition at line 86 of file G4NeutronCaptureXS.cc.

 : G4VCrossSectionDataSet(Default_Name()),
   emax(20*MeV),elimit(1.0e-10*eV)
{
  //  verboseLevel = 0;
  if(verboseLevel > 0){
    G4cout  << "G4NeutronCaptureXS::G4NeutronCaptureXS: Initialise for Z < "
        << MAXZCAPTURE << G4endl;
  }
  isMaster = false;
}

Here is the caller graph for this function:

~G4NeutronCaptureXS()

G4NeutronCaptureXS::~G4NeutronCaptureXS ( )

virtual

Definition at line 98 of file G4NeutronCaptureXS.cc.

{
  if(isMaster) { delete data; data = 0; }
}

G4NeutronCaptureXS() [2/2]

G4NeutronCaptureXS::G4NeutronCaptureXS ( const G4NeutronCaptureXS &  )

private

Member Function Documentation

BuildPhysicsTable()

void G4NeutronCaptureXS::BuildPhysicsTable ( const G4ParticleDefinition &  p )

virtual

Reimplemented from G4VCrossSectionDataSet.

Definition at line 248 of file G4NeutronCaptureXS.cc.

{
  if(verboseLevel > 0){
    G4cout << "G4NeutronCaptureXS::BuildPhysicsTable for " 
       << p.GetParticleName() << G4endl;
  }
  if(p.GetParticleName() != "neutron") { 
    G4ExceptionDescription ed;
    ed << p.GetParticleName() << " is a wrong particle type -"
       << " only neutron is allowed";
    G4Exception("G4NeutronCaptureXS::BuildPhysicsTable(..)","had012",
        FatalException, ed, "");
    return; 
  }

  if(!data) { 
    isMaster = true;
    data = new G4ElementData(); 
    data->SetName("NeutronCapture");
    temp.resize(13,0.0);
  }

  // it is possible re-initialisation for the second run
  if(isMaster) {

    // check environment variable 
    // Build the complete string identifying the file with the data set
    char* path = getenv("G4NEUTRONXSDATA");

    // Access to elements
    const G4ElementTable* theElmTable = G4Element::GetElementTable();
    size_t numOfElm = G4Element::GetNumberOfElements();
    if(numOfElm > 0) {
      for(size_t i=0; i<numOfElm; ++i) {
    G4int Z = G4int(((*theElmTable)[i])->GetZ());
    if(Z < 1)                 { Z = 1; }
    else if(Z >= MAXZCAPTURE) { Z = MAXZCAPTURE-1; }
    //G4cout << "Z= " << Z << G4endl;
    // Initialisation 
    if(!data->GetElementData(Z)) { Initialise(Z, path); }
      }
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

CrossSectionDescription()

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

virtual

Reimplemented from G4VCrossSectionDataSet.

Definition at line 103 of file G4NeutronCaptureXS.cc.

{
  outFile << "G4NeutronCaptureXS calculates the neutron capture cross sections\n"
          << "on nuclei using data from the high precision neutron database.\n"
          << "These data are simplified and smoothed over the resonance region\n"
          << "in order to reduce CPU time.  G4NeutronCaptureXS is valid up to\n"
          << "20 MeV for all targets through U.\n";
}

Here is the caller graph for this function:

Default_Name()

static const char* G4NeutronCaptureXS::Default_Name ( )

inlinestatic

Definition at line 69 of file G4NeutronCaptureXS.hh.

{return "G4NeutronCaptureXS";}

Here is the call graph for this function:

Here is the caller graph for this function:

GetElementCrossSection()

G4double G4NeutronCaptureXS::GetElementCrossSection ( const G4DynamicParticle *  aParticle, G4int  Z, const G4Material *  mat = 0  )

virtual

Reimplemented from G4VCrossSectionDataSet.

Definition at line 128 of file G4NeutronCaptureXS.cc.

{
  G4double xs = 0.0;
  G4double ekin = aParticle->GetKineticEnergy();
  if(ekin > emax || Z < 1 || Z >= MAXZCAPTURE) { return xs; }
  if(ekin < elimit) { ekin = elimit; }

  // element was not initialised
  G4PhysicsVector* pv = data->GetElementData(Z);
  if(!pv) {
    Initialise(Z);
    pv = data->GetElementData(Z);
    if(!pv) { return xs; }
  }

  G4double e1 = pv->Energy(0);
  if(ekin < e1) { xs = (*pv)[0]*std::sqrt(e1/ekin); }
  else if(ekin <= pv->GetMaxEnergy()) { xs = pv->Value(ekin); }

  if(verboseLevel > 0){
    G4cout  << "ekin= " << ekin << ",  xs= " << xs << G4endl;
  }
  return xs;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetIsoCrossSection()

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

virtual

Reimplemented from G4VCrossSectionDataSet.

Definition at line 155 of file G4NeutronCaptureXS.cc.

{
  G4double xs = 0.0;
  G4double ekin = aParticle->GetKineticEnergy();
  if(ekin <= emax && Z > 0 && Z < MAXZCAPTURE) { 
    xs = IsoCrossSection(ekin, Z, A); 
  }
  return xs;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Initialise()

void G4NeutronCaptureXS::Initialise ( G4int  Z, const char *  p = 0  )

private

Definition at line 294 of file G4NeutronCaptureXS.cc.

{
  if(data->GetElementData(Z) || Z < 1 || Z >= MAXZCAPTURE) { return; }
  const char* path = p;

  // check environment variable 
  if(!p) {
    path = getenv("G4NEUTRONXSDATA");
    if (!path) {
      G4Exception("G4NeutronCaptureXS::Initialise(..)","had013",FatalException,
                  "Environment variable G4NEUTRONXSDATA is not defined");
      return;
    }
  }

  // upload element data 
  std::ostringstream ost;
  ost << path << "/cap" << Z ;
  G4PhysicsVector* v = RetrieveVector(ost, true);
  data->InitialiseForElement(Z, v);

  // upload isotope data
  if(amin[Z] > 0) {
    size_t nmax = (size_t)(amax[Z]-amin[Z]+1);
    data->InitialiseForComponent(Z, nmax);

    for(G4int A=amin[Z]; A<=amax[Z]; ++A) {
      std::ostringstream ost1;
      ost1 << path << "/cap" << Z << "_" << A;
      v = RetrieveVector(ost1, false);
      data->AddComponent(Z, A, v); 
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

IsElementApplicable()

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

virtual

Reimplemented from G4VCrossSectionDataSet.

Definition at line 113 of file G4NeutronCaptureXS.cc.

{
  return true;
}

Here is the caller graph for this function:

IsIsoApplicable()

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

virtual

Reimplemented from G4VCrossSectionDataSet.

Definition at line 120 of file G4NeutronCaptureXS.cc.

{
  return true;
}

Here is the caller graph for this function:

IsoCrossSection()

G4double G4NeutronCaptureXS::IsoCrossSection ( G4double  ekin, G4int  Z, G4int  A  )

private

Definition at line 168 of file G4NeutronCaptureXS.cc.

{
  G4double xs = 0.0;
  if(ekin < elimit) { ekin = elimit; }

  // element was not initialised
  G4PhysicsVector* pv = data->GetElementData(Z);
  if(!pv) {
    Initialise(Z);
    pv = data->GetElementData(Z);
  }

  // isotope cross section exist
  if(pv && amin[Z] > 0 && A >= amin[Z] && A <= amax[Z]) {
    pv  = data->GetComponentDataByID(Z, A - amin[Z]);
    if(pv) { 

      G4double e1 = pv->Energy(1);
      if(ekin < e1) { xs = (*pv)[1]*std::sqrt(e1/ekin); }
      else if(ekin <= pv->GetMaxEnergy()) { xs = pv->Value(ekin); }
    }
  }
  if(verboseLevel > 0) {
    G4cout  << "G4NeutronCaptureXS::IsoCrossSection: Ekin(MeV)= " << ekin/MeV 
        << "  xs(b)= " << xs/barn 
        << "  Z= " << Z << "  A= " << A << G4endl;
  }
  return xs;
}

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

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

private

Here is the caller graph for this function:

RetrieveVector()

G4PhysicsVector * G4NeutronCaptureXS::RetrieveVector ( std::ostringstream &  in, G4bool  warn  )

private

Definition at line 330 of file G4NeutronCaptureXS.cc.

{
  G4PhysicsLogVector* v = 0;
  std::ifstream filein(ost.str().c_str());
  if (!(filein)) {
    if(warn) {
      G4ExceptionDescription ed;
      ed << "Data file <" << ost.str().c_str()
     << "> is not opened!";
      G4Exception("G4NeutronCaptureXS::RetrieveVector(..)","had014",
          FatalException, ed, "Check G4NEUTRONXSDATA");
    }
  } else {
    if(verboseLevel > 1) {
      G4cout << "File " << ost.str() 
         << " is opened by G4NeutronCaptureXS" << 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("G4NeutronCaptureXS::RetrieveVector(..)","had015",
          FatalException, ed, "Check G4NEUTRONXSDATA");
    }
  }
  return v;
}

Here is the call graph for this function:

Here is the caller graph for this function:

SelectIsotope()

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

virtual

Reimplemented from G4VCrossSectionDataSet.

Definition at line 198 of file G4NeutronCaptureXS.cc.

{
  size_t nIso = anElement->GetNumberOfIsotopes();
  G4IsotopeVector* isoVector = anElement->GetIsotopeVector();
  G4Isotope* iso = (*isoVector)[0];

  // more than 1 isotope
  if(1 < nIso) {
    G4int Z = G4lrint(anElement->GetZ());

    G4double* abundVector = anElement->GetRelativeAbundanceVector();
    G4double q = G4UniformRand();
    G4double sum = 0.0;

    // is there isotope wise cross section?
    size_t j;
    if(0 == amin[Z] || Z >= MAXZCAPTURE) {
      for (j = 0; j<nIso; ++j) {
    sum += abundVector[j];
    if(q <= sum) {
      iso = (*isoVector)[j];
      break;
    }
      }
    } else {

      // element may be not initialised in unit test
      if(!data->GetElementData(Z)) { Initialise(Z); }
      size_t nn = temp.size();
      if(nn < nIso) { temp.resize(nIso, 0.); }

      for (j=0; j<nIso; ++j) {
        sum += abundVector[j]*IsoCrossSection(kinEnergy, Z, 
                          (*isoVector)[j]->GetN());
        temp[j] = sum;
      }
      sum *= q;
      for (j = 0; j<nIso; ++j) {
        if(temp[j] >= sum) {
          iso = (*isoVector)[j];
          break;
    }
      }
    }
  }
  return iso;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

amax

const G4int G4NeutronCaptureXS::amax

staticprivate

Initial value:

= {
  0,
  0, 0, 7, 0,11,13,15,18, 0, 0, 
  0, 0, 0,30, 0, 0, 0,40, 0,48, 
  0, 0, 0, 0, 0,58, 0,64,65,70, 
  0,76, 0, 0, 0, 0, 0, 0, 0,96, 
  0, 0, 0, 0, 0, 0,109,116, 0,124, 
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 
  0, 0, 0,186, 0, 0, 0, 0, 0, 0, 
  0,208, 0, 0, 0, 0, 0, 0, 0, 0, 
  0,238}

Definition at line 116 of file G4NeutronCaptureXS.hh.

amin

const G4int G4NeutronCaptureXS::amin

staticprivate

Initial value:

= {
  0,
  0, 0, 6, 0,10,12,14,16, 0, 0, 
  0, 0, 0,28, 0, 0, 0,36, 0,40, 
  0, 0, 0, 0, 0,54, 0,58,63,64, 
  0,70, 0, 0, 0, 0, 0, 0, 0,90, 
  0, 0, 0, 0, 0, 0,107,106, 0,112, 
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 
  0, 0, 0,180, 0, 0, 0, 0, 0, 0, 
  0,204, 0, 0, 0, 0, 0, 0, 0, 0, 
  0,235}

Definition at line 115 of file G4NeutronCaptureXS.hh.

data

G4ElementData * G4NeutronCaptureXS::data = 0

staticprivate

Definition at line 112 of file G4NeutronCaptureXS.hh.

elimit

G4double G4NeutronCaptureXS::elimit

private

Definition at line 108 of file G4NeutronCaptureXS.hh.

emax

G4double G4NeutronCaptureXS::emax

private

Definition at line 107 of file G4NeutronCaptureXS.hh.

isMaster

G4bool G4NeutronCaptureXS::isMaster

private

Definition at line 110 of file G4NeutronCaptureXS.hh.

temp

std::vector<G4double> G4NeutronCaptureXS::temp

private

Definition at line 113 of file G4NeutronCaptureXS.hh.

---

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

• G4NeutronCaptureXS.hh
• G4NeutronCaptureXS.cc