genie::NaturalIsotopes Class Reference

Singleton class to load & serve tables of natural occurring isotopes. More...

#include <NaturalIsotopes.h>

Collaboration diagram for genie::NaturalIsotopes:

Classes
struct	Cleaner

Public Member Functions
int	NElements (int Z) const
const NaturalIsotopeElementData *	ElementData (int Z, int ielement) const
const NaturalIsotopeElementData *	ElementDataPdg (int Z, int pdgcode) const

Static Public Member Functions
static NaturalIsotopes *	Instance (void)

Private Member Functions
	NaturalIsotopes ()
	NaturalIsotopes (const NaturalIsotopes &)
virtual	~NaturalIsotopes ()
bool	LoadTable (void)

Private Attributes
map< int, vector< NaturalIsotopeElementData * > >	fNaturalIsotopesTable

Static Private Attributes
static NaturalIsotopes *	fInstance = 0

Friends
struct	Cleaner

Detailed Description

Singleton class to load & serve tables of natural occurring isotopes.

Author

Costas Andreopoulos <c.andreopoulos \at cern.ch> University of Liverpool

  Jim Dobson <j.dobson07@imperial.ac.uk>

Imperial College London

Created:\n May 30, 2008

License:\n Copyright (c) 2003-2025, The GENIE Collaboration

For the full text of the license visit http://copyright.genie-mc.org

Definition at line 33 of file NaturalIsotopes.h.

Constructor & Destructor Documentation

NaturalIsotopes() [1/2]

NaturalIsotopes::NaturalIsotopes ( )

private

Definition at line 31 of file NaturalIsotopes.cxx.

{
  if( ! this->LoadTable() ) {
     LOG("NatIsotop", pERROR) << "NaturalIsotopes initialization failed!";
  }
  fInstance =  0;
}

References fInstance, LoadTable(), LOG, and pERROR.

Referenced by Instance(), and NaturalIsotopes().

NaturalIsotopes() [2/2]

genie::NaturalIsotopes::NaturalIsotopes ( const NaturalIsotopes & )

private

References NaturalIsotopes().

~NaturalIsotopes()

NaturalIsotopes::~NaturalIsotopes ( )

privatevirtual

Definition at line 39 of file NaturalIsotopes.cxx.

{
  cout << "NaturalIsotopes singleton dtor: "
       << "Deleting natural isotope data tables" << endl;
 
  map<int, vector<NaturalIsotopeElementData*> >::iterator miter;
  vector<NaturalIsotopeElementData*>::iterator viter;
 
  for(miter = fNaturalIsotopesTable.begin();
                 miter != fNaturalIsotopesTable.end(); ++miter) {
     vector<NaturalIsotopeElementData*> vec = miter->second;
     for(viter = vec.begin(); viter != vec.end(); ++viter) {
        NaturalIsotopeElementData * element_data = *viter;
        if(element_data) {
            delete element_data;
            element_data = 0;
        }
     }
     vec.clear();
  }
  fNaturalIsotopesTable.clear();
  fInstance = 0;
}

References fInstance, and fNaturalIsotopesTable.

Member Function Documentation

ElementData()

const NaturalIsotopeElementData * NaturalIsotopes::ElementData	(	int	Z,
		int	ielement ) const

Definition at line 90 of file NaturalIsotopes.cxx.

{
  map<int, vector<NaturalIsotopeElementData*> >::const_iterator miter;
 
  if( (miter=fNaturalIsotopesTable.find(Z)) == fNaturalIsotopesTable.end()) {
    LOG("NatIsotop", pWARN)
       << "Table has no elements for natural isotope  Z = " << Z;
    return 0;
  }
  vector<NaturalIsotopeElementData*> vec = miter->second;
  if(ielement >= (int)vec.size() || ielement < 0) {
    LOG("NatIsotop", pWARN)
      << "Natural isotope Z = " << Z << " has " << vec.size() << " elements"
      << " (element = " << ielement << " was requested)";
    return 0;
  }
  return vec[ielement];
}

References fNaturalIsotopesTable, LOG, and pWARN.

Referenced by main().

ElementDataPdg()

const NaturalIsotopeElementData * NaturalIsotopes::ElementDataPdg	(	int	Z,
		int	pdgcode ) const

Definition at line 110 of file NaturalIsotopes.cxx.

{
  map<int, vector<NaturalIsotopeElementData*> >::const_iterator miter;
 
  if( (miter=fNaturalIsotopesTable.find(Z)) == fNaturalIsotopesTable.end()) {
    LOG("NatIsotop", pWARN)  
       << "Table has no elements for natural isotope  Z = " << Z;
    return 0;
  }
  
  vector<NaturalIsotopeElementData*> vec = miter->second;
  for (int i; i<vec.size(); i++) {
    if (vec[i]->PdgCode()==pdgcode) return vec[i];
  }
 
  LOG("NatIsotop", pWARN) 
    << "Natural isotope Z = " << Z << " has " << vec.size() << " elements"
    << " (pdgcode = " << pdgcode << " was requested)";
  return 0;
 
}

References fNaturalIsotopesTable, LOG, and pWARN.

Instance()

NaturalIsotopes * NaturalIsotopes::Instance ( void )

static

Definition at line 63 of file NaturalIsotopes.cxx.

{
  if(fInstance == 0) {
    LOG("NatIsotop", pINFO) << "NaturalIsotopes late initialization";
 
    static NaturalIsotopes::Cleaner cleaner;
    cleaner.DummyMethodAndSilentCompiler();
 
    fInstance = new NaturalIsotopes;
  }
  return fInstance;
}

References genie::NaturalIsotopes::Cleaner::DummyMethodAndSilentCompiler(), fInstance, LOG, NaturalIsotopes(), and pINFO.

Referenced by main().

LoadTable()

bool NaturalIsotopes::LoadTable ( void )

private

eof

Definition at line 132 of file NaturalIsotopes.cxx.

{
  // get the natural isotopes table filename
  string filename = string(gSystem->Getenv("GENIE")) +
                    string("/data/evgen/catalogues/iso/natural-isotopes.data");
 
  LOG("NatIsotop", pINFO)
    << "Loading natural occurring isotope table from file: " << filename;
 
  bool is_accessible = ! (gSystem->AccessPathName( filename.c_str() ));
  if (!is_accessible) {
     LOG("NatIsotop", pWARN) << "Can not read file: " << filename;
     return false;
  }
 
  // load the natural isotopes .txt file
  string input_buf;
  std::ifstream input(filename.c_str());
  if (input.is_open()){
 
    //skip first 8 lines (comments)
    for(int i=0; i<8; i++){
      string buffer;
      getline(input, buffer);
    }
 
    int Z = -1, Z_previous = -1, nelements = 0, pdgcode = 0;
    double atomicmass = 0, abundance = 0;
    string elementname, subelementname;
 
    while( !input.eof() ) {
 
      //read in naturally occuring element info
      input >> Z;
      input >> elementname;
      input >> nelements;
 
      vector<NaturalIsotopeElementData *> vec;
      NaturalIsotopeElementData * data = 0;
 
      // check not re-reading same element
      if(Z!=Z_previous){
        LOG("NatIsotop", pDEBUG) << "Reading entry for Z = " << Z;
        for(int n=0 ; n < nelements; n++){
          input >> subelementname;
          input >> pdgcode;
          input >> atomicmass;
          input >> abundance;
          LOG("NatIsotop", pDEBUG)
            << " - Element: " << n << ", pdg = " << pdgcode
            << ", A = " << atomicmass << ", abundance = " << abundance;
          data = new NaturalIsotopeElementData(pdgcode, abundance,atomicmass);
          vec.push_back(data);
        }
        fNaturalIsotopesTable.insert(
           map<int,vector<NaturalIsotopeElementData*> >::value_type(Z,vec));
      }
      Z_previous = Z;
    } //!eof
 
  } else {
    return false;
  } //open?
 
  return true;
}

References fNaturalIsotopesTable, LOG, pDEBUG, pINFO, and pWARN.

Referenced by NaturalIsotopes().

NElements()

int NaturalIsotopes::NElements

(

int

Z

)

const

Definition at line 76 of file NaturalIsotopes.cxx.

{
  map<int, vector<NaturalIsotopeElementData*> >::const_iterator miter;
 
  if( (miter=fNaturalIsotopesTable.find(Z)) == fNaturalIsotopesTable.end()) {
    LOG("NatIsotop", pWARN)
       << "Table has no elements for natural isotope  Z = " << Z;
    return 0;
  }
  vector<NaturalIsotopeElementData*> vec = miter->second;
  return vec.size();
}

References fNaturalIsotopesTable, LOG, and pWARN.

Referenced by main().

Friends And Related Symbol Documentation

Cleaner

friend struct Cleaner

friend

Definition at line 62 of file NaturalIsotopes.h.

Member Data Documentation

fInstance

NaturalIsotopes * NaturalIsotopes::fInstance = 0

staticprivate

Definition at line 49 of file NaturalIsotopes.h.

Referenced by Instance(), NaturalIsotopes(), genie::NaturalIsotopes::Cleaner::~Cleaner(), and ~NaturalIsotopes().

fNaturalIsotopesTable

map<int, vector<NaturalIsotopeElementData*> > genie::NaturalIsotopes::fNaturalIsotopesTable

private

Definition at line 51 of file NaturalIsotopes.h.

Referenced by ElementData(), ElementDataPdg(), LoadTable(), NElements(), and ~NaturalIsotopes().

---

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

• NaturalIsotopes.h
• NaturalIsotopes.cxx