| 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 // G4ElectronOccupancy
27 //
28 // Class description:
29 //
30 // This class has information of occupation of electrons in atomic orbits.
31 // GetOccupancy(N) gives the number of electron in N-th orbit
32 // For example : Carbon atom should be
33 // GetOccupancy(0) --> 2
34 // GetOccupancy(1) --> 4
35 // GetOccupancy(2..7) --> 0
36 //
37 // GetTotalOccupancy() gives the total number of electrons
38
39 // Author: Hisaya Kurashige, 17 Aug 1999
40 // --------------------------------------------------------------------
41 #ifndef G4ElectronOccupancy_hh
42 #define G4ElectronOccupancy_hh 1
43
44 #include "G4Allocator.hh"
45 #include "G4ios.hh"
46 #include "globals.hh"
47
48 #include "pwdefs.hh"
49
50 class G4ElectronOccupancy
51 {
52 public:
53 enum
54 {
55 MaxSizeOfOrbit = 20
56 };
57
58 G4ElectronOccupancy(G4int sizeOrbit = MaxSizeOfOrbit);
59 G4ElectronOccupancy(const G4ElectronOccupancy& right);
60
61 virtual ~G4ElectronOccupancy();
62
63 // new/delete operators are overloaded to use G4Allocator
64 inline void* operator new(size_t);
65 inline void operator delete(void* aElectronOccupancy);
66
67 G4ElectronOccupancy& operator=(const G4ElectronOccupancy& right);
68 G4bool operator==(const G4ElectronOccupancy& right) const;
69 G4bool operator!=(const G4ElectronOccupancy& right) const;
70
71 inline G4int GetTotalOccupancy() const;
72 inline G4int GetOccupancy(G4int orbit) const;
73 // The following methods returns
74 // 0: if the orbit(atom) is vacant
75 // >0: number of electrons in orbit
76
77 G4int AddElectron(G4int orbit, G4int number = 1);
78 G4int RemoveElectron(G4int orbit, G4int number = 1);
79
80 inline G4int GetSizeOfOrbit() const;
81 void DumpInfo() const;
82
83 private:
84 G4int theSizeOfOrbit = 0;
85 G4int theTotalOccupancy = 0;
86 G4int* theOccupancies = nullptr;
87 };
88
89 extern G4PART_DLL G4Allocator<G4ElectronOccupancy>*& aElectronOccupancyAllocator();
90
91 // ------------------------
92 // Inline methods
93 // ------------------------
94
95 inline void* G4ElectronOccupancy::operator new(size_t)
96 {
97 if (aElectronOccupancyAllocator() == nullptr) {
98 aElectronOccupancyAllocator() = new G4Allocator<G4ElectronOccupancy>;
99 }
100 return (void*)aElectronOccupancyAllocator()->MallocSingle();
101 }
102
103 inline void G4ElectronOccupancy::operator delete(void* aElectronOccupancy)
104 {
105 aElectronOccupancyAllocator()->FreeSingle((G4ElectronOccupancy*)aElectronOccupancy);
106 }
107
108 inline G4int G4ElectronOccupancy::GetSizeOfOrbit() const
109 {
110 return theSizeOfOrbit;
111 }
112
113 inline G4int G4ElectronOccupancy::GetTotalOccupancy() const
114 {
115 return theTotalOccupancy;
116 }
117
118 inline G4int G4ElectronOccupancy::GetOccupancy(G4int orbit) const
119 {
120 G4int value = 0;
121 if ((orbit >= 0) && (orbit < theSizeOfOrbit)) {
122 value = theOccupancies[orbit];
123 }
124 return value;
125 }
126
127 #endif
128