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 9.6.p4)


  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$
 29 //                                                 28 //
 30 // This class has information of occupation of <<  29 // 
 31 // GetOccupancy(N) gives the number of electro <<  30 // ------------------------------------------------------------
 32 //    For example : Carbon atom should be      <<  31 //      GEANT 4 class header file
                                                   >>  32 //
                                                   >>  33 //      History: first implementation, based on object model of
                                                   >>  34 //      Hisaya Kurashige, 17 Aug 1999
                                                   >>  35 // ----------------------------------------------------------------
                                                   >>  36 // Class Description
                                                   >>  37 //     This class has information of occupation of electrons 
                                                   >>  38 //     in atomic orbits
                                                   >>  39 // -  
                                                   >>  40 //     GetOccupancy(N) gives the number of electron
                                                   >>  41 //     in N-th orbit
                                                   >>  42 //       For example : Carbon atom should be 
 33 //          GetOccupancy(0)      --> 2             43 //          GetOccupancy(0)      --> 2
 34 //          GetOccupancy(1)      --> 4             44 //          GetOccupancy(1)      --> 4
 35 //          GetOccupancy(2..7)   --> 0             45 //          GetOccupancy(2..7)   --> 0
                                                   >>  46 // -
                                                   >>  47 //     GetTotalOccupancy() gives the total number of electrons
 36 //                                                 48 //
 37 // GetTotalOccupancy() gives the total number  <<  49 // --------------------------------------------------------------- 
                                                   >>  50 
 38                                                    51 
 39 // Author: Hisaya Kurashige, 17 Aug 1999       << 
 40 // ------------------------------------------- << 
 41 #ifndef G4ElectronOccupancy_hh                 << 
 42 #define G4ElectronOccupancy_hh 1               << 
 43                                                    52 
                                                   >>  53 #ifndef G4ElectronOccupancy_h
                                                   >>  54 #define G4ElectronOccupancy_h 1
                                                   >>  55 
                                                   >>  56 #include "globals.hh"
 44 #include "G4Allocator.hh"                          57 #include "G4Allocator.hh"
 45 #include "G4ios.hh"                                58 #include "G4ios.hh"
 46 #include "globals.hh"                          << 
 47                                                << 
 48 #include "pwdefs.hh"                           << 
 49                                                    59 
 50 class G4ElectronOccupancy                      <<  60 class G4ElectronOccupancy 
 51 {                                                  61 {
 52   public:                                      <<  62  public:
 53     enum                                       <<  63    enum { MaxSizeOfOrbit = 10};
 54     {                                          << 
 55       MaxSizeOfOrbit = 20                      << 
 56     };                                         << 
 57                                                << 
 58     G4ElectronOccupancy(G4int sizeOrbit = MaxS << 
 59     G4ElectronOccupancy(const G4ElectronOccupa << 
 60                                                    64 
 61     virtual ~G4ElectronOccupancy();            <<  65  public: // With Description
                                                   >>  66    G4ElectronOccupancy( G4int sizeOrbit = MaxSizeOfOrbit   );
                                                   >>  67    G4ElectronOccupancy( const G4ElectronOccupancy& right );
                                                   >>  68 
                                                   >>  69  public:
                                                   >>  70    virtual             ~G4ElectronOccupancy();
                                                   >>  71 
                                                   >>  72   //  new/delete operators are oberloded to use G4Allocator
                                                   >>  73      inline void *operator new(size_t);
                                                   >>  74      inline void operator delete(void *aElectronOccupancy);
                                                   >>  75 
                                                   >>  76  
                                                   >>  77   //- operators
                                                   >>  78      G4ElectronOccupancy & operator=(const G4ElectronOccupancy &right);
                                                   >>  79      G4int operator==(const G4ElectronOccupancy &right) const;
                                                   >>  80      G4int operator!=(const G4ElectronOccupancy &right) const;
                                                   >>  81    
                                                   >>  82  public: // With Description
                                                   >>  83    // The following methods returns
                                                   >>  84    //     0:  if the orbit(atom) is vacant 
                                                   >>  85    //    >0:  number of electrons in orbit
                                                   >>  86    G4int  GetTotalOccupancy() const;
                                                   >>  87    G4int  GetOccupancy(G4int orbit) const;
                                                   >>  88  
                                                   >>  89    //
                                                   >>  90    G4int  AddElectron(G4int orbit, G4int number = 1);
                                                   >>  91    G4int  RemoveElectron(G4int orbit, G4int number = 1);
                                                   >>  92    
                                                   >>  93    G4int  GetSizeOfOrbit() const;
                                                   >>  94    void   DumpInfo() const;
                                                   >>  95 
                                                   >>  96  private:
                                                   >>  97    G4int  theSizeOfOrbit;
                                                   >>  98    G4int  theTotalOccupancy;
                                                   >>  99    G4int* theOccupancies;
 62                                                   100 
 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 };                                                101 };
 88                                                   102 
 89 extern G4PART_DLL G4Allocator<G4ElectronOccupa << 103 #if defined G4PARTICLES_ALLOC_EXPORT
                                                   >> 104   extern G4DLLEXPORT G4Allocator<G4ElectronOccupancy> aElectronOccupancyAllocator;
                                                   >> 105 #else
                                                   >> 106   extern G4DLLIMPORT G4Allocator<G4ElectronOccupancy> aElectronOccupancyAllocator;
                                                   >> 107 #endif
 90                                                   108 
 91 // ------------------------                       109 // ------------------------
 92 // Inline methods                              << 110 // Inlined operators
 93 // ------------------------                       111 // ------------------------
 94                                                   112 
 95 inline void* G4ElectronOccupancy::operator new << 113 inline void * G4ElectronOccupancy::operator new(size_t)
 96 {                                                 114 {
 97   if (aElectronOccupancyAllocator() == nullptr << 115   void * aElectronOccupancy;
 98     aElectronOccupancyAllocator() = new G4Allo << 116   aElectronOccupancy = (void *) aElectronOccupancyAllocator.MallocSingle();
 99   }                                            << 117   return aElectronOccupancy;
100   return (void*)aElectronOccupancyAllocator()- << 
101 }                                                 118 }
102                                                   119 
103 inline void G4ElectronOccupancy::operator dele << 120 inline void G4ElectronOccupancy::operator delete(void * aElectronOccupancy)
104 {                                                 121 {
105   aElectronOccupancyAllocator()->FreeSingle((G << 122   aElectronOccupancyAllocator.FreeSingle((G4ElectronOccupancy *) aElectronOccupancy);
106 }                                                 123 }
107                                                   124 
108 inline G4int G4ElectronOccupancy::GetSizeOfOrb << 125 inline
                                                   >> 126  G4int  G4ElectronOccupancy::GetSizeOfOrbit() const
109 {                                                 127 {
110   return theSizeOfOrbit;                       << 128   return  theSizeOfOrbit;
111 }                                                 129 }
112                                                   130 
113 inline G4int G4ElectronOccupancy::GetTotalOccu << 131 inline
                                                   >> 132  G4int G4ElectronOccupancy::GetTotalOccupancy() const
114 {                                                 133 {
115   return theTotalOccupancy;                    << 134   return  theTotalOccupancy;
116 }                                                 135 }
117                                                   136 
118 inline G4int G4ElectronOccupancy::GetOccupancy << 137 inline
                                                   >> 138  G4int  G4ElectronOccupancy::GetOccupancy(G4int orbit) const
119 {                                                 139 {
120   G4int value = 0;                                140   G4int value = 0;
121   if ((orbit >= 0) && (orbit < theSizeOfOrbit) << 141   if ((orbit >=0)&&(orbit<theSizeOfOrbit)){
122     value = theOccupancies[orbit];                142     value = theOccupancies[orbit];
123   }                                               143   }
                                                   >> 144   return value;  
                                                   >> 145 }
                                                   >> 146 
                                                   >> 147 inline 
                                                   >> 148  G4int  G4ElectronOccupancy::AddElectron(G4int orbit, G4int number)
                                                   >> 149 {
                                                   >> 150   G4int value =0;
                                                   >> 151   if ((orbit >=0)&&(orbit<theSizeOfOrbit)){
                                                   >> 152     theOccupancies[orbit] += number;
                                                   >> 153     theTotalOccupancy += number; 
                                                   >> 154     value = number;   
                                                   >> 155   }
124   return value;                                   156   return value;
125 }                                                 157 }
126                                                   158 
                                                   >> 159 inline 
                                                   >> 160  G4int  G4ElectronOccupancy::RemoveElectron(G4int orbit, G4int number)
                                                   >> 161 {
                                                   >> 162   G4int value =0;
                                                   >> 163   if ((orbit >=0)&&(orbit<theSizeOfOrbit) ){
                                                   >> 164     if ( theOccupancies[orbit] < number ) number = theOccupancies[orbit];
                                                   >> 165     theOccupancies[orbit] -= number;
                                                   >> 166     theTotalOccupancy -= number;    
                                                   >> 167     value = number;
                                                   >> 168   }
                                                   >> 169   return value;
                                                   >> 170 }
127 #endif                                            171 #endif
                                                   >> 172 
                                                   >> 173 
                                                   >> 174 
                                                   >> 175 
                                                   >> 176 
                                                   >> 177 
128                                                   178