Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/materials/include/G4Element.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

Diff markup

Differences between /materials/include/G4Element.hh (Version 11.3.0) and /materials/include/G4Element.hh (Version 7.0)


  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.17 2003/06/16 16:56:13 gunter Exp $
                                                   >>  25 // GEANT4 tag $Name: geant4-07-00-cand-01 $
 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 // 17-07-01, migration to STL, M. Verderi
 70 // 13-09-01, stl migration. Suppression of the     65 // 13-09-01, stl migration. Suppression of the data member fIndexInTable
 71 // 14-09-01, fCountUse: nb of materials which      66 // 14-09-01, fCountUse: nb of materials which use this element
 72 // 26-02-02, fIndexInTable renewed             <<  67 // 26-02-02, fIndexInTable renewed 
 73 // 01-04-05, new data member fIndexZ to count  <<  68 
 74 // 17-10-06: Add Get/Set fNaturalAbundance (V. <<  69 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
 75 // 17.09.09, add fNbOfShellElectrons and metho << 
 76                                                    70 
 77 #ifndef G4ELEMENT_HH                               71 #ifndef G4ELEMENT_HH
 78 #define G4ELEMENT_HH 1                         <<  72 #define G4ELEMENT_HH
 79                                                    73 
 80 #include "G4ElementTable.hh"                   <<  74 #include "globals.hh"
 81 #include "G4ElementVector.hh"                  <<  75 #include <vector>
 82 #include "G4IonisParamElm.hh"                  <<  76 #include "G4ios.hh"
 83 #include "G4Isotope.hh"                            77 #include "G4Isotope.hh"
                                                   >>  78 #include "G4AtomicShells.hh"
                                                   >>  79 #include "G4IonisParamElm.hh"
 84 #include "G4IsotopeVector.hh"                      80 #include "G4IsotopeVector.hh"
 85 #include "G4ios.hh"                            <<  81 #include "G4ElementTable.hh"
 86 #include "globals.hh"                          << 
 87                                                    82 
 88 #include <vector>                              <<  83 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
 89                                                    84 
 90 class G4Element                                    85 class G4Element
 91 {                                                  86 {
 92  public:  // with description                  <<  87 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                                                    88 
                                                   >>  89   //
                                                   >>  90   // Constructor to Build an element directly; no reference to isotopes
                                                   >>  91   //
                                                   >>  92   G4Element(const G4String& name,   //its name
                                                   >>  93             const G4String& symbol,   //its symbol
                                                   >>  94                   G4double  Zeff,   //atomic number
                                                   >>  95                   G4double  Aeff);    //mass of mole
                                                   >>  96                   
                                                   >>  97   //
 99   // Constructor to Build an element from isot     98   // Constructor to Build an element from isotopes via AddIsotope
100   G4Element(const G4String& name,  // its name <<  99   //
101     const G4String& symbol,  // its symbol     << 100   G4Element(const G4String& name,   //its name
102     G4int nbIsotopes);  // nb of isotopes      << 101             const G4String& symbol,   //its symbol
103                                                << 102             G4int nbIsotopes);      //nb of isotopes
104   virtual ~G4Element();                        << 
105                                                << 
106   G4Element(G4Element&) = delete;              << 
107   const G4Element& operator=(const G4Element&) << 
108                                                   103 
                                                   >> 104   //
109   // Add an isotope to the element                105   // Add an isotope to the element
110   void AddIsotope(G4Isotope* isotope,  // isot << 106   // 
111     G4double RelativeAbundance);  // fraction  << 107   void AddIsotope(G4Isotope* isotope,     //isotope 
112                                   // atomes pe << 108                   G4double   RelativeAbundance);  //fraction of nb of 
113                                                << 109                             //atomes per volume
114   // Retrieval methods                         << 110   virtual ~G4Element();
115   inline const G4String& GetName() const { ret << 111   
116   inline const G4String& GetSymbol() const { r << 112   //
117                                                << 113   // retrieval methods
118   // Atomic number                             << 114   //
119   inline G4double GetZ() const { return fZeff; << 115   G4String GetName()   const {return fName;};
120   inline G4int GetZasInt() const { return fZ;  << 116   G4String GetSymbol() const {return fSymbol;};
121                                                << 117   G4double GetZ()      const {return fZeff;};     //atomic number
122   // Atomic weight in atomic units             << 118   G4double GetN()      const {return fNeff;};     //number of nucleons
123   inline G4double GetN() const { return fNeff; << 119   G4double GetA()      const {return fAeff;};     //mass of a mole
124   inline G4double GetAtomicMassAmu() const { r << 120   
125                                                << 121   //the number of atomic shells in this element:
126   // Mass of a mole in Geant4 units for atoms  << 122   //
127   inline G4double GetA() const { return fAeff; << 123   G4int GetNbOfAtomicShells() const {return fNbOfAtomicShells;};
128                                                << 124   
129   inline G4bool GetNaturalAbundanceFlag() cons << 125   //the binding energy of the shell:
130                                                << 126   //
131   inline void SetNaturalAbundanceFlag(G4bool); << 127   G4double GetAtomicShell(G4int) const;
132                                                << 128     
133   // the number of atomic shells in this eleme << 129   //number of isotopes constituing this element:
134   inline G4int GetNbOfAtomicShells() const { r << 130   //
135                                                << 131   size_t GetNumberOfIsotopes() const {return fNumberOfIsotopes;};
136   // the binding energy of the shell, ground s << 132    
137   G4double GetAtomicShell(G4int index) const;  << 133   //vector of pointers to isotopes constituing this element:
138                                                << 134   //
139   // the number of electrons at the shell, gro << 135   G4IsotopeVector* GetIsotopeVector() const {return theIsotopeVector;};
140   G4int GetNbOfShellElectrons(G4int index) con << 136     
141                                                << 137   //vector of relative abundance of each isotope:
142   // number of isotopes constituing this eleme << 138   //
143   inline std::size_t GetNumberOfIsotopes() con << 139   G4double* GetRelativeAbundanceVector() const 
144                                                << 140                    {return fRelativeAbundanceVector;};
145   // vector of pointers to isotopes constituin << 141     
146   inline G4IsotopeVector* GetIsotopeVector() c << 142   const G4Isotope* GetIsotope(G4int iso) const 
147                                                << 143                    {return (*theIsotopeVector)[iso];};
148   // vector of relative abundance of each isot << 144 
149   inline G4double* GetRelativeAbundanceVector( << 145   //the (static) Table of Elements:
150                                                << 146   //
151   inline const G4Isotope* GetIsotope(G4int iso << 147   static 
152                                                << 148   const  G4ElementTable* GetElementTable();
153   // the (static) Table of Elements:           << 149   
154   static const G4ElementTable* GetElementTable << 150   static 
155                                                << 151   size_t GetNumberOfElements();
156   static std::size_t GetNumberOfElements();    << 152   
157                                                << 153   //the index of this element in the Table:
158   // the index of this element in the Table:   << 154   //
159   inline std::size_t GetIndex() const { return << 155   size_t GetIndex() const {return fIndexInTable;};
160                                                << 156     
161   // return pointer to an element, given its n << 157   //return pointer to an element, given its name:
162   static G4Element* GetElement(const G4String& << 158   //
163                                                << 159   static
164   // Coulomb correction factor:                << 160   G4Element* GetElement(G4String name);
165   inline G4double GetfCoulomb() const { return << 161   
166                                                << 162   //count number of materials which use this element
167   // Tsai formula for the radiation length:    << 163   //
168   inline G4double GetfRadTsai() const { return << 164   G4int GetCountUse() const {return fCountUse;};
169                                                << 165   void  increaseCountUse()  {fCountUse++;};
170   // pointer to ionisation parameters:         << 166   void  decreaseCountUse()  {fCountUse--;};
171   inline G4IonisParamElm* GetIonisation() cons << 167       
172                                                << 168   //Coulomb correction factor:
                                                   >> 169   //
                                                   >> 170   G4double GetfCoulomb() const {return fCoulomb;};
                                                   >> 171    
                                                   >> 172   //Tsai formula for the radiation length:
                                                   >> 173   //
                                                   >> 174   G4double GetfRadTsai() const {return fRadTsai;};
                                                   >> 175     
                                                   >> 176   //pointer to ionisation parameters:
                                                   >> 177   //
                                                   >> 178   G4IonisParamElm* GetIonisation() const {return fIonisation;};
                                                   >> 179     
173   // printing methods                             180   // printing methods
174   friend std::ostream& operator<<(std::ostream << 181   //    
175   friend std::ostream& operator<<(std::ostream << 182   friend std::ostream& operator<<(std::ostream&, G4Element*);    
176   friend std::ostream& operator<<(std::ostream << 183   friend std::ostream& operator<<(std::ostream&, G4Element&);    
177   friend std::ostream& operator<<(std::ostream << 184   friend std::ostream& operator<<(std::ostream&, G4ElementTable);
178                                                << 185 
179   inline void SetName(const G4String& name) {  << 186 public:  // without description
                                                   >> 187 
                                                   >> 188   G4int operator==(const G4Element&) const;
                                                   >> 189   G4int operator!=(const G4Element&) const;
                                                   >> 190 
                                                   >> 191 private:
                                                   >> 192 
                                                   >> 193   G4Element(G4Element&);
                                                   >> 194   const G4Element & operator=(const G4Element&);
                                                   >> 195        
                                                   >> 196 private:
180                                                   197 
181   G4bool operator==(const G4Element&) const =  << 
182   G4bool operator!=(const G4Element&) const =  << 
183                                                << 
184  private:                                      << 
185   void InitializePointers();                      198   void InitializePointers();
186   void ComputeDerivedQuantities();                199   void ComputeDerivedQuantities();
187   void ComputeCoulombFactor();                    200   void ComputeCoulombFactor();
188   void ComputeLradTsaiFactor();                   201   void ComputeLradTsaiFactor();
189   void AddNaturalIsotopes();                   << 
190                                                   202 
191   // Mutable access to the element table.      << 203 private:
192   static G4ElementTable& GetElementTableRef(); << 
193                                                   204 
                                                   >> 205   //
194   // Basic data members (which define an Eleme    206   // Basic data members (which define an Element)
195                                                << 207   //
196   G4String fName;  // name                     << 208   G4String fName;              // name
197   G4String fSymbol;  // symbol                 << 209   G4String fSymbol;            // symbol
198   G4double fZeff;  // Effective atomic number  << 210   G4double fZeff;              // Effective atomic number
199   G4double fNeff;  // Effective number of nucl << 211   G4double fNeff;              // Effective number of nucleons
200   G4double fAeff;  // Effective mass of a mole << 212   G4double fAeff;              // Effective mass of a mole
201   G4int fZ;                                    << 213     
202                                                << 214   G4int fNbOfAtomicShells;     // number  of atomic shells
203   G4int fNbOfAtomicShells;  // number  of atom << 215   G4double* fAtomicShells ;    // Pointer to atomic shell binding energies
204   G4double* fAtomicShells;  // Pointer to atom << 216     
205   G4int* fNbOfShellElectrons;  // Pointer to t << 217   // Isotope vector contains constituent isotopes of the element   
206                                                << 218   size_t fNumberOfIsotopes;    // Number of isotopes added to the element
207   G4int fNumberOfIsotopes;  // Number of isoto << 219   G4IsotopeVector* theIsotopeVector;
208   G4IsotopeVector* theIsotopeVector;  // vecto << 220   G4double* fRelativeAbundanceVector;     // Fraction nb of atomes per volume
209   G4double* fRelativeAbundanceVector;  // Frac << 221                                           // for each constituent
210                                        // for  << 222   G4int fCountUse;          // nb of materials which use this element
211                                                << 223   
212   // Set up the static Table of Elements          224   // Set up the static Table of Elements
213   std::size_t fIndexInTable;                   << 225   static G4ElementTable theElementTable;
214   G4bool fNaturalAbundance;                    << 226   size_t fIndexInTable;
215                                                   227 
                                                   >> 228   //
216   // Derived data members (computed from the b    229   // Derived data members (computed from the basic data members)
217                                                << 230   //
218   G4double fCoulomb;  // Coulomb correction fa << 231   G4double fCoulomb;             // Coulomb correction factor
219   G4double fRadTsai;  // Tsai formula for the  << 232   G4double fRadTsai;             // Tsai formula for the radiation length
220   G4IonisParamElm* fIonisation;  // Pointer to    233   G4IonisParamElm* fIonisation;  // Pointer to ionisation parameters
221 };                                                234 };
222                                                   235 
223 inline G4bool G4Element::GetNaturalAbundanceFl << 236 //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo......
224                                                << 
225 inline void G4Element::SetNaturalAbundanceFlag << 
226                                                   237 
227 #endif                                            238 #endif
228                                                   239