G4ElectronOccupancy Class Reference

#include <G4ElectronOccupancy.hh>

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)
G4bool	operator== (const G4ElectronOccupancy &right) const
G4bool	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

Detailed Description

Definition at line 50 of file G4ElectronOccupancy.hh.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
MaxSizeOfOrbit

Definition at line 54 of file G4ElectronOccupancy.hh.

{ MaxSizeOfOrbit = 20};

Constructor & Destructor Documentation

G4ElectronOccupancy() [1/2]

G4ElectronOccupancy::G4ElectronOccupancy

(

G4int

sizeOrbit = MaxSizeOfOrbit

)

Definition at line 40 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];
  for (G4int index = 0; index < theSizeOfOrbit; ++index)
  {
    theOccupancies[index] = 0;
  }
 
  theTotalOccupancy = 0;
}

G4ElectronOccupancy() [2/2]

G4ElectronOccupancy::G4ElectronOccupancy

(

const G4ElectronOccupancy &

right

)

Definition at line 68 of file G4ElectronOccupancy.cc.

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

~G4ElectronOccupancy()

G4ElectronOccupancy::~G4ElectronOccupancy ( )

virtual

Definition at line 59 of file G4ElectronOccupancy.cc.

{
   theSizeOfOrbit = -1;
 
   delete [] theOccupancies;
   theOccupancies = nullptr;
   theTotalOccupancy = 0;
}

Member Function Documentation

AddElectron()

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

Definition at line 139 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;
}

Referenced by G4MolecularConfiguration::AddElectron(), G4EmDNAChemistry::ConstructDissociationChannels(), G4EmDNAChemistry_option1::ConstructDissociationChannels(), G4EmDNAChemistry_option3::ConstructDissociationChannels(), G4EmDNAChemistry_option2::ConstructDissociationChannels(), G4MolecularConfiguration::ExciteMolecule(), G4Molecule::G4Molecule(), G4MolecularConfiguration::MoveOneElectron(), and G4MoleculeDefinition::SetLevelOccupation().

DumpInfo()

void G4ElectronOccupancy::DumpInfo

(

)

const

Definition at line 129 of file G4ElectronOccupancy.cc.

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

Referenced by G4MolecularConfiguration::PrintState().

GetOccupancy()

G4int G4ElectronOccupancy::GetOccupancy ( G4int  orbit ) const

inline

Definition at line 126 of file G4ElectronOccupancy.hh.

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

Referenced by G4MolecularConfiguration::IonizeMolecule(), G4MolecularConfiguration::MoveOneElectron(), comparator::operator()(), G4MolecularConfiguration::RemoveElectron(), and G4MoleculeDefinition::SetLevelOccupation().

GetSizeOfOrbit()

G4int G4ElectronOccupancy::GetSizeOfOrbit ( ) const

inline

Definition at line 114 of file G4ElectronOccupancy.hh.

{
  return  theSizeOfOrbit;
}

Referenced by G4MoleculeDefinition::GetNbMolecularShells(), comparator::operator()(), and G4MoleculeDefinition::Serialize().

GetTotalOccupancy()

G4int G4ElectronOccupancy::GetTotalOccupancy ( ) const

inline

Definition at line 120 of file G4ElectronOccupancy.hh.

{
  return  theTotalOccupancy;
}

Referenced by G4MolecularConfiguration::G4MolecularConfiguration(), G4MolecularConfiguration::GetNbElectrons(), G4MoleculeDefinition::GetNbElectrons(), and comparator::operator()().

operator delete()

void G4ElectronOccupancy::operator delete ( void *  aElectronOccupancy )

inline

Definition at line 107 of file G4ElectronOccupancy.hh.

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

operator new()

void * G4ElectronOccupancy::operator new ( size_t  )

inline

Definition at line 97 of file G4ElectronOccupancy.hh.

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

operator!=()

G4bool G4ElectronOccupancy::operator!=

(

const G4ElectronOccupancy &

right

)

const

Definition at line 124 of file G4ElectronOccupancy.cc.

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

operator=()

G4ElectronOccupancy & G4ElectronOccupancy::operator=

(

const G4ElectronOccupancy &

right

)

Definition at line 83 of file G4ElectronOccupancy.cc.

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

operator==()

G4bool G4ElectronOccupancy::operator==

(

const G4ElectronOccupancy &

right

)

const

Definition at line 102 of file G4ElectronOccupancy.cc.

{
  G4bool value = true;
  for (G4int 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] == false);
    }
    else if ((index >= theSizeOfOrbit ) && ( index <right.theSizeOfOrbit))
    {
      value = value && (right.theOccupancies[index] == false);
    }
  }
  return value;
}

RemoveElectron()

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

Definition at line 161 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;
}

Referenced by G4EmDNAChemistry::ConstructDissociationChannels(), G4EmDNAChemistry_option1::ConstructDissociationChannels(), G4EmDNAChemistry_option3::ConstructDissociationChannels(), G4EmDNAChemistry_option2::ConstructDissociationChannels(), G4MolecularConfiguration::ExciteMolecule(), G4Molecule::G4Molecule(), G4MolecularConfiguration::IonizeMolecule(), G4MolecularConfiguration::MoveOneElectron(), G4MolecularConfiguration::RemoveElectron(), and G4MoleculeDefinition::SetLevelOccupation().

---

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

• G4ElectronOccupancy.hh
• G4ElectronOccupancy.cc