G4NuclideTable Class Reference

#include <G4NuclideTable.hh>

Inheritance diagram for G4NuclideTable:

Public Types
using	G4IsotopeList = std::vector<G4IsotopeProperty*>

Public Member Functions
	~G4NuclideTable () override
	G4NuclideTable (const G4NuclideTable &)=delete
G4NuclideTable &	operator= (const G4NuclideTable &)=delete
void	GenerateNuclide ()
void	SetThresholdOfHalfLife (G4double)
G4double	GetThresholdOfHalfLife ()
void	SetMeanLifeThreshold (G4double)
G4double	GetMeanLifeThreshold ()
void	SetLevelTolerance (G4double x)
G4double	GetLevelTolerance ()
void	AddState (G4int, G4int, G4double, G4double, G4int ionJ=0, G4double ionMu=0.0)
void	AddState (G4int, G4int, G4double, G4int, G4double, G4int ionJ=0, G4double ionMu=0.0)
void	AddState (G4int, G4int, G4double, G4Ions::G4FloatLevelBase, G4double, G4int ionJ=0, G4double ionMu=0.0)
std::size_t	GetSizeOfIsotopeList ()
G4IsotopeProperty *	GetIsotope (G4int Z, G4int A, G4double E, G4Ions::G4FloatLevelBase flb=G4Ions::G4FloatLevelBase::no_Float) override
G4IsotopeProperty *	GetIsotopeByIsoLvl (G4int Z, G4int A, G4int lvl=0) override
std::size_t	entries () const
G4IsotopeProperty *	GetIsotopeByIndex (std::size_t idx) const
Public Member Functions inherited from G4VIsotopeTable
	G4VIsotopeTable ()=default
	G4VIsotopeTable (const G4String &)
	G4VIsotopeTable (const G4VIsotopeTable &)=default
G4VIsotopeTable &	operator= (const G4VIsotopeTable &)
virtual	~G4VIsotopeTable ()=default
G4int	GetVerboseLevel () const
void	SetVerboseLevel (G4int level)
void	DumpTable (G4int Zmin=1, G4int Zmax=118)
const G4String &	GetName () const

Static Public Member Functions
static G4NuclideTable *	GetInstance ()
static G4NuclideTable *	GetNuclideTable ()
static G4double	GetTruncationError (G4double eex)
static G4double	Round (G4double eex)
static G4long	Truncate (G4double eex)
static G4double	Tolerance ()

Detailed Description

Definition at line 52 of file G4NuclideTable.hh.

Member Typedef Documentation

G4IsotopeList

using G4NuclideTable::G4IsotopeList = std::vector<G4IsotopeProperty*>

Definition at line 55 of file G4NuclideTable.hh.

Constructor & Destructor Documentation

~G4NuclideTable()

G4NuclideTable::~G4NuclideTable ( )

override

Definition at line 63 of file G4NuclideTable.cc.

{
  for (auto& it : map_pre_load_list) {
    it.second.clear();
  }
  map_pre_load_list.clear();
 
  for (auto& it : map_full_list) {
    it.second.clear();
  }
  map_full_list.clear();
 
  if (fIsotopeList != nullptr) {
    for (const auto& i : *fIsotopeList) {
      delete i;
    }
    fIsotopeList->clear();
    delete fIsotopeList;
    fIsotopeList = nullptr;
  }
  delete fMessenger;
}

G4NuclideTable()

G4NuclideTable::G4NuclideTable ( const G4NuclideTable & )

delete

Member Function Documentation

AddState() [1/3]

void G4NuclideTable::AddState	(	G4int	ionZ,
		G4int	ionA,
		G4double	ionE,
		G4double	ionLife,
		G4int	ionJ = 0,
		G4double	ionMu = 0.0 )

Definition at line 276 of file G4NuclideTable.cc.

{
  if (G4Threading::IsMasterThread()) {
    G4int flbIndex = 0;
    ionE = StripFloatLevelBase(ionE, flbIndex);
    AddState(ionZ, ionA, ionE, flbIndex, ionLife, ionJ, ionMu);
  }
}

Referenced by AddState().

AddState() [2/3]

void G4NuclideTable::AddState	(	G4int	ionZ,
		G4int	ionA,
		G4double	ionE,
		G4int	flbIndex,
		G4double	ionLife,
		G4int	ionJ = 0,
		G4double	ionMu = 0.0 )

Definition at line 286 of file G4NuclideTable.cc.

{
  if (G4Threading::IsMasterThread()) {
    if (fUserDefinedList == nullptr) fUserDefinedList = new G4IsotopeList();
 
    auto fProperty = new G4IsotopeProperty();
 
    // Set Isotope Property
    fProperty->SetAtomicNumber(ionZ);
    fProperty->SetAtomicMass(ionA);
    fProperty->SetIsomerLevel(9);
    fProperty->SetEnergy(ionE);
    fProperty->SetiSpin(ionJ);
    fProperty->SetLifeTime(ionLife);
    fProperty->SetDecayTable(nullptr);
    fProperty->SetMagneticMoment(ionMu);
    fProperty->SetFloatLevelBase(flbIndex);
 
    fUserDefinedList->push_back(fProperty);
    fIsotopeList->push_back(fProperty);
  }
}

AddState() [3/3]

void G4NuclideTable::AddState	(	G4int	ionZ,
		G4int	ionA,
		G4double	ionE,
		G4Ions::G4FloatLevelBase	flb,
		G4double	ionLife,
		G4int	ionJ = 0,
		G4double	ionMu = 0.0 )

Definition at line 310 of file G4NuclideTable.cc.

{
  if (G4Threading::IsMasterThread()) {
    if (fUserDefinedList == nullptr) fUserDefinedList = new G4IsotopeList();
 
    auto fProperty = new G4IsotopeProperty();
 
    // Set Isotope Property
    fProperty->SetAtomicNumber(ionZ);
    fProperty->SetAtomicMass(ionA);
    fProperty->SetIsomerLevel(9);
    fProperty->SetEnergy(ionE);
    fProperty->SetiSpin(ionJ);
    fProperty->SetLifeTime(ionLife);
    fProperty->SetDecayTable(nullptr);
    fProperty->SetMagneticMoment(ionMu);
    fProperty->SetFloatLevelBase(flb);
 
    fUserDefinedList->push_back(fProperty);
    fIsotopeList->push_back(fProperty);
  }
}

entries()

std::size_t G4NuclideTable::entries ( ) const

inline

Definition at line 176 of file G4NuclideTable.hh.

{
  return (fIsotopeList != nullptr ? fIsotopeList->size() : std::size_t(0));
}

Referenced by G4IonTable::PreloadNuclide().

GenerateNuclide()

void G4NuclideTable::GenerateNuclide

(

)

Definition at line 161 of file G4NuclideTable.cc.

{
  if (mean_life_threshold < minimum_mean_life_threshold) {
    // Need to update full list
    const char* path = G4FindDataDir("G4ENSDFSTATEDATA");
 
    if (path == nullptr) {
      G4Exception("G4NuclideTable", "PART70000", FatalException,
                  "G4ENSDFSTATEDATA environment variable must be set");
      return;
    }
 
    std::ifstream ifs;
    G4String filename(path);
    filename += "/ENSDFSTATE.dat";
 
    ifs.open(filename.c_str());
    if (!ifs.good()) {
      G4Exception("G4NuclideTable", "PART70001", FatalException, "ENSDFSTATE.dat is not found.");
      return;
    }
 
    G4int ionCode = 0;
    G4int iLevel = 0;
    G4int ionZ;
    G4int ionA;
    G4double ionE;
    G4String ionFL;
    G4double ionLife;
    G4int ionJ;
    G4double ionMu;
 
    // Lifetimes read from ENSDFSTATE are mean lives
    ifs >> ionZ >> ionA >> ionE >> ionFL >> ionLife >> ionJ >> ionMu;
 
    while (ifs.good())  // Loop checking, 09.08.2015, K.Kurashige
    {
      if (ionCode != 1000 * ionZ + ionA) {
        iLevel = 0;
        ionCode = 1000 * ionZ + ionA;
      }
 
      ionE *= keV;
      G4Ions::G4FloatLevelBase flb = StripFloatLevelBase(ionFL);
      ionLife *= ns;
      ionMu *= (joule / tesla);
 
      if ((ionE == 0 && flb == G4Ions::G4FloatLevelBase::no_Float)
          || (mean_life_threshold <= ionLife && ionLife < minimum_mean_life_threshold))
      {
        if (ionE > 0) ++iLevel;
        if (iLevel > 9) iLevel = 9;
 
        auto fProperty = new G4IsotopeProperty();
 
        // Set Isotope Property
        fProperty->SetAtomicNumber(ionZ);
        fProperty->SetAtomicMass(ionA);
        fProperty->SetIsomerLevel(iLevel);
        fProperty->SetEnergy(ionE);
        fProperty->SetiSpin(ionJ);
        fProperty->SetLifeTime(ionLife);
        fProperty->SetDecayTable(nullptr);
        fProperty->SetMagneticMoment(ionMu);
        fProperty->SetFloatLevelBase(flb);
 
        fIsotopeList->push_back(fProperty);
 
        auto itf = map_full_list.find(ionCode);
        if (itf == map_full_list.cend()) {
          std::multimap<G4double, G4IsotopeProperty*> aMultiMap;
          itf = (map_full_list.insert(std::pair<G4int, std::multimap<G4double, G4IsotopeProperty*>>(
                   ionCode, aMultiMap)))
                  .first;
        }
        itf->second.insert(std::pair<G4double, G4IsotopeProperty*>(ionE, fProperty));
      }
 
      ifs >> ionZ >> ionA >> ionE >> ionFL >> ionLife >> ionJ >> ionMu;
    }  // End while
 
    minimum_mean_life_threshold = mean_life_threshold;
  }
 
  // Clear current map
  for (auto& it : map_pre_load_list) {
    it.second.clear();
  }
  map_pre_load_list.clear();
 
  // Build map based on current threshold value
  for (const auto& it : map_full_list) {
    G4int ionCode = it.first;
    auto itf = map_pre_load_list.find(ionCode);
    if (itf == map_pre_load_list.cend()) {
      std::multimap<G4double, G4IsotopeProperty*> aMultiMap;
      itf = (map_pre_load_list.insert(
               std::pair<G4int, std::multimap<G4double, G4IsotopeProperty*>>(ionCode, aMultiMap)))
              .first;
    }
 
    G4int iLevel = 0;
    for (const auto& itt : it.second) {
      G4double exEnergy = itt.first;
      G4double meanLife = itt.second->GetLifeTime();
      if (exEnergy == 0.0 || meanLife > mean_life_threshold) {
        if (itt.first != 0.0) ++iLevel;
        if (iLevel > 9) iLevel = 9;
        itt.second->SetIsomerLevel(iLevel);
        itf->second.insert(std::pair<G4double, G4IsotopeProperty*>(exEnergy, itt.second));
      }
    }
  }
}

Referenced by G4IonTable::PreloadNuclide(), SetMeanLifeThreshold(), and SetThresholdOfHalfLife().

GetInstance()

G4NuclideTable * G4NuclideTable::GetInstance ( )

static

Definition at line 44 of file G4NuclideTable.cc.

{
  static G4NuclideTable instance;
  return &instance;
}

Referenced by LBE::ConstructGeneral(), G4RadioactiveDecayPhysics::G4RadioactiveDecayPhysics(), GetNuclideTable(), GetTruncationError(), Round(), G4RadioactiveDecay::StreamInfo(), Tolerance(), and Truncate().

GetIsotope()

G4IsotopeProperty * G4NuclideTable::GetIsotope ( G4int Z, G4int A, G4double E, G4Ions::G4FloatLevelBase flb = G4Ions::G4FloatLevelBase::no_Float )

overridevirtual

Implements G4VIsotopeTable.

Definition at line 86 of file G4NuclideTable.cc.

{
  G4IsotopeProperty* fProperty = nullptr;
 
  // At first searching UserDefined
  if (fUserDefinedList != nullptr) {
    for (const auto it : *fUserDefinedList) {
      if (Z == it->GetAtomicNumber() && A == it->GetAtomicMass()) {
        G4double levelE = it->GetEnergy();
        if (levelE - flevelTolerance / 2 <= E && E < levelE + flevelTolerance / 2) {
          if (flb == it->GetFloatLevelBase()) {
            return it;
          }  // found
        }
      }
    }
  }
 
  // Searching pre-load
  // Note: isomer level is properly set only for pre_load_list
  //
  G4int ionCode = 1000 * Z + A;
  auto itf = map_pre_load_list.find(ionCode);
 
  if (itf != map_pre_load_list.cend()) {
    auto lower_bound_itr = itf->second.lower_bound(E - flevelTolerance / 2);
    G4double levelE = DBL_MAX;
 
    while (lower_bound_itr != itf->second.cend()) {
      levelE = lower_bound_itr->first;
      if (levelE - flevelTolerance / 2 <= E && E < levelE + flevelTolerance / 2) {
        if (flb == (lower_bound_itr->second)->GetFloatLevelBase() || E == 0.0) {
          return lower_bound_itr->second;  // found
        }
      }
      else {
        break;
      }
      ++lower_bound_itr;
    }
  }
 
  return fProperty;  // not found
}

Referenced by GetIsotopeByIsoLvl().

GetIsotopeByIndex()

G4IsotopeProperty * G4NuclideTable::GetIsotopeByIndex ( std::size_t idx ) const

inline

Definition at line 181 of file G4NuclideTable.hh.

{
  if ((fIsotopeList != nullptr) && idx < fIsotopeList->size()) return (*fIsotopeList)[idx];
  return nullptr;
}

Referenced by G4IonTable::PreloadNuclide().

GetIsotopeByIsoLvl()

G4IsotopeProperty * G4NuclideTable::GetIsotopeByIsoLvl ( G4int Z, G4int A, G4int lvl = 0 )

overridevirtual

Reimplemented from G4VIsotopeTable.

Definition at line 155 of file G4NuclideTable.cc.

{
  if (lvl == 0) return GetIsotope(Z, A, 0.0);
  return nullptr;
}

GetLevelTolerance()

G4double G4NuclideTable::GetLevelTolerance ( )

inline

Definition at line 166 of file G4NuclideTable.hh.

{
  return flevelTolerance;
}

Referenced by G4IonTable::FindIon(), G4IonTable::FindIon(), G4IonTable::FindIonInMaster(), G4IonTable::FindIonInMaster(), GetTruncationError(), Round(), Tolerance(), and Truncate().

GetMeanLifeThreshold()

G4double G4NuclideTable::GetMeanLifeThreshold ( )

inline

Definition at line 156 of file G4NuclideTable.hh.

{
  return mean_life_threshold;
}

Referenced by G4RadioactiveDecay::StreamInfo().

GetNuclideTable()

G4NuclideTable * G4NuclideTable::GetNuclideTable ( )

static

Definition at line 50 of file G4NuclideTable.cc.

{
  return GetInstance();
}

Referenced by G4IonTable::DestroyWorkerG4IonTable(), G4IonTable::PrepareNuclideTable(), and G4IonTable::~G4IonTable().

GetSizeOfIsotopeList()

std::size_t G4NuclideTable::GetSizeOfIsotopeList ( )

inline

Definition at line 171 of file G4NuclideTable.hh.

{
  return (fIsotopeList != nullptr ? fIsotopeList->size() : static_cast<size_t>(0));
}

GetThresholdOfHalfLife()

G4double G4NuclideTable::GetThresholdOfHalfLife ( )

inline

Definition at line 151 of file G4NuclideTable.hh.

{
  return mean_life_threshold * 0.69314718;
}

GetTruncationError()

G4double G4NuclideTable::GetTruncationError ( G4double eex )

static

Definition at line 132 of file G4NuclideTable.cc.

{
  G4double tolerance = G4NuclideTable::GetInstance()->GetLevelTolerance();
  return eex - (G4long)(eex / tolerance) * tolerance;
}

operator=()

G4NuclideTable & G4NuclideTable::operator= ( const G4NuclideTable & )

delete

Round()

G4double G4NuclideTable::Round ( G4double eex )

static

Definition at line 138 of file G4NuclideTable.cc.

{
  G4double tolerance = G4NuclideTable::GetInstance()->GetLevelTolerance();
  return round(eex / tolerance) * tolerance;
}

SetLevelTolerance()

void G4NuclideTable::SetLevelTolerance ( G4double x )

inline

Definition at line 161 of file G4NuclideTable.hh.

{
  flevelTolerance = x;
}

Referenced by G4NuclideTableMessenger::SetNewValue().

SetMeanLifeThreshold()

void G4NuclideTable::SetMeanLifeThreshold

(

G4double

t

)

Definition at line 345 of file G4NuclideTable.cc.

{
  if (G4Threading::IsMasterThread()) {
    mean_life_threshold = t;
    GenerateNuclide();
  }
}

Referenced by G4NuclideTableMessenger::SetNewValue().

SetThresholdOfHalfLife()

void G4NuclideTable::SetThresholdOfHalfLife

(

G4double

t

)

Definition at line 334 of file G4NuclideTable.cc.

{
  if (G4Threading::IsMasterThread()) {
    mean_life_threshold = t / 0.69314718;
    GenerateNuclide();
  }
}

Referenced by G4NuclideTableMessenger::SetNewValue().

Tolerance()

G4double G4NuclideTable::Tolerance ( )

static

Definition at line 150 of file G4NuclideTable.cc.

{
  return G4NuclideTable::GetInstance()->GetLevelTolerance();
}

Truncate()

G4long G4NuclideTable::Truncate ( G4double eex )

static

Definition at line 144 of file G4NuclideTable.cc.

{
  G4double tolerance = G4NuclideTable::GetInstance()->GetLevelTolerance();
  return (G4long)(eex / tolerance);
}

---

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

• G4NuclideTable.hh
• G4NuclideTable.cc