lars/geant4
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
b4a16de652ec244f7a0ecc0a5cacfee21930bf75
geant4/source/particles/management/include/G4IonTable.hh
T
Gabriele Cosmo 860a2b92bf Import Geant4 11.2.0 source tree
2023-12-08 10:43:34 +01:00

312 lines
13 KiB
C++
Raw Blame History

//
// ********************************************************************
// * License and Disclaimer *
// * *
// * The Geant4 software is copyright of the Copyright Holders of *
// * the Geant4 Collaboration. It is provided under the terms and *
// * conditions of the Geant4 Software License, included in the file *
// * LICENSE and available at http://cern.ch/geant4/license . These *
// * include a list of copyright holders. *
// * *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work make any representation or warranty, express or implied, *
// * regarding this software system or assume any liability for its *
// * use. Please see the license in the file LICENSE and URL above *
// * for the full disclaimer and the limitation of liability. *
// * *
// * This code implementation is the result of the scientific and *
// * technical work of the GEANT4 collaboration. *
// * By using, copying, modifying or distributing the software (or *
// * any work based on the software) you agree to acknowledge its *
// * use in resulting scientific publications, and indicate your *
// * acceptance of all terms of the Geant4 Software license. *
// ********************************************************************
//
// G4IonTable
//
// Class description:
//
// G4IonTable stores all pointers to G4ParticleDefinition.
// Author: H.Kurashige, 27 June 1998
// --------------------------------------------------------------------
#ifndef G4IonTable_hh
#define G4IonTable_hh 1
#include "G4Ions.hh"
#include "G4ParticleDefinition.hh"
#include "G4ParticleTable.hh"
#include "G4ios.hh"
#include "globals.hh"
#include <cmath>
#include <map>
#include <vector>
class G4ParticleTable;
class G4VIsotopeTable;
class G4IsotopeProperty;
class G4NuclideTable;
class G4IonTable
{
public:
using G4IonList = std::multimap<G4int, const G4ParticleDefinition*>;
using G4IonListIterator = std::multimap<G4int, const G4ParticleDefinition*>::iterator;
// Constructor, destructor
G4IonTable();
~G4IonTable();
// Forbidden copy constructor and assignment operator
G4IonTable(const G4IonTable&) = delete;
G4IonTable& operator=(const G4IonTable&) = delete;
static G4IonTable* GetIonTable();
// Method is used by each worker thread to copy the content
// from the master thread.
void WorkerG4IonTable();
// Destructor for worker
void DestroyWorkerG4IonTable();
// Get number of elements defined in the IonTable
G4int GetNumberOfElements() const;
// Register Isotope table
void RegisterIsotopeTable(G4VIsotopeTable* table);
// G4IonTable asks properties of isotopes to G4VIsotopeTable
// by using FindIsotope(G4IsotopeProperty* property) method
G4VIsotopeTable* GetIsotopeTable(std::size_t idx = 0) const;
// All ground state ions are created.
// Stable ground states are defined in G4NuclearProperty
void CreateAllIon();
// All excited ions with long life time (>1.0*ns) are created.
// Isomers are defined in G4VIsotopeTable
void CreateAllIsomer();
// All nuclide with a life time longer than certain value are created
// prior to the event loop
void PrepareNuclideTable();
void PreloadNuclide();
// --------------------------------------------------------------
// FindIon/GetIon
// FindIon() methods return pointer of ion if it exists.
// GetIon() methods also return pointer of ion; the designated
// ion is created if it does not exist.
//
// !! PDGCharge in G4ParticleDefinition of ions is !!
// !! electric charge of nucleus (i.e. fully ionized ions) !!
// --------------------------------------------------------------
// Find/Get "ground state" and "excited state"
//
G4ParticleDefinition* GetIon(G4int Z, G4int A, G4int lvl = 0);
G4ParticleDefinition* GetIon(G4int Z, G4int A, G4int nL, G4int lvl);
G4ParticleDefinition* GetIon(G4int Z, G4int A, G4double E, G4int J = 0);
G4ParticleDefinition* GetIon(G4int Z, G4int A, G4double E, G4Ions::G4FloatLevelBase flb,
G4int J = 0);
G4ParticleDefinition* GetIon(G4int Z, G4int A, G4double E, char flbChar, G4int J = 0);
G4ParticleDefinition* GetIon(G4int Z, G4int A, G4int nL, G4double E, G4int J = 0);
G4ParticleDefinition* GetIon(G4int Z, G4int A, G4int nL, G4double E,
G4Ions::G4FloatLevelBase flb, G4int J = 0);
G4ParticleDefinition* GetIon(G4int Z, G4int A, G4int nL, G4double E, char flbChar, G4int J = 0);
// Z: Atomic Number
// A: Atomic Mass (nn + np +nlambda)
// nL: Number of Lambda
// E: Excitation energy
// lvl: Isomer Level 0: ground state)
// flb: Floating level base (enum defined in G4Ions.hh)
// flbChar: Floating level base denoted by a character
// (<null>,X,Y,Z,U,V,W,R,S,T,A,B,C,D,E)
// J: Total Angular momentum (in unit of 1/2) : not used
// The ion can be retrieved by using PDG encoding
// !! Only ground state can be obtained .i.e. Isomer = 0
G4ParticleDefinition* GetIon(G4int encoding);
// Find/Get "excited state"
//
G4ParticleDefinition* FindIon(G4int Z, G4int A, G4int lvl = 0);
G4ParticleDefinition* FindIon(G4int Z, G4int A, G4int nL, G4int lvl);
G4ParticleDefinition* FindIon(G4int Z, G4int A, G4double E, G4int J = 0);
G4ParticleDefinition* FindIon(G4int Z, G4int A, G4double E, G4Ions::G4FloatLevelBase flb,
G4int J = 0);
G4ParticleDefinition* FindIon(G4int Z, G4int A, G4double E, char flbChar, G4int J = 0);
G4ParticleDefinition* FindIon(G4int Z, G4int A, G4int nL, G4double E, G4int J = 0);
G4ParticleDefinition* FindIon(G4int Z, G4int A, G4int nL, G4double E,
G4Ions::G4FloatLevelBase flb, G4int J = 0);
G4ParticleDefinition* FindIon(G4int Z, G4int A, G4int nL, G4double E, char flbChar,
G4int J = 0);
// Z: Atomic Number
// A: Atomic Mass (nn + np +nlambda)
// nL: Number of Lambda
// E: Excitaion energy
// lvl: Isomer Level 0: ground state)
// flb: Floating level base (enum defined in G4Ions.hh)
// flbChar: Floating level base denoted by a character
// (<null>,X,Y,Z,U,V,W,R,S,T,A,B,C,D,E)
// J: Total Angular momentum (in unit of 1/2) : not used
// Return true if the particle is ion
static G4bool IsIon(const G4ParticleDefinition*);
// Return true if the particle is anti_ion
static G4bool IsAntiIon(const G4ParticleDefinition*);
// Get ion name
G4String GetIonName(G4int Z, G4int A, G4int lvl = 0) const;
G4String GetIonName(G4int Z, G4int A, G4double E,
G4Ions::G4FloatLevelBase flb = G4Ions::G4FloatLevelBase::no_Float) const;
G4String GetIonName(G4int Z, G4int A, G4int nL, G4double E,
G4Ions::G4FloatLevelBase flb = G4Ions::G4FloatLevelBase::no_Float) const;
G4String GetIonName(G4int Z, G4int A, G4int nL, G4int lvl) const;
// Get PDG code for Ions.
// Nuclear codes are given as 10-digit numbers +-100ZZZAAAI.
// For a nucleus consisting of np protons and nn neutrons
// A = np + nn and Z = np.
// I gives the isomer level, with I = 0 corresponding
// to the ground state and I >0 to excitations
static G4int GetNucleusEncoding(G4int Z, G4int A, G4double E = 0.0, G4int lvl = 0);
// Get PDG code for Hyper-Nucleus Ions.
// Nuclear codes are given as 10-digit numbers +-10LZZZAAAI.
// For a nucleus consisting of np protons and nn neutrons
// A = np + nn +nlambda and Z = np.
// nL = nlambda
// I gives the isomer level, with I = 0 corresponding
// to the ground state and I >0 to excitations
static G4int GetNucleusEncoding(G4int Z, G4int A, G4int nL, G4double E = 0.0, G4int lvl = 0);
static G4bool GetNucleusByEncoding(G4int encoding, G4int& Z, G4int& A, G4double& E, G4int& lvl);
static G4bool GetNucleusByEncoding(G4int encoding, G4int& Z, G4int& A, G4int& L, G4double& E,
G4int& lvl);
// Energy will not be given even for excited state!!
// These methods returns Nucleus (i.e. full ionized atom) mass, where
// Z is Atomic Number (number of protons) and
// A is Atomic Number (number of nucleons and hyperons)
// nL is number of lambda (A= nn + np + nlambda)
// lvl is isomer level
G4double GetIonMass(G4int Z, G4int A, G4int nL = 0, G4int lvl = 0) const;
G4double GetNucleusMass(G4int Z, G4int A, G4int nL = 0, G4int lvl = 0) const;
G4double GetIsomerMass(G4int Z, G4int A, G4int lvl = 0) const;
// Returns a life time of an ion. -1 for stable ion, and -1001 for ion
// that is not listed in G4NuclideTable
G4double GetLifeTime(const G4ParticleDefinition*) const;
G4double GetLifeTime(G4int Z, G4int A, G4double E,
G4Ions::G4FloatLevelBase flb = G4Ions::G4FloatLevelBase::no_Float) const;
G4double GetLifeTime(G4int Z, G4int A, G4double E, char flbChar) const;
G4ParticleDefinition* GetMuonicAtom(G4Ions const*);
G4ParticleDefinition* GetMuonicAtom(G4int Z, G4int A);
// Return number of ions in the table
G4int Entries() const;
// Return the pointer of index-th ion in the table
G4ParticleDefinition* GetParticle(G4int index) const;
// Return 'true' if the ion exists
G4bool Contains(const G4ParticleDefinition* particle) const;
// Insert/Remove an ion in the table
void Insert(const G4ParticleDefinition* particle);
void Remove(const G4ParticleDefinition* particle);
// Erase all contents in the list (not delete just remove)
void clear();
// Return number of ions in the table
G4int size() const;
// Dump information of particles specified by name
void DumpTable(const G4String& particle_name = "ALL") const;
public:
// Needed for MT
void InitializeLightIons();
// It is very important for multithreaded Geant4 to keep only one copy of
// the particle table pointer and the ion table pointer. However, we try
// to let each worker thread hold its own copy of the particle dictionary
// and the ion list. This implementation is equivalent to make the ion
// table thread private. The two shadow ponters are used by each worker
// thread to copy the content from the master thread
static G4ThreadLocal G4IonList* fIonList;
static G4ThreadLocal std::vector<G4VIsotopeTable*>* fIsotopeTableList;
static G4IonList* fIonListShadow;
static std::vector<G4VIsotopeTable*>* fIsotopeTableListShadow;
enum
{
numberOfElements = 118
};
static const G4String elementName[numberOfElements];
#ifdef G4MULTITHREADED
static G4Mutex ionTableMutex;
#endif
protected:
G4ParticleDefinition* FindIonInMaster(G4int Z, G4int A, G4int lvl = 0);
G4ParticleDefinition* FindIonInMaster(G4int Z, G4int A, G4int nL, G4int lvl);
G4ParticleDefinition* FindIonInMaster(G4int Z, G4int A, G4double E,
G4Ions::G4FloatLevelBase flb, G4int J = 0);
G4ParticleDefinition* FindIonInMaster(G4int Z, G4int A, G4int nL, G4double E,
G4Ions::G4FloatLevelBase flb, G4int J = 0);
G4ParticleDefinition* CreateIon(G4int Z, G4int A, G4double E, G4Ions::G4FloatLevelBase flb);
G4ParticleDefinition* CreateIon(G4int Z, G4int A, G4int nL, G4double E,
G4Ions::G4FloatLevelBase flb);
G4ParticleDefinition* CreateIon(G4int Z, G4int A, G4int lvl = 0);
G4ParticleDefinition* CreateIon(G4int Z, G4int A, G4int nL, G4int lvl);
void InsertWorker(const G4ParticleDefinition* particle);
// Create Ion
G4IsotopeProperty* FindIsotope(G4int Z, G4int A, G4double E,
G4Ions::G4FloatLevelBase flb) const;
G4IsotopeProperty* FindIsotope(G4int Z, G4int A, G4int lvl) const;
// Ask properties of isotopes
G4ParticleDefinition* GetLightIon(G4int Z, G4int A) const;
G4ParticleDefinition* GetLightAntiIon(G4int Z, G4int A) const;
// Return true if the particle is pre-defined ion
G4bool IsLightIon(const G4ParticleDefinition*) const;
G4bool IsLightAntiIon(const G4ParticleDefinition*) const;
// Add process manager to ions with name of 'ionName'
void AddProcessManager(G4ParticleDefinition*);
// Get Verbose Level defined in G4ParticleTable
G4int GetVerboseLevel() const;
private:
G4NuclideTable* pNuclideTable = nullptr;
// Isomer table and flag of creation
G4bool isIsomerCreated = false;
};
// ------------------------
// Inline methods
// ------------------------
inline G4int G4IonTable::GetNumberOfElements() const
{
return numberOfElements;
}
#endif
Reference in New Issue View Git Blame Copy Permalink