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