| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
25 // 25 //
26 // G4ElectronOccupancy <<
27 // 26 //
28 // Class description: << 27 // $Id: G4ElectronOccupancy.hh,v 1.12 2010-10-27 07:47:05 gcosmo Exp $
>> 28 // GEANT4 tag $Name: geant4-09-04-patch-01 $
29 // 29 //
30 // This class has information of occupation of << 30 //
31 // GetOccupancy(N) gives the number of electro << 31 // ------------------------------------------------------------
32 // For example : Carbon atom should be << 32 // GEANT 4 class header file
>> 33 //
>> 34 // History: first implementation, based on object model of
>> 35 // Hisaya Kurashige, 17 Aug 1999
>> 36 // ----------------------------------------------------------------
>> 37 // Class Description
>> 38 // This class has information of occupation of electrons
>> 39 // in atomic orbits
>> 40 // -
>> 41 // GetOccupancy(N) gives the number of electron
>> 42 // in N-th orbit
>> 43 // For example : Carbon atom should be
33 // GetOccupancy(0) --> 2 44 // GetOccupancy(0) --> 2
34 // GetOccupancy(1) --> 4 45 // GetOccupancy(1) --> 4
35 // GetOccupancy(2..7) --> 0 46 // GetOccupancy(2..7) --> 0
>> 47 // -
>> 48 // GetTotalOccupancy() gives the total number of electrons
36 // 49 //
37 // GetTotalOccupancy() gives the total number << 50 // ---------------------------------------------------------------
>> 51
38 52
39 // Author: Hisaya Kurashige, 17 Aug 1999 <<
40 // ------------------------------------------- <<
41 #ifndef G4ElectronOccupancy_hh <<
42 #define G4ElectronOccupancy_hh 1 <<
43 53
>> 54 #ifndef G4ElectronOccupancy_h
>> 55 #define G4ElectronOccupancy_h 1
>> 56
>> 57 #include "globals.hh"
44 #include "G4Allocator.hh" 58 #include "G4Allocator.hh"
45 #include "G4ios.hh" 59 #include "G4ios.hh"
46 #include "globals.hh" <<
47 <<
48 #include "pwdefs.hh" <<
49 60
50 class G4ElectronOccupancy << 61 class G4ElectronOccupancy
51 { 62 {
52 public: << 63 public:
53 enum << 64 enum { MaxSizeOfOrbit = 10};
54 { <<
55 MaxSizeOfOrbit = 20 <<
56 }; <<
57 <<
58 G4ElectronOccupancy(G4int sizeOrbit = MaxS <<
59 G4ElectronOccupancy(const G4ElectronOccupa <<
60 65
61 virtual ~G4ElectronOccupancy(); << 66 public: // With Description
>> 67 G4ElectronOccupancy( G4int sizeOrbit = MaxSizeOfOrbit );
>> 68 G4ElectronOccupancy( const G4ElectronOccupancy& right );
>> 69
>> 70 public:
>> 71 virtual ~G4ElectronOccupancy();
>> 72
>> 73 // new/delete operators are oberloded to use G4Allocator
>> 74 inline void *operator new(size_t);
>> 75 inline void operator delete(void *aElectronOccupancy);
>> 76
>> 77
>> 78 //- operators
>> 79 G4ElectronOccupancy & operator=(const G4ElectronOccupancy &right);
>> 80 G4int operator==(const G4ElectronOccupancy &right) const;
>> 81 G4int operator!=(const G4ElectronOccupancy &right) const;
>> 82
>> 83 public: // With Description
>> 84 // The following methods returns
>> 85 // 0: if the orbit(atom) is vacant
>> 86 // >0: number of electrons in orbit
>> 87 G4int GetTotalOccupancy() const;
>> 88 G4int GetOccupancy(G4int orbit) const;
>> 89
>> 90 //
>> 91 G4int AddElectron(G4int orbit, G4int number = 1);
>> 92 G4int RemoveElectron(G4int orbit, G4int number = 1);
>> 93
>> 94 G4int GetSizeOfOrbit() const;
>> 95 void DumpInfo() const;
>> 96
>> 97 private:
>> 98 G4int theSizeOfOrbit;
>> 99 G4int theTotalOccupancy;
>> 100 G4int* theOccupancies;
62 101
63 // new/delete operators are overloaded to <<
64 inline void* operator new(size_t); <<
65 inline void operator delete(void* aElectro <<
66 <<
67 G4ElectronOccupancy& operator=(const G4Ele <<
68 G4bool operator==(const G4ElectronOccupanc <<
69 G4bool operator!=(const G4ElectronOccupanc <<
70 <<
71 inline G4int GetTotalOccupancy() const; <<
72 inline G4int GetOccupancy(G4int orbit) con <<
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 numbe <<
78 G4int RemoveElectron(G4int orbit, G4int nu <<
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 }; 102 };
88 103
89 extern G4PART_DLL G4Allocator<G4ElectronOccupa << 104 #if defined G4PARTICLES_ALLOC_EXPORT
>> 105 extern G4DLLEXPORT G4Allocator<G4ElectronOccupancy> aElectronOccupancyAllocator;
>> 106 #else
>> 107 extern G4DLLIMPORT G4Allocator<G4ElectronOccupancy> aElectronOccupancyAllocator;
>> 108 #endif
90 109
91 // ------------------------ 110 // ------------------------
92 // Inline methods << 111 // Inlined operators
93 // ------------------------ 112 // ------------------------
94 113
95 inline void* G4ElectronOccupancy::operator new << 114 inline void * G4ElectronOccupancy::operator new(size_t)
96 { 115 {
97 if (aElectronOccupancyAllocator() == nullptr << 116 void * aElectronOccupancy;
98 aElectronOccupancyAllocator() = new G4Allo << 117 aElectronOccupancy = (void *) aElectronOccupancyAllocator.MallocSingle();
99 } << 118 return aElectronOccupancy;
100 return (void*)aElectronOccupancyAllocator()- <<
101 } 119 }
102 120
103 inline void G4ElectronOccupancy::operator dele << 121 inline void G4ElectronOccupancy::operator delete(void * aElectronOccupancy)
104 { 122 {
105 aElectronOccupancyAllocator()->FreeSingle((G << 123 aElectronOccupancyAllocator.FreeSingle((G4ElectronOccupancy *) aElectronOccupancy);
106 } 124 }
107 125
108 inline G4int G4ElectronOccupancy::GetSizeOfOrb << 126 inline
>> 127 G4int G4ElectronOccupancy::GetSizeOfOrbit() const
109 { 128 {
110 return theSizeOfOrbit; << 129 return theSizeOfOrbit;
111 } 130 }
112 131
113 inline G4int G4ElectronOccupancy::GetTotalOccu << 132 inline
>> 133 G4int G4ElectronOccupancy::GetTotalOccupancy() const
114 { 134 {
115 return theTotalOccupancy; << 135 return theTotalOccupancy;
116 } 136 }
117 137
118 inline G4int G4ElectronOccupancy::GetOccupancy << 138 inline
>> 139 G4int G4ElectronOccupancy::GetOccupancy(G4int orbit) const
119 { 140 {
120 G4int value = 0; 141 G4int value = 0;
121 if ((orbit >= 0) && (orbit < theSizeOfOrbit) << 142 if ((orbit >=0)&&(orbit<theSizeOfOrbit)){
122 value = theOccupancies[orbit]; 143 value = theOccupancies[orbit];
123 } 144 }
>> 145 return value;
>> 146 }
>> 147
>> 148 inline
>> 149 G4int G4ElectronOccupancy::AddElectron(G4int orbit, G4int number)
>> 150 {
>> 151 G4int value =0;
>> 152 if ((orbit >=0)&&(orbit<theSizeOfOrbit)){
>> 153 theOccupancies[orbit] += number;
>> 154 theTotalOccupancy += number;
>> 155 value = number;
>> 156 }
124 return value; 157 return value;
125 } 158 }
126 159
>> 160 inline
>> 161 G4int G4ElectronOccupancy::RemoveElectron(G4int orbit, G4int number)
>> 162 {
>> 163 G4int value =0;
>> 164 if ((orbit >=0)&&(orbit<theSizeOfOrbit) ){
>> 165 if ( theOccupancies[orbit] < number ) number = theOccupancies[orbit];
>> 166 theOccupancies[orbit] -= number;
>> 167 theTotalOccupancy -= number;
>> 168 value = number;
>> 169 }
>> 170 return value;
>> 171 }
127 #endif 172 #endif
>> 173
>> 174
>> 175
>> 176
>> 177
>> 178
128 179