[822] | 1 | // |
---|
| 2 | // ******************************************************************** |
---|
| 3 | // * License and Disclaimer * |
---|
| 4 | // * * |
---|
| 5 | // * The Geant4 software is copyright of the Copyright Holders of * |
---|
| 6 | // * the Geant4 Collaboration. It is provided under the terms and * |
---|
| 7 | // * conditions of the Geant4 Software License, included in the file * |
---|
| 8 | // * LICENSE and available at http://cern.ch/geant4/license . These * |
---|
| 9 | // * include a list of copyright holders. * |
---|
| 10 | // * * |
---|
| 11 | // * Neither the authors of this software system, nor their employing * |
---|
| 12 | // * institutes,nor the agencies providing financial support for this * |
---|
| 13 | // * work make any representation or warranty, express or implied, * |
---|
| 14 | // * regarding this software system or assume any liability for its * |
---|
| 15 | // * use. Please see the license in the file LICENSE and URL above * |
---|
| 16 | // * for the full disclaimer and the limitation of liability. * |
---|
| 17 | // * * |
---|
| 18 | // * This code implementation is the result of the scientific and * |
---|
| 19 | // * technical work of the GEANT4 collaboration. * |
---|
| 20 | // * By using, copying, modifying or distributing the software (or * |
---|
| 21 | // * any work based on the software) you agree to acknowledge its * |
---|
| 22 | // * use in resulting scientific publications, and indicate your * |
---|
| 23 | // * acceptance of all terms of the Geant4 Software license. * |
---|
| 24 | // ******************************************************************** |
---|
| 25 | // |
---|
| 26 | // |
---|
[921] | 27 | // $Id: G4Element.hh,v 1.23 2008/11/14 15:14:24 gcosmo Exp $ |
---|
[986] | 28 | // GEANT4 tag $Name: geant4-09-02-ref-02 $ |
---|
[822] | 29 | // |
---|
| 30 | |
---|
| 31 | // class description |
---|
| 32 | // |
---|
| 33 | // An element is a chemical element either directly defined in terms of |
---|
| 34 | // its charactaristics: its name, symbol, |
---|
| 35 | // Z (effective atomic number) |
---|
| 36 | // N (effective number of nucleons) |
---|
| 37 | // A (effective mass of a mole) |
---|
| 38 | // or in terms of a collection of constituent isotopes with specified |
---|
| 39 | // relative abundance (i.e. fraction of nb of atomes per volume). |
---|
| 40 | // |
---|
| 41 | // Quantities, with physical meaning or not, which are constant in a given |
---|
| 42 | // element are computed and stored here as Derived data members. |
---|
| 43 | // |
---|
| 44 | // The class contains as a private static member the table of defined |
---|
| 45 | // elements (an ordered vector of elements). |
---|
| 46 | // |
---|
| 47 | // Elements can be assembled singly or in mixtures into materials used |
---|
| 48 | // in volume definitions via the G4Material class. |
---|
| 49 | // |
---|
| 50 | |
---|
| 51 | //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo...... |
---|
| 52 | |
---|
| 53 | // 09-07-96, new data members added by L.Urban |
---|
| 54 | // 17-01-97, aesthetic rearrangement, M.Maire |
---|
| 55 | // 20-01-97, Tsai formula for the rad length, M.Maire |
---|
| 56 | // 21-01-97, remove mixture flag, M.Maire |
---|
| 57 | // 24-01-97, new data member: fTaul |
---|
| 58 | // new method: ComputeIonisationPara, M.Maire |
---|
| 59 | // 20-03-97, corrected initialization of pointers, M.Maire |
---|
| 60 | // 27-06-97, new function GetIsotope(int), M.Maire |
---|
| 61 | // 24-02-98, fWeightVector becomes fRelativeAbundanceVector |
---|
| 62 | // 27-04-98, atomic shell stuff, V. Grichine |
---|
| 63 | // 09-07-98, Ionisation parameters removed from the class, M.Maire |
---|
| 64 | // 04-08-98, new method GetElement(elementName), M.Maire |
---|
| 65 | // 16-11-98, Subshell -> Shell, mma |
---|
| 66 | // 30-03-01, suppression of the warning message in GetElement |
---|
| 67 | // 17-07-01, migration to STL, M. Verderi |
---|
| 68 | // 13-09-01, stl migration. Suppression of the data member fIndexInTable |
---|
| 69 | // 14-09-01, fCountUse: nb of materials which use this element |
---|
| 70 | // 26-02-02, fIndexInTable renewed |
---|
| 71 | // 01-04-05, new data member fIndexZ to count the number of elements with same Z |
---|
| 72 | // 17-10-06: Add Get/Set fNaturalAbandances (V.Ivanchenko) |
---|
| 73 | |
---|
| 74 | //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo...... |
---|
| 75 | |
---|
| 76 | #ifndef G4ELEMENT_HH |
---|
| 77 | #define G4ELEMENT_HH |
---|
| 78 | |
---|
| 79 | #include "globals.hh" |
---|
| 80 | #include <vector> |
---|
| 81 | #include "G4ios.hh" |
---|
| 82 | #include "G4Isotope.hh" |
---|
| 83 | #include "G4AtomicShells.hh" |
---|
| 84 | #include "G4IonisParamElm.hh" |
---|
| 85 | #include "G4IsotopeVector.hh" |
---|
| 86 | #include "G4ElementTable.hh" |
---|
| 87 | |
---|
| 88 | //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo...... |
---|
| 89 | |
---|
| 90 | class G4Element |
---|
| 91 | { |
---|
| 92 | public: // with description |
---|
| 93 | |
---|
| 94 | // |
---|
| 95 | // Constructor to Build an element directly; no reference to isotopes |
---|
| 96 | // |
---|
| 97 | G4Element(const G4String& name, //its name |
---|
| 98 | const G4String& symbol, //its symbol |
---|
| 99 | G4double Zeff, //atomic number |
---|
| 100 | G4double Aeff); //mass of mole |
---|
| 101 | |
---|
| 102 | // |
---|
| 103 | // Constructor to Build an element from isotopes via AddIsotope |
---|
| 104 | // |
---|
| 105 | G4Element(const G4String& name, //its name |
---|
| 106 | const G4String& symbol, //its symbol |
---|
| 107 | G4int nbIsotopes); //nb of isotopes |
---|
| 108 | |
---|
| 109 | // |
---|
| 110 | // Add an isotope to the element |
---|
| 111 | // |
---|
| 112 | void AddIsotope(G4Isotope* isotope, //isotope |
---|
| 113 | G4double RelativeAbundance); //fraction of nb of |
---|
| 114 | //atomes per volume |
---|
| 115 | virtual ~G4Element(); |
---|
| 116 | |
---|
| 117 | // |
---|
| 118 | // retrieval methods |
---|
| 119 | // |
---|
[921] | 120 | const G4String& GetName() const {return fName;} |
---|
| 121 | const G4String& GetSymbol() const {return fSymbol;} |
---|
| 122 | G4double GetZ() const {return fZeff;} //atomic number |
---|
| 123 | G4double GetN() const {return fNeff;} //number of nucleons |
---|
| 124 | G4double GetA() const {return fAeff;} //mass of a mole |
---|
[822] | 125 | G4bool GetNaturalAbandancesFlag(); |
---|
| 126 | |
---|
| 127 | void SetNaturalAbandancesFlag(G4bool); |
---|
| 128 | |
---|
| 129 | //the number of atomic shells in this element: |
---|
| 130 | // |
---|
[921] | 131 | G4int GetNbOfAtomicShells() const {return fNbOfAtomicShells;} |
---|
[822] | 132 | |
---|
| 133 | //the binding energy of the shell: |
---|
| 134 | // |
---|
| 135 | G4double GetAtomicShell(G4int) const; |
---|
| 136 | |
---|
| 137 | //number of isotopes constituing this element: |
---|
| 138 | // |
---|
[921] | 139 | size_t GetNumberOfIsotopes() const {return fNumberOfIsotopes;} |
---|
[822] | 140 | |
---|
| 141 | //vector of pointers to isotopes constituing this element: |
---|
| 142 | // |
---|
[921] | 143 | G4IsotopeVector* GetIsotopeVector() const {return theIsotopeVector;} |
---|
[822] | 144 | |
---|
| 145 | //vector of relative abundance of each isotope: |
---|
| 146 | // |
---|
| 147 | G4double* GetRelativeAbundanceVector() const |
---|
[921] | 148 | {return fRelativeAbundanceVector;} |
---|
[822] | 149 | |
---|
| 150 | const G4Isotope* GetIsotope(G4int iso) const |
---|
[921] | 151 | {return (*theIsotopeVector)[iso];} |
---|
[822] | 152 | |
---|
| 153 | //the (static) Table of Elements: |
---|
| 154 | // |
---|
| 155 | static |
---|
| 156 | const G4ElementTable* GetElementTable(); |
---|
| 157 | |
---|
| 158 | static |
---|
| 159 | size_t GetNumberOfElements(); |
---|
| 160 | |
---|
| 161 | //the index of this element in the Table: |
---|
| 162 | // |
---|
[921] | 163 | size_t GetIndex() const {return fIndexInTable;} |
---|
[822] | 164 | |
---|
| 165 | //return pointer to an element, given its name: |
---|
| 166 | // |
---|
| 167 | static |
---|
| 168 | G4Element* GetElement(G4String name, G4bool warning=true); |
---|
| 169 | |
---|
| 170 | //count number of materials which use this element |
---|
| 171 | // |
---|
[921] | 172 | G4int GetCountUse() const {return fCountUse;} |
---|
| 173 | void increaseCountUse() {fCountUse++;} |
---|
| 174 | void decreaseCountUse() {fCountUse--;} |
---|
[822] | 175 | |
---|
| 176 | //count elements with same Z |
---|
| 177 | // |
---|
[921] | 178 | G4int GetIndexZ() const {return fIndexZ;} |
---|
[822] | 179 | |
---|
| 180 | //Coulomb correction factor: |
---|
| 181 | // |
---|
[921] | 182 | G4double GetfCoulomb() const {return fCoulomb;} |
---|
[822] | 183 | |
---|
| 184 | //Tsai formula for the radiation length: |
---|
| 185 | // |
---|
[921] | 186 | G4double GetfRadTsai() const {return fRadTsai;} |
---|
[822] | 187 | |
---|
| 188 | //pointer to ionisation parameters: |
---|
| 189 | // |
---|
[921] | 190 | G4IonisParamElm* GetIonisation() const {return fIonisation;} |
---|
[822] | 191 | |
---|
| 192 | // printing methods |
---|
| 193 | // |
---|
| 194 | friend std::ostream& operator<<(std::ostream&, G4Element*); |
---|
| 195 | friend std::ostream& operator<<(std::ostream&, G4Element&); |
---|
| 196 | friend std::ostream& operator<<(std::ostream&, G4ElementTable); |
---|
| 197 | |
---|
| 198 | public: // without description |
---|
| 199 | |
---|
| 200 | G4int operator==(const G4Element&) const; |
---|
| 201 | G4int operator!=(const G4Element&) const; |
---|
| 202 | |
---|
| 203 | G4Element(__void__&); |
---|
| 204 | // Fake default constructor for usage restricted to direct object |
---|
| 205 | // persistency for clients requiring preallocation of memory for |
---|
| 206 | // persistifiable objects. |
---|
| 207 | |
---|
[921] | 208 | void SetName(const G4String& name) {fName=name;} |
---|
| 209 | |
---|
[822] | 210 | private: |
---|
| 211 | |
---|
| 212 | G4Element(G4Element&); |
---|
| 213 | const G4Element & operator=(const G4Element&); |
---|
| 214 | |
---|
| 215 | private: |
---|
| 216 | |
---|
| 217 | void InitializePointers(); |
---|
| 218 | void ComputeDerivedQuantities(); |
---|
| 219 | void ComputeCoulombFactor(); |
---|
| 220 | void ComputeLradTsaiFactor(); |
---|
| 221 | |
---|
| 222 | private: |
---|
| 223 | |
---|
| 224 | // |
---|
| 225 | // Basic data members (which define an Element) |
---|
| 226 | // |
---|
| 227 | G4String fName; // name |
---|
| 228 | G4String fSymbol; // symbol |
---|
| 229 | G4double fZeff; // Effective atomic number |
---|
| 230 | G4double fNeff; // Effective number of nucleons |
---|
| 231 | G4double fAeff; // Effective mass of a mole |
---|
| 232 | |
---|
| 233 | G4int fNbOfAtomicShells; // number of atomic shells |
---|
| 234 | G4double* fAtomicShells ; // Pointer to atomic shell binding energies |
---|
| 235 | |
---|
| 236 | // Isotope vector contains constituent isotopes of the element |
---|
| 237 | size_t fNumberOfIsotopes; // Number of isotopes added to the element |
---|
| 238 | G4IsotopeVector* theIsotopeVector; |
---|
| 239 | G4double* fRelativeAbundanceVector; // Fraction nb of atomes per volume |
---|
| 240 | // for each constituent |
---|
| 241 | G4int fCountUse; // nb of materials which use this element |
---|
| 242 | G4int fIndexZ; // index for elements with same Z |
---|
| 243 | |
---|
| 244 | // Set up the static Table of Elements |
---|
| 245 | static G4ElementTable theElementTable; |
---|
| 246 | size_t fIndexInTable; |
---|
| 247 | G4bool fNaturalAbandances; |
---|
| 248 | |
---|
| 249 | // |
---|
| 250 | // Derived data members (computed from the basic data members) |
---|
| 251 | // |
---|
| 252 | G4double fCoulomb; // Coulomb correction factor |
---|
| 253 | G4double fRadTsai; // Tsai formula for the radiation length |
---|
| 254 | G4IonisParamElm* fIonisation; // Pointer to ionisation parameters |
---|
| 255 | }; |
---|
| 256 | |
---|
| 257 | inline G4bool G4Element::GetNaturalAbandancesFlag() |
---|
| 258 | { |
---|
| 259 | return fNaturalAbandances; |
---|
| 260 | } |
---|
| 261 | |
---|
| 262 | inline void G4Element::SetNaturalAbandancesFlag(G4bool val) |
---|
| 263 | { |
---|
| 264 | fNaturalAbandances = val; |
---|
| 265 | } |
---|
| 266 | |
---|
| 267 | //....oooOO0OOooo........oooOO0OOooo........oooOO0OOooo........oooOO0OOooo...... |
---|
| 268 | |
---|
| 269 | #endif |
---|