Geant4 Cross Reference |
>> 1 // This code implementation is the intellectual property of >> 2 // the GEANT4 collaboration. 1 // 3 // 2 // ******************************************* << 4 // By copying, distributing or modifying the Program (or any work 3 // * License and Disclaimer << 5 // based on the Program) you indicate your acceptance of this statement, 4 // * << 6 // and all its terms. 5 // * The Geant4 software is copyright of th << 7 // 6 // * the Geant4 Collaboration. It is provided << 8 // $Id: G4Element.hh,v 1.2.6.1.2.1 1999/12/07 20:49:15 gunter Exp $ 7 // * conditions of the Geant4 Software License << 9 // GEANT4 tag $Name: geant4-01-00 $ 8 // * LICENSE and available at http://cern.ch/ << 9 // * include a list of copyright holders. << 10 // * << 11 // * Neither the authors of this software syst << 12 // * institutes,nor the agencies providing fin << 13 // * work make any representation or warran << 14 // * regarding this software system or assum << 15 // * use. Please see the license in the file << 16 // * for the full disclaimer and the limitatio << 17 // * << 18 // * This code implementation is the result << 19 // * technical work of the GEANT4 collaboratio << 20 // * By using, copying, modifying or distri << 21 // * any work based on the software) you ag << 22 // * use in resulting scientific publicati << 23 // * acceptance of all terms of the Geant4 Sof << 24 // ******************************************* << 25 << 26 //-------------------------------------------- << 27 // 10 // 28 // ClassName: G4Element << 29 // 11 // 30 // Description: Contains element properties << 12 // ------------------- class G4Element ------------------- 31 // 13 // 32 // Class description: << 14 // Torre Wenaus, November 1995 33 // 15 // 34 // An element is a chemical element either dir 16 // An element is a chemical element either directly defined in terms of 35 // its characteristics: its name, symbol, << 17 // its charactaristics: its name, symbol, 36 // Z (effective atomic nu 18 // Z (effective atomic number) 37 // N (effective number of 19 // N (effective number of nucleons) 38 // A (effective mass of a 20 // A (effective mass of a mole) 39 // or in terms of a collection of constituent << 21 // or in terms of a collection of constituent isotopes with specified 40 // relative abundance (i.e. fraction of nb of << 22 // relative abundance (i.e. fraction of nb of atomes per volume). 41 // 23 // 42 // Quantities, with physical meaning or not, w << 24 // Quantities, with physical meaning or not, which are constant in a given 43 // element are computed and stored here as Der 25 // element are computed and stored here as Derived data members. 44 // 26 // 45 // The class contains as a private static memb 27 // The class contains as a private static member the table of defined 46 // elements (an ordered vector of elements). 28 // elements (an ordered vector of elements). 47 // 29 // 48 // Elements can be assembled singly or in mixt 30 // Elements can be assembled singly or in mixtures into materials used 49 // in volume definitions via the G4Material cl 31 // in volume definitions via the G4Material class. 50 // << 32 51 // It is strongly recommended do not delete G4 << 33 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... ....oooOO0OOooo.... 52 // user code. All G4Elements will be automatic << 53 // of Geant4 session << 54 34 55 // 09-07-96, new data members added by L.Urban 35 // 09-07-96, new data members added by L.Urban 56 // 17-01-97, aesthetic rearrangement, M.Maire 36 // 17-01-97, aesthetic rearrangement, M.Maire 57 // 20-01-97, Tsai formula for the rad length, 37 // 20-01-97, Tsai formula for the rad length, M.Maire 58 // 21-01-97, remove mixture flag, M.Maire 38 // 21-01-97, remove mixture flag, M.Maire 59 // 24-01-97, new data member: fTaul 39 // 24-01-97, new data member: fTaul 60 // new method: ComputeIonisationPara 40 // new method: ComputeIonisationPara, M.Maire 61 // 20-03-97, corrected initialization of point 41 // 20-03-97, corrected initialization of pointers, M.Maire 62 // 27-06-97, new function GetIsotope(int), M.M 42 // 27-06-97, new function GetIsotope(int), M.Maire 63 // 24-02-98, fWeightVector becomes fRelativeAb 43 // 24-02-98, fWeightVector becomes fRelativeAbundanceVector 64 // 27-04-98, atomic shell stuff, V. Grichine 44 // 27-04-98, atomic shell stuff, V. Grichine 65 // 09-07-98, Ionisation parameters removed fro 45 // 09-07-98, Ionisation parameters removed from the class, M.Maire 66 // 04-08-98, new method GetElement(elementName 46 // 04-08-98, new method GetElement(elementName), M.Maire 67 // 16-11-98, Subshell -> Shell, mma 47 // 16-11-98, Subshell -> Shell, mma 68 // 30-03-01, suppression of the warning messag << 48 69 // 17-07-01, migration to STL, M. Verderi << 49 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... ....oooOO0OOooo.... 70 // 13-09-01, stl migration. Suppression of the << 71 // 14-09-01, fCountUse: nb of materials which << 72 // 26-02-02, fIndexInTable renewed << 73 // 01-04-05, new data member fIndexZ to count << 74 // 17-10-06: Add Get/Set fNaturalAbundance (V. << 75 // 17.09.09, add fNbOfShellElectrons and metho << 76 50 77 #ifndef G4ELEMENT_HH 51 #ifndef G4ELEMENT_HH 78 #define G4ELEMENT_HH 1 << 52 #define G4ELEMENT_HH 79 53 80 #include "G4ElementTable.hh" << 81 #include "G4ElementVector.hh" << 82 #include "G4IonisParamElm.hh" << 83 #include "G4Isotope.hh" << 84 #include "G4IsotopeVector.hh" << 85 #include "G4ios.hh" 54 #include "G4ios.hh" >> 55 #include "g4rw/tpvector.h" >> 56 #include "g4rw/tpordvec.h" 86 #include "globals.hh" 57 #include "globals.hh" >> 58 #include "G4Isotope.hh" >> 59 #include "G4AtomicShells.hh" >> 60 #include "G4IonisParamElm.hh" 87 61 88 #include <vector> << 62 typedef G4RWTPtrVector<G4Isotope> G4IsotopeVector; 89 << 90 class G4Element << 91 { << 92 public: // with description << 93 // Constructor to Build an element directly; << 94 G4Element(const G4String& name, // its name << 95 const G4String& symbol, // its symbol << 96 G4double Zeff, // atomic number << 97 G4double Aeff); // mass of mole << 98 << 99 // Constructor to Build an element from isot << 100 G4Element(const G4String& name, // its name << 101 const G4String& symbol, // its symbol << 102 G4int nbIsotopes); // nb of isotopes << 103 << 104 virtual ~G4Element(); << 105 << 106 G4Element(G4Element&) = delete; << 107 const G4Element& operator=(const G4Element&) << 108 << 109 // Add an isotope to the element << 110 void AddIsotope(G4Isotope* isotope, // isot << 111 G4double RelativeAbundance); // fraction << 112 // atomes pe << 113 << 114 // Retrieval methods << 115 inline const G4String& GetName() const { ret << 116 inline const G4String& GetSymbol() const { r << 117 << 118 // Atomic number << 119 inline G4double GetZ() const { return fZeff; << 120 inline G4int GetZasInt() const { return fZ; << 121 << 122 // Atomic weight in atomic units << 123 inline G4double GetN() const { return fNeff; << 124 inline G4double GetAtomicMassAmu() const { r << 125 << 126 // Mass of a mole in Geant4 units for atoms << 127 inline G4double GetA() const { return fAeff; << 128 << 129 inline G4bool GetNaturalAbundanceFlag() cons << 130 << 131 inline void SetNaturalAbundanceFlag(G4bool); << 132 << 133 // the number of atomic shells in this eleme << 134 inline G4int GetNbOfAtomicShells() const { r << 135 << 136 // the binding energy of the shell, ground s << 137 G4double GetAtomicShell(G4int index) const; << 138 << 139 // the number of electrons at the shell, gro << 140 G4int GetNbOfShellElectrons(G4int index) con << 141 << 142 // number of isotopes constituing this eleme << 143 inline std::size_t GetNumberOfIsotopes() con << 144 << 145 // vector of pointers to isotopes constituin << 146 inline G4IsotopeVector* GetIsotopeVector() c << 147 << 148 // vector of relative abundance of each isot << 149 inline G4double* GetRelativeAbundanceVector( << 150 << 151 inline const G4Isotope* GetIsotope(G4int iso << 152 << 153 // the (static) Table of Elements: << 154 static const G4ElementTable* GetElementTable << 155 << 156 static std::size_t GetNumberOfElements(); << 157 << 158 // the index of this element in the Table: << 159 inline std::size_t GetIndex() const { return << 160 << 161 // return pointer to an element, given its n << 162 static G4Element* GetElement(const G4String& << 163 << 164 // Coulomb correction factor: << 165 inline G4double GetfCoulomb() const { return << 166 << 167 // Tsai formula for the radiation length: << 168 inline G4double GetfRadTsai() const { return << 169 63 170 // pointer to ionisation parameters: << 64 class G4Element; //forward declaration 171 inline G4IonisParamElm* GetIonisation() cons << 65 typedef G4RWTPtrOrderedVector<G4Element> G4ElementTable; 172 66 173 // printing methods << 174 friend std::ostream& operator<<(std::ostream << 175 friend std::ostream& operator<<(std::ostream << 176 friend std::ostream& operator<<(std::ostream << 177 friend std::ostream& operator<<(std::ostream << 178 67 179 inline void SetName(const G4String& name) { << 68 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... ....oooOO0OOooo.... 180 69 181 G4bool operator==(const G4Element&) const = << 70 class G4Element 182 G4bool operator!=(const G4Element&) const = << 71 { >> 72 public: 183 73 184 private: << 74 // 185 void InitializePointers(); << 75 // Constructor to Build an element directly; no reference to isotopes 186 void ComputeDerivedQuantities(); << 76 // 187 void ComputeCoulombFactor(); << 77 G4Element(const G4String& name, //its name 188 void ComputeLradTsaiFactor(); << 78 const G4String& symbol, //its symbol 189 void AddNaturalIsotopes(); << 79 G4double Zeff, //atomic number >> 80 G4double Aeff); //mass of mole >> 81 >> 82 // >> 83 // Constructor to Build an element from isotopes via AddIsotope >> 84 // >> 85 G4Element(const G4String& name, //its name >> 86 const G4String& symbol, //its symbol >> 87 G4int nbIsotopes); //nb of isotopes >> 88 >> 89 // >> 90 // Add an isotope to the element >> 91 // >> 92 void AddIsotope(G4Isotope* isotope, //isotope >> 93 G4double RelativeAbundance); //fraction of nb of >> 94 //atomes per volume >> 95 >> 96 ~G4Element(); >> 97 >> 98 // >> 99 // retrieval methods >> 100 // >> 101 G4String GetName() const {return fName;}; >> 102 G4String GetSymbol() const {return fSymbol;}; >> 103 G4double GetZ() const {return fZeff;}; >> 104 G4double GetN() const {return fNeff;}; >> 105 G4double GetA() const {return fAeff;}; >> 106 >> 107 G4int GetNbOfAtomicShells() const {return fNbOfAtomicShells;}; >> 108 G4double GetAtomicShell(G4int) const; >> 109 >> 110 G4IsotopeVector* GetIsotopeVector() const {return theIsotopeVector;}; >> 111 size_t GetNumberOfIsotopes() const {return fNumberOfIsotopes;}; >> 112 G4double* GetRelativeAbundanceVector() const {return fRelativeAbundanceVector;}; >> 113 const G4Isotope* GetIsotope(G4int iso) const {return (*theIsotopeVector)[iso];}; >> 114 >> 115 static const G4ElementTable* GetElementTable() {return &theElementTable;}; >> 116 static size_t GetNumberOfElements() {return theElementTable.length();}; >> 117 size_t GetIndex() const {return fIndexInTable;}; >> 118 >> 119 static G4Element* GetElement(G4String name); >> 120 >> 121 G4double GetfCoulomb() const {return fCoulomb;}; >> 122 G4double GetfRadTsai() const {return fRadTsai;}; >> 123 >> 124 G4IonisParamElm* GetIonisation() const {return fIonisation;}; >> 125 >> 126 friend ostream& operator<<(ostream&, G4Element*); >> 127 friend ostream& operator<<(ostream&, G4Element&); >> 128 friend ostream& operator<<(ostream&, G4ElementTable); >> 129 >> 130 G4int operator==(const G4Element&) const; >> 131 G4int operator!=(const G4Element&) const; >> 132 >> 133 private: >> 134 >> 135 G4Element(G4Element &right); >> 136 const G4Element & operator=(const G4Element &right); >> 137 >> 138 private: >> 139 >> 140 void InitializePointers(); >> 141 void ComputeDerivedQuantities(); >> 142 void ComputeCoulombFactor(); >> 143 void ComputeLradTsaiFactor(); 190 144 191 // Mutable access to the element table. << 145 private: 192 static G4ElementTable& GetElementTableRef(); << 193 146 >> 147 // 194 // Basic data members (which define an Eleme 148 // Basic data members (which define an Element) >> 149 // >> 150 G4String fName; // name >> 151 G4String fSymbol; // symbol >> 152 G4double fZeff; // Effective atomic number >> 153 G4double fNeff; // Effective number of nucleons >> 154 G4double fAeff; // Effective mass of a mole >> 155 >> 156 G4int fNbOfAtomicShells; // number of atomic shells >> 157 G4double* fAtomicShells ; // Pointer to atomic shell binding energies >> 158 >> 159 // Isotope vector contains constituent isotopes of the element >> 160 size_t fNumberOfIsotopes; // Number of isotopes added to the element >> 161 G4IsotopeVector* theIsotopeVector; >> 162 G4double* fRelativeAbundanceVector; // Fraction of nb of atomes per volume >> 163 // for each constituent >> 164 >> 165 // Set up the static Table of Elements >> 166 static G4ElementTable theElementTable; >> 167 size_t fIndexInTable; // Position of the element in the table 195 168 196 G4String fName; // name << 169 // 197 G4String fSymbol; // symbol << 198 G4double fZeff; // Effective atomic number << 199 G4double fNeff; // Effective number of nucl << 200 G4double fAeff; // Effective mass of a mole << 201 G4int fZ; << 202 << 203 G4int fNbOfAtomicShells; // number of atom << 204 G4double* fAtomicShells; // Pointer to atom << 205 G4int* fNbOfShellElectrons; // Pointer to t << 206 << 207 G4int fNumberOfIsotopes; // Number of isoto << 208 G4IsotopeVector* theIsotopeVector; // vecto << 209 G4double* fRelativeAbundanceVector; // Frac << 210 // for << 211 << 212 // Set up the static Table of Elements << 213 std::size_t fIndexInTable; << 214 G4bool fNaturalAbundance; << 215 << 216 // Derived data members (computed from the b 170 // Derived data members (computed from the basic data members) 217 << 171 // 218 G4double fCoulomb; // Coulomb correction fa << 172 G4double fCoulomb; // Coulomb correction factor 219 G4double fRadTsai; // Tsai formula for the << 173 G4double fRadTsai; // Tsai formula for the radiation length 220 G4IonisParamElm* fIonisation; // Pointer to << 174 G4IonisParamElm* fIonisation; // Pointer to ionisation parameters 221 }; 175 }; 222 176 223 inline G4bool G4Element::GetNaturalAbundanceFl << 177 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo.... ....oooOO0OOooo.... 224 178 225 inline void G4Element::SetNaturalAbundanceFlag << 179 inline >> 180 G4Element* G4Element::GetElement(G4String elementName) >> 181 { >> 182 // search the element by its name >> 183 for (G4int J=0 ; J<theElementTable.length() ; J++) >> 184 { >> 185 if(theElementTable[J]->GetName() == elementName) >> 186 return theElementTable[J]; >> 187 } >> 188 >> 189 G4cerr << " Warning from GetElement(name). The element: " << elementName >> 190 << " does not exist in the ElementTable. Return NULL pointer \n"; >> 191 return NULL; >> 192 } 226 193 227 #endif 194 #endif 228 195