G4ElectronOccupancy Class Reference

#include <G4ElectronOccupancy.hh>

Public Types
enum	{ MaxSizeOfOrbit = 20 }

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

Private Attributes
G4int *	theOccupancies = nullptr
G4int	theSizeOfOrbit = 0
G4int	theTotalOccupancy = 0

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;
}

References MaxSizeOfOrbit, theOccupancies, theSizeOfOrbit, and theTotalOccupancy.

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;
}

References theOccupancies, theSizeOfOrbit, and theTotalOccupancy.

~G4ElectronOccupancy()

G4ElectronOccupancy::~G4ElectronOccupancy ( )

virtual

Definition at line 59 of file G4ElectronOccupancy.cc.

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

References theOccupancies, theSizeOfOrbit, and theTotalOccupancy.

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;
}

References G4Exception(), JustWarning, theOccupancies, theSizeOfOrbit, and theTotalOccupancy.

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;
  }
}

References G4cout, G4endl, theOccupancies, and theSizeOfOrbit.

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;  
}

References theOccupancies, and theSizeOfOrbit.

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;
}

References 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;
}

References 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);
}

References aElectronOccupancyAllocator().

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();
}

References aElectronOccupancyAllocator().

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;
}

References theOccupancies, theSizeOfOrbit, and theTotalOccupancy.

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;
}

References MaxSizeOfOrbit, theOccupancies, and theSizeOfOrbit.

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;
}

References G4Exception(), JustWarning, theOccupancies, theSizeOfOrbit, and theTotalOccupancy.

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().

Field Documentation

theOccupancies

G4int* G4ElectronOccupancy::theOccupancies = nullptr

private

Definition at line 86 of file G4ElectronOccupancy.hh.

Referenced by AddElectron(), DumpInfo(), G4ElectronOccupancy(), GetOccupancy(), operator=(), operator==(), RemoveElectron(), and ~G4ElectronOccupancy().

theSizeOfOrbit

G4int G4ElectronOccupancy::theSizeOfOrbit = 0

private

Definition at line 84 of file G4ElectronOccupancy.hh.

Referenced by AddElectron(), DumpInfo(), G4ElectronOccupancy(), GetOccupancy(), GetSizeOfOrbit(), operator=(), operator==(), RemoveElectron(), and ~G4ElectronOccupancy().

theTotalOccupancy

G4int G4ElectronOccupancy::theTotalOccupancy = 0

private

Definition at line 85 of file G4ElectronOccupancy.hh.

Referenced by AddElectron(), G4ElectronOccupancy(), GetTotalOccupancy(), operator=(), RemoveElectron(), and ~G4ElectronOccupancy().

---

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

• source/particles/management/include/G4ElectronOccupancy.hh
• source/particles/management/src/G4ElectronOccupancy.cc