G4ElectronOccupancy Class Reference

#include <G4ElectronOccupancy.hh>

Collaboration diagram for G4ElectronOccupancy:

Public Types
enum	{ MaxSizeOfOrbit = 20 }

Public Member Functions
	G4ElectronOccupancy (G4int sizeOrbit=MaxSizeOfOrbit)
	G4ElectronOccupancy (const G4ElectronOccupancy &right)
virtual	~G4ElectronOccupancy ()
void *	operator new (size_t)
void	operator delete (void *aElectronOccupancy)
G4ElectronOccupancy &	operator= (const G4ElectronOccupancy &right)
G4int	operator== (const G4ElectronOccupancy &right) const
G4int	operator!= (const G4ElectronOccupancy &right) const
G4int	GetTotalOccupancy () const
G4int	GetOccupancy (G4int orbit) const
G4int	AddElectron (G4int orbit, G4int number=1)
G4int	RemoveElectron (G4int orbit, G4int number=1)
G4int	GetSizeOfOrbit () const
void	DumpInfo () const

Private Attributes
G4int	theSizeOfOrbit
G4int	theTotalOccupancy
G4int *	theOccupancies

Detailed Description

Definition at line 62 of file G4ElectronOccupancy.hh.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
MaxSizeOfOrbit

Definition at line 65 of file G4ElectronOccupancy.hh.

{ MaxSizeOfOrbit = 20};

Constructor & Destructor Documentation

G4ElectronOccupancy() [1/2]

G4ElectronOccupancy::G4ElectronOccupancy

(

G4int

sizeOrbit = MaxSizeOfOrbit

)

Definition at line 45 of file G4ElectronOccupancy.cc.

  : theSizeOfOrbit(sizeOrbit)
{
  // check size
  if  ( (theSizeOfOrbit <1 ) || (theSizeOfOrbit > MaxSizeOfOrbit) ) {
    theSizeOfOrbit = MaxSizeOfOrbit;
  }

  // allocate and clear the array of theOccupancies 
  theOccupancies = new G4int[theSizeOfOrbit];
  G4int   index =0;
  for (index = 0; index <  theSizeOfOrbit; index++) {
    theOccupancies[index] =0;
  }

   theTotalOccupancy =0;
}

G4ElectronOccupancy() [2/2]

G4ElectronOccupancy::G4ElectronOccupancy

(

const G4ElectronOccupancy &

right

)

Definition at line 72 of file G4ElectronOccupancy.cc.

{
  theSizeOfOrbit = right.theSizeOfOrbit;

  // allocate and clear the array of theOccupancies 
  theOccupancies = new G4int[theSizeOfOrbit];
  G4int   index =0;
  for (index = 0; index <  theSizeOfOrbit; index++) {
    theOccupancies[index] = right.theOccupancies[index];
  }

  theTotalOccupancy = right.theTotalOccupancy;
}

~G4ElectronOccupancy()

G4ElectronOccupancy::~G4ElectronOccupancy ( )

virtual

Definition at line 63 of file G4ElectronOccupancy.cc.

{
   theSizeOfOrbit = -1;

   delete [] theOccupancies;
   theOccupancies =0;
   theTotalOccupancy =0;
}

Member Function Documentation

AddElectron()

G4int G4ElectronOccupancy::AddElectron	(	G4int	orbit,
		G4int	number = 1
	)

Definition at line 136 of file G4ElectronOccupancy.cc.

{
  G4int value =0;
  if (orbit>=theSizeOfOrbit){
    std::ostringstream smsg;
    smsg<<  "Orbit (" << orbit 
    <<") exceeds the maximum("
    <<theSizeOfOrbit-1<<")  ";
    G4String msg = smsg.str();
    G4Exception("G4ElectronOccupancy::AddElectron()","PART131",
        JustWarning, msg);
  } else if (orbit >=0) {
    theOccupancies[orbit] += number;
    theTotalOccupancy += number; 
    value = number;   
  }
  return value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

DumpInfo()

void G4ElectronOccupancy::DumpInfo

(

)

const

Definition at line 126 of file G4ElectronOccupancy.cc.

{
  G4cout << "  -- Electron Occupancy -- " << G4endl;
  G4int index;
  for (index = 0; index < theSizeOfOrbit; index++) {
    G4cout << "   " << index << "-th orbit       " 
           <<  theOccupancies[index] << G4endl;
  }
}

Here is the caller graph for this function:

GetOccupancy()

G4int G4ElectronOccupancy::GetOccupancy ( G4int  orbit ) const

inline

Definition at line 138 of file G4ElectronOccupancy.hh.

{
  G4int value = 0;
  if ((orbit >=0)&&(orbit<theSizeOfOrbit)){
    value = theOccupancies[orbit];
  }
  return value;  
}

Here is the caller graph for this function:

GetSizeOfOrbit()

G4int G4ElectronOccupancy::GetSizeOfOrbit ( ) const

inline

Definition at line 126 of file G4ElectronOccupancy.hh.

{
  return  theSizeOfOrbit;
}

Here is the caller graph for this function:

GetTotalOccupancy()

G4int G4ElectronOccupancy::GetTotalOccupancy ( ) const

inline

Definition at line 132 of file G4ElectronOccupancy.hh.

{
  return  theTotalOccupancy;
}

Here is the caller graph for this function:

operator delete()

void G4ElectronOccupancy::operator delete ( void *  aElectronOccupancy )

inline

Definition at line 120 of file G4ElectronOccupancy.hh.

{
  aElectronOccupancyAllocator->FreeSingle((G4ElectronOccupancy *) aElectronOccupancy);
}

operator new()

void * G4ElectronOccupancy::operator new ( size_t  )

inline

Definition at line 111 of file G4ElectronOccupancy.hh.

{
  if (!aElectronOccupancyAllocator)
  {
    aElectronOccupancyAllocator = new G4Allocator<G4ElectronOccupancy>;
  }
  return (void *) aElectronOccupancyAllocator->MallocSingle();
}

operator!=()

G4int G4ElectronOccupancy::operator!=

(

const G4ElectronOccupancy &

right

)

const

Definition at line 121 of file G4ElectronOccupancy.cc.

{
  return !(*this == right);
}

operator=()

G4ElectronOccupancy & G4ElectronOccupancy::operator=

(

const G4ElectronOccupancy &

right

)

Definition at line 86 of file G4ElectronOccupancy.cc.

{
  if ( this != &right) {
    theSizeOfOrbit = right.theSizeOfOrbit;
    
    // allocate and clear the array of theOccupancies 
    if ( theOccupancies != 0 ) delete [] theOccupancies;
    theOccupancies = new G4int[theSizeOfOrbit];
    G4int   index =0;
    for (index = 0; index <  theSizeOfOrbit; index++) {
      theOccupancies[index] = right.theOccupancies[index];
    }
    
    theTotalOccupancy = right.theTotalOccupancy;
  }
  return *this;
}

operator==()

G4int G4ElectronOccupancy::operator==

(

const G4ElectronOccupancy &

right

)

const

Definition at line 104 of file G4ElectronOccupancy.cc.

{
  G4int index;
  G4bool value = true;
  for (index = 0; index < MaxSizeOfOrbit; index++) {
    if ( (index < theSizeOfOrbit ) && ( index < right.theSizeOfOrbit) ) {
      value = value && 
         (theOccupancies[index] == right.theOccupancies[index]) ;
    } else if ((index < theSizeOfOrbit ) && ( index >= right.theSizeOfOrbit)) {
      value = value && (theOccupancies[index] == 0);
    } else if ((index >= theSizeOfOrbit ) && ( index <right.theSizeOfOrbit)) {
      value = value && (right.theOccupancies[index] == 0);
    }
  }
  return value;
}

RemoveElectron()

G4int G4ElectronOccupancy::RemoveElectron	(	G4int	orbit,
		G4int	number = 1
	)

Definition at line 155 of file G4ElectronOccupancy.cc.

{
  G4int value =0;
  if (orbit>=theSizeOfOrbit){
    std::ostringstream smsg;
    smsg<<  "Orbit (" << orbit 
    <<") exceeds the maximum("
    <<theSizeOfOrbit-1 <<") ";
    G4String msg = smsg.str();
    G4Exception("G4ElectronOccupancy::RemoveElectron()","PART131",
        JustWarning, msg);
  } else if (orbit >=0) {
    if ( theOccupancies[orbit] < number ) number = theOccupancies[orbit];
    theOccupancies[orbit] -= number;
    theTotalOccupancy -= number;    
    value = number;
  }
  return value;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

theOccupancies

G4int* G4ElectronOccupancy::theOccupancies

private

Definition at line 101 of file G4ElectronOccupancy.hh.

theSizeOfOrbit

G4int G4ElectronOccupancy::theSizeOfOrbit

private

Definition at line 99 of file G4ElectronOccupancy.hh.

theTotalOccupancy

G4int G4ElectronOccupancy::theTotalOccupancy

private

Definition at line 100 of file G4ElectronOccupancy.hh.

---

The documentation for this class was generated from the following files:

• G4ElectronOccupancy.hh
• G4ElectronOccupancy.cc