| Geant4 Cross Reference |
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 // class description
27 //
28 // An isotope is a chemical isotope defined by its name,
29 // Z: atomic number
30 // N: number of nucleons
31 // A: mass of a mole (optional)
32 // m: isomer state (optional)
33 // If A is not defined it is taken from Geant4 database
34 //
35 // The class contains as a private static member the table of defined
36 // isotopes (an ordered vector of isotopes).
37 //
38 // Isotopes can be assembled into elements via the G4Element class.
39 //
40 // 20.08.11: Add flag fm for isomer level (mma)
41 // 15.11.05: GetIsotope(isotopeName, G4bool warning=false)
42 // 31.03.05: A becomes optional. Taken from Nist data base by default (mma)
43 // 26.02.02: fIndexInTable renewed
44 // 14.09.01: fCountUse: nb of elements which use this isotope
45 // 13.09.01: stl migration. Suppression of the data member fIndexInTable
46 // 30.03.01: suppression of the warning message in GetIsotope
47 // 04.08.98: new method GetIsotope(isotopeName) (mma)
48 // 17.01.97: aesthetic rearrangement (mma)
49
50 #ifndef G4ISOTOPE_HH
51 #define G4ISOTOPE_HH
52
53 #include "G4ios.hh"
54 #include "globals.hh"
55
56 #include <vector>
57
58 class G4Isotope;
59 using G4IsotopeTable = std::vector<G4Isotope*>;
60
61 class G4Isotope
62 {
63 public: // with description
64 // Make an isotope
65 G4Isotope(const G4String& name, // its name
66 G4int z, // atomic number
67 G4int n, // number of nucleons
68 G4double a = 0., // mass of mole
69 G4int mlevel = 0); // isomer level
70
71 ~G4Isotope();
72
73 G4Isotope(const G4Isotope&) = delete;
74 G4Isotope& operator=(const G4Isotope&) = delete;
75
76 // Retrieval methods
77 const G4String& GetName() const { return fName; }
78
79 // Atomic number
80 G4int GetZ() const { return fZ; }
81
82 // Number of nucleous
83 G4int GetN() const { return fN; }
84
85 // Atomic mass of mole in Geant4 units with electron shell
86 G4double GetA() const { return fA; }
87
88 // Isomer level
89 G4int Getm() const { return fm; }
90
91 static G4Isotope* GetIsotope(const G4String& name, G4bool warning = false);
92
93 static const G4IsotopeTable* GetIsotopeTable();
94
95 static std::size_t GetNumberOfIsotopes();
96
97 std::size_t GetIndex() const { return fIndexInTable; }
98
99 friend std::ostream& operator<<(std::ostream&, const G4Isotope*);
100
101 friend std::ostream& operator<<(std::ostream&, const G4Isotope&);
102
103 friend std::ostream& operator<<(std::ostream&, const G4IsotopeTable&);
104
105 G4bool operator==(const G4Isotope&) const;
106 G4bool operator!=(const G4Isotope&) const;
107
108 void SetName(const G4String& name) { fName = name; }
109
110 private:
111 G4String fName; // name of the Isotope
112 G4int fZ; // atomic number
113 G4int fN; // number of nucleons
114 G4double fA; // atomic mass of a mole
115 G4int fm; // isomer level
116
117 static G4IsotopeTable& GetIsotopeTableRef();
118
119 std::size_t fIndexInTable; // index in the Isotope table
120 };
121
122 #endif
123