Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/particles/management/include/G4ElectronOccupancy.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 /particles/management/include/G4ElectronOccupancy.hh (Version 11.3.0) and /particles/management/include/G4ElectronOccupancy.hh (Version 11.2)


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