G4PenelopeOscillatorManager Class Reference

#include <G4PenelopeOscillatorManager.hh>

Public Member Functions
void	Clear ()
void	Dump (const G4Material *)
G4PenelopeOscillatorTable *	GetOscillatorTableIonisation (const G4Material *)
G4PenelopeOscillator *	GetOscillatorIonisation (const G4Material *, G4int)
G4PenelopeOscillatorTable *	GetOscillatorTableCompton (const G4Material *)
G4PenelopeOscillator *	GetOscillatorCompton (const G4Material *, G4int)
void	SetVerbosityLevel (G4int vl)
G4int	GetVerbosityLevel ()
G4double	GetTotalZ (const G4Material *)
G4double	GetTotalA (const G4Material *)
	Returns the total A for the molecule. More...
G4double	GetMeanExcitationEnergy (const G4Material *)
	Returns the mean excitation energy. More...
G4double	GetPlasmaEnergySquared (const G4Material *)
	Returns the squared plasma energy. More...
G4double	GetAtomsPerMolecule (const G4Material *)
	Returns the total number of atoms per molecule. More...
G4double	GetNumberOfZAtomsPerMolecule (const G4Material *, G4int Z)

Static Public Member Functions
static G4PenelopeOscillatorManager *	GetOscillatorManager ()

Protected Member Functions
	G4PenelopeOscillatorManager ()
	~G4PenelopeOscillatorManager ()

Detailed Description

Definition at line 68 of file G4PenelopeOscillatorManager.hh.

Constructor & Destructor Documentation

G4PenelopeOscillatorManager::G4PenelopeOscillatorManager ( )

protected

Definition at line 61 of file G4PenelopeOscillatorManager.cc.

Referenced by GetOscillatorManager().

                                                         : 
  oscillatorStoreIonisation(0),oscillatorStoreCompton(0),atomicNumber(0),
  atomicMass(0),excitationEnergy(0),plasmaSquared(0),atomsPerMolecule(0),
  atomTablePerMolecule(0)
{
  fReadElementData = false;
  for (G4int i=0;i<5;i++)
    {
      for (G4int j=0;j<2000;j++)
    elementData[i][j] = 0.;
    }
  verbosityLevel = 0;
}

G4PenelopeOscillatorManager::~G4PenelopeOscillatorManager ( )

protected

Definition at line 77 of file G4PenelopeOscillatorManager.cc.

References Clear().

{
  Clear();
  delete instance;
}

Member Function Documentation

void G4PenelopeOscillatorManager::Clear

(

)

Definition at line 98 of file G4PenelopeOscillatorManager.cc.

References G4cout, and G4endl.

Referenced by ~G4PenelopeOscillatorManager().

{
  if (verbosityLevel > 1)
    G4cout << " G4PenelopeOscillatorManager::Clear() - Clean Oscillator Tables" << G4endl;

  //Clean up OscillatorStoreIonisation
  std::map<const G4Material*,G4PenelopeOscillatorTable*>::iterator i;
  for (i=oscillatorStoreIonisation->begin();i != oscillatorStoreIonisation->end();i++)
    {
      G4PenelopeOscillatorTable* table = i->second;
      if (table)
    {
      for (size_t k=0;k<table->size();k++) //clean individual oscillators
        {
          if ((*table)[k]) 
        delete ((*table)[k]);
        }
      delete table;
    }
    }
  delete oscillatorStoreIonisation;

  //Clean up OscillatorStoreCompton
  for (i=oscillatorStoreCompton->begin();i != oscillatorStoreCompton->end();i++)
    {
      G4PenelopeOscillatorTable* table = i->second;
      if (table)
    {
      for (size_t k=0;k<table->size();k++) //clean individual oscillators
        {
          if ((*table)[k]) 
        delete ((*table)[k]);
        }
      delete table;
    }
    }
  delete oscillatorStoreCompton;

  if (atomicMass) delete atomicMass;
  if (atomicNumber) delete atomicNumber;
  if (excitationEnergy) delete excitationEnergy;
  if (plasmaSquared) delete plasmaSquared;
  if (atomsPerMolecule) delete atomsPerMolecule;
  if (atomTablePerMolecule) delete atomTablePerMolecule;
}

void G4PenelopeOscillatorManager::Dump

(

const G4Material *

material

)

Definition at line 146 of file G4PenelopeOscillatorManager.cc.

References python.hepunit::eV, G4cout, G4endl, G4Material::GetName(), GetOscillatorTableCompton(), and GetOscillatorTableIonisation().

{
  G4PenelopeOscillatorTable* theTable = GetOscillatorTableIonisation(material);
  if (!theTable)
    {
      G4cout << " G4PenelopeOscillatorManager::Dump " << G4endl;
      G4cout << "Problem in retrieving the Ionisation Oscillator Table for " << material->GetName() << G4endl;
      return;
    }
  G4cout << "*********************************************************************" << G4endl;
  G4cout << " Penelope Oscillator Table Ionisation for " << material->GetName() << G4endl;
  G4cout << "*********************************************************************" << G4endl;
  G4cout << "The table contains " << theTable->size() << " oscillators " << G4endl;
  G4cout << "*********************************************************************" << G4endl;
  if (theTable->size() < 10)
    for (size_t k=0;k<theTable->size();k++)
      {
    G4cout << "Oscillator # " << k << " Z = " << (*theTable)[k]->GetParentZ() <<
      " Shell Flag = " << (*theTable)[k]->GetShellFlag() << 
      " Parent shell ID = " << (*theTable)[k]->GetParentShellID() << G4endl;
    G4cout << "Ionisation energy = " << (*theTable)[k]->GetIonisationEnergy()/eV << " eV" << G4endl;
    G4cout << "Occupation number = " << (*theTable)[k]->GetOscillatorStrength() << G4endl;
    G4cout << "Resonance energy = " << (*theTable)[k]->GetResonanceEnergy()/eV << " eV" << G4endl;
    G4cout << "Cufoff resonance energy = " << 
        (*theTable)[k]->GetCutoffRecoilResonantEnergy()/eV << " eV" << G4endl;
    G4cout << "*********************************************************************" << G4endl;
      }
  for (size_t k=0;k<theTable->size();k++)
    { 
      G4cout << k << " " << (*theTable)[k]->GetOscillatorStrength() << " " << 
    (*theTable)[k]->GetIonisationEnergy()/eV << " " << (*theTable)[k]->GetResonanceEnergy()/eV << " " << 
    (*theTable)[k]->GetParentZ() << " " << (*theTable)[k]->GetShellFlag() << " " << 
    (*theTable)[k]->GetParentShellID() << G4endl;
    }
  G4cout << "*********************************************************************" << G4endl;
 

  //Compton table
  theTable = GetOscillatorTableCompton(material);
  if (!theTable)
    {
      G4cout << " G4PenelopeOscillatorManager::Dump " << G4endl;
      G4cout << "Problem in retrieving the Compton Oscillator Table for " << material->GetName() << G4endl;
      return;
    }
  G4cout << "*********************************************************************" << G4endl;
  G4cout << " Penelope Oscillator Table Compton for " << material->GetName() << G4endl;
  G4cout << "*********************************************************************" << G4endl;
  G4cout << "The table contains " << theTable->size() << " oscillators " << G4endl;
  G4cout << "*********************************************************************" << G4endl;
  if (theTable->size() < 10)
    for (size_t k=0;k<theTable->size();k++)
      {
    G4cout << "Oscillator # " << k << " Z = " << (*theTable)[k]->GetParentZ() <<
      " Shell Flag = " << (*theTable)[k]->GetShellFlag() << 
       " Parent shell ID = " << (*theTable)[k]->GetParentShellID() << G4endl;
    G4cout << "Compton index = " << (*theTable)[k]->GetHartreeFactor() << G4endl;
    G4cout << "Ionisation energy = " << (*theTable)[k]->GetIonisationEnergy()/eV << " eV" << G4endl;
    G4cout << "Occupation number = " << (*theTable)[k]->GetOscillatorStrength() << G4endl;
    G4cout << "*********************************************************************" << G4endl;
      }
  for (size_t k=0;k<theTable->size();k++)
    { 
      G4cout << k << " " << (*theTable)[k]->GetOscillatorStrength() << " " << 
    (*theTable)[k]->GetIonisationEnergy()/eV << " " << (*theTable)[k]->GetHartreeFactor() << " " << 
    (*theTable)[k]->GetParentZ() << " " << (*theTable)[k]->GetShellFlag() << " " << 
    (*theTable)[k]->GetParentShellID() << G4endl;
    }
  G4cout << "*********************************************************************" << G4endl;
  
  return;
}

G4double G4PenelopeOscillatorManager::GetAtomsPerMolecule

(

const G4Material *

mat

)

Returns the total number of atoms per molecule.

Definition at line 1193 of file G4PenelopeOscillatorManager.cc.

References G4cout, G4endl, and G4Material::GetName().

Referenced by G4PenelopeBremsstrahlungModel::ComputeDEDXPerVolume(), G4PenelopeIonisationModel::ComputeDEDXPerVolume(), G4PenelopeComptonModel::CrossSectionPerVolume(), G4PenelopeBremsstrahlungModel::CrossSectionPerVolume(), and G4PenelopeIonisationModel::CrossSectionPerVolume().

{
  // (1) First time, create oscillatorStores and read data
  CheckForTablesCreated();

  // (2) Check if the material has been already included
  if (atomsPerMolecule->count(mat))
    return atomsPerMolecule->find(mat)->second;
    
  // (3) If we are here, it means that we have to create the table for the material
  BuildOscillatorTable(mat);

  // (4) now, the oscillator store should be ok
  if (atomsPerMolecule->count(mat))
    return atomsPerMolecule->find(mat)->second;
  else
    {
      G4cout << "G4PenelopeOscillatorManager::GetAtomsPerMolecule() " << G4endl;
      G4cout << "Impossible to retrieve the number of atoms per molecule for  " 
         << mat->GetName() << G4endl;      
      return 0;
    }
}

G4double G4PenelopeOscillatorManager::GetMeanExcitationEnergy

(

const G4Material *

mat

)

Returns the mean excitation energy.

Definition at line 1144 of file G4PenelopeOscillatorManager.cc.

References G4cout, G4endl, and G4Material::GetName().

{
  // (1) First time, create oscillatorStores and read data
  CheckForTablesCreated();

  // (2) Check if the material has been already included
  if (excitationEnergy->count(mat))
    return excitationEnergy->find(mat)->second;
    
  // (3) If we are here, it means that we have to create the table for the material
  BuildOscillatorTable(mat);

  // (4) now, the oscillator store should be ok
  if (excitationEnergy->count(mat))
    return excitationEnergy->find(mat)->second;
  else
    {
      G4cout << "G4PenelopeOscillatorManager::GetMolecularExcitationEnergy() " << G4endl;
      G4cout << "Impossible to retrieve the excitation energy for  " << mat->GetName() << G4endl;      
      return 0;
    }
}

G4double G4PenelopeOscillatorManager::GetNumberOfZAtomsPerMolecule	(	const G4Material *	mat,
		G4int	Z
	)

Definition at line 1219 of file G4PenelopeOscillatorManager.cc.

References G4cout, G4endl, and G4Material::GetName().

Referenced by G4PenelopeIonisationCrossSection::CrossSection().

{
  // (1) First time, create oscillatorStores and read data
  CheckForTablesCreated();

  // (2) Check if the material/Z couple has been already included
  std::pair<const G4Material*,G4int> theKey = std::make_pair(mat,Z);
  if (atomTablePerMolecule->count(theKey))
    return atomTablePerMolecule->find(theKey)->second;
    
  // (3) If we are here, it means that we have to create the table for the material
  BuildOscillatorTable(mat);

  // (4) now, the oscillator store should be ok
  if (atomTablePerMolecule->count(theKey))
    return atomTablePerMolecule->find(theKey)->second;
  else
    {
      G4cout << "G4PenelopeOscillatorManager::GetAtomsPerMolecule() " << G4endl;
      G4cout << "Impossible to retrieve the number of atoms per molecule for Z = " 
         << Z << " in material " << mat->GetName() << G4endl;      
      return 0;
    }
}

G4PenelopeOscillator * G4PenelopeOscillatorManager::GetOscillatorCompton	(	const G4Material *	material,
		G4int	index
	)

Definition at line 391 of file G4PenelopeOscillatorManager.cc.

References G4cout, G4endl, G4Material::GetName(), and GetOscillatorTableCompton().

{
  G4PenelopeOscillatorTable* theTable = GetOscillatorTableCompton(material);
  if (((size_t)index) < theTable->size())
    return (*theTable)[index];
  else
    {
      G4cout << "WARNING: Compton table for material " << material->GetName() << " has " << 
    theTable->size() << " oscillators" << G4endl;
      G4cout << "Oscillator #" << index << " cannot be retrieved" << G4endl;
      G4cout << "Returning null pointer" << G4endl;
      return NULL;
    }     
}

G4PenelopeOscillator * G4PenelopeOscillatorManager::GetOscillatorIonisation	(	const G4Material *	material,
		G4int	index
	)

Definition at line 344 of file G4PenelopeOscillatorManager.cc.

References G4cout, G4endl, G4Material::GetName(), and GetOscillatorTableIonisation().

Referenced by G4PenelopeIonisationCrossSection::CrossSection().

{
  G4PenelopeOscillatorTable* theTable = GetOscillatorTableIonisation(material);
  if (((size_t)index) < theTable->size())
    return (*theTable)[index];
  else
    {
      G4cout << "WARNING: Ionisation table for material " << material->GetName() << " has " << 
    theTable->size() << " oscillators" << G4endl;
      G4cout << "Oscillator #" << index << " cannot be retrieved" << G4endl;
      G4cout << "Returning null pointer" << G4endl;
      return NULL;
    }     
}

G4PenelopeOscillatorManager * G4PenelopeOscillatorManager::GetOscillatorManager ( )

static

Definition at line 89 of file G4PenelopeOscillatorManager.cc.

References G4PenelopeOscillatorManager().

Referenced by G4PenelopeBremsstrahlungModel::G4PenelopeBremsstrahlungModel(), G4PenelopeComptonModel::G4PenelopeComptonModel(), G4PenelopeIonisationCrossSection::G4PenelopeIonisationCrossSection(), G4PenelopeIonisationModel::G4PenelopeIonisationModel(), and G4PenelopeIonisationXSHandler::G4PenelopeIonisationXSHandler().

{
  if (!instance)
    instance = new G4PenelopeOscillatorManager();
  return instance;
}

G4PenelopeOscillatorTable * G4PenelopeOscillatorManager::GetOscillatorTableCompton

(

const G4Material *

mat

)

Definition at line 363 of file G4PenelopeOscillatorManager.cc.

References G4cout, G4endl, and G4Material::GetName().

Referenced by G4PenelopeComptonModel::CrossSectionPerVolume(), Dump(), GetOscillatorCompton(), and G4PenelopeComptonModel::SampleSecondaries().

{
  // (1) First time, create oscillatorStore and read data
  CheckForTablesCreated();

  // (2) Check if the material has been already included
  if (oscillatorStoreCompton->count(mat))
    {
      //Ok, it exists
      return oscillatorStoreCompton->find(mat)->second;
    }

  // (3) If we are here, it means that we have to create the table for the material
  BuildOscillatorTable(mat);

  // (4) now, the oscillator store should be ok
  if (oscillatorStoreCompton->count(mat))
    return oscillatorStoreCompton->find(mat)->second;
  else
    {
      G4cout << "G4PenelopeOscillatorManager::GetOscillatorTableCompton() " << G4endl;
      G4cout << "Impossible to create Compton oscillator table for " << mat->GetName() << G4endl;      
      return NULL;
    }
}

G4PenelopeOscillatorTable * G4PenelopeOscillatorManager::GetOscillatorTableIonisation

(

const G4Material *

mat

)

Definition at line 316 of file G4PenelopeOscillatorManager.cc.

References G4cout, G4endl, and G4Material::GetName().

Referenced by G4PenelopeIonisationXSHandler::BuildXSTable(), Dump(), GetOscillatorIonisation(), and G4PenelopeIonisationModel::SampleSecondaries().

{
  // (1) First time, create oscillatorStores and read data
  CheckForTablesCreated();

  // (2) Check if the material has been already included
  if (oscillatorStoreIonisation->count(mat))
    {
      //Ok, it exists
      return oscillatorStoreIonisation->find(mat)->second;
    }

  // (3) If we are here, it means that we have to create the table for the material
  BuildOscillatorTable(mat);

  // (4) now, the oscillator store should be ok
  if (oscillatorStoreIonisation->count(mat))
    return oscillatorStoreIonisation->find(mat)->second;
  else
    {
      G4cout << "G4PenelopeOscillatorManager::GetOscillatorTableIonisation() " << G4endl;
      G4cout << "Impossible to create ionisation oscillator table for " << mat->GetName() << G4endl;      
      return NULL;
    }
}

G4double G4PenelopeOscillatorManager::GetPlasmaEnergySquared

(

const G4Material *

mat

)

Returns the squared plasma energy.

Definition at line 1168 of file G4PenelopeOscillatorManager.cc.

References G4cout, G4endl, and G4Material::GetName().

{
  // (1) First time, create oscillatorStores and read data
  CheckForTablesCreated();

  // (2) Check if the material has been already included
  if (plasmaSquared->count(mat))
    return plasmaSquared->find(mat)->second;
    
  // (3) If we are here, it means that we have to create the table for the material
  BuildOscillatorTable(mat);

  // (4) now, the oscillator store should be ok
  if (plasmaSquared->count(mat))
    return plasmaSquared->find(mat)->second;
  else
    {
      G4cout << "G4PenelopeOscillatorManager::GetPlasmaEnergySquared() " << G4endl;
      G4cout << "Impossible to retrieve the plasma energy for  " << mat->GetName() << G4endl;      
      return 0;
    }
}

G4double G4PenelopeOscillatorManager::GetTotalA

(

const G4Material *

mat

)

Returns the total A for the molecule.

Definition at line 291 of file G4PenelopeOscillatorManager.cc.

References G4cout, G4endl, and G4Material::GetName().

{
  // (1) First time, create oscillatorStores and read data
  CheckForTablesCreated();

  // (2) Check if the material has been already included
  if (atomicMass->count(mat))
    return atomicMass->find(mat)->second;
    
  // (3) If we are here, it means that we have to create the table for the material
  BuildOscillatorTable(mat);

  // (4) now, the oscillator store should be ok
  if (atomicMass->count(mat))
    return atomicMass->find(mat)->second;
  else
    {
      G4cout << "G4PenelopeOscillatorManager::GetTotalA() " << G4endl;
      G4cout << "Impossible to retrieve the total A for " << mat->GetName() << G4endl;      
      return 0;
    }
}

G4double G4PenelopeOscillatorManager::GetTotalZ

(

const G4Material *

mat

)

These are cumulative for the molecule Returns the total Z for the molecule

Definition at line 266 of file G4PenelopeOscillatorManager.cc.

References G4cout, G4endl, and G4Material::GetName().

Referenced by G4PenelopeComptonModel::SampleSecondaries().

{
  // (1) First time, create oscillatorStores and read data
  CheckForTablesCreated();

  // (2) Check if the material has been already included
  if (atomicNumber->count(mat))
    return atomicNumber->find(mat)->second;
    
  // (3) If we are here, it means that we have to create the table for the material
  BuildOscillatorTable(mat);

  // (4) now, the oscillator store should be ok
  if (atomicNumber->count(mat))
    return atomicNumber->find(mat)->second;
  else
    {
      G4cout << "G4PenelopeOscillatorManager::GetTotalZ() " << G4endl;
      G4cout << "Impossible to retrieve the total Z for " << mat->GetName() << G4endl;      
      return 0;
    }
}

G4int G4PenelopeOscillatorManager::GetVerbosityLevel ( )

inline

Definition at line 89 of file G4PenelopeOscillatorManager.hh.

{return verbosityLevel;};

void G4PenelopeOscillatorManager::SetVerbosityLevel ( G4int  vl )

inline

Definition at line 88 of file G4PenelopeOscillatorManager.hh.

{verbosityLevel = vl;};

---

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

• G4PenelopeOscillatorManager.hh
• G4PenelopeOscillatorManager.cc