#include <G4LivermorePhotoElectricModel.hh>

Inheritance diagram for G4LivermorePhotoElectricModel:

Collaboration diagram for G4LivermorePhotoElectricModel:

Public Member Functions
	G4LivermorePhotoElectricModel (const G4String &nam="LivermorePhElectric")

virtual	~G4LivermorePhotoElectricModel ()

virtual void	Initialise (const G4ParticleDefinition *, const G4DataVector &)

virtual G4double	CrossSectionPerVolume (const G4Material , const G4ParticleDefinition , G4double energy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)

virtual G4double	ComputeCrossSectionPerAtom (const G4ParticleDefinition *, G4double energy, G4double Z, G4double A=0, G4double cut=0, G4double emax=DBL_MAX)

virtual void	SampleSecondaries (std::vector< G4DynamicParticle * > , const G4MaterialCutsCouple , const G4DynamicParticle *, G4double tmin, G4double maxEnergy)

virtual void	InitialiseForElement (const G4ParticleDefinition *, G4int Z)

void	SetLimitNumberOfShells (G4int)

Public Member Functions inherited from G4VEmModel
	G4VEmModel (const G4String &nam)

virtual	~G4VEmModel ()

virtual void	InitialiseLocal (const G4ParticleDefinition , G4VEmModel masterModel)

virtual void	InitialiseForMaterial (const G4ParticleDefinition , const G4Material )

virtual G4double	ComputeDEDXPerVolume (const G4Material , const G4ParticleDefinition , G4double kineticEnergy, G4double cutEnergy=DBL_MAX)

virtual G4double	GetPartialCrossSection (const G4Material , G4int level, const G4ParticleDefinition , G4double kineticEnergy)

virtual G4double	ComputeCrossSectionPerShell (const G4ParticleDefinition *, G4int Z, G4int shellIdx, G4double kinEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)

virtual G4double	ChargeSquareRatio (const G4Track &)

virtual G4double	GetChargeSquareRatio (const G4ParticleDefinition , const G4Material , G4double kineticEnergy)

virtual G4double	GetParticleCharge (const G4ParticleDefinition , const G4Material , G4double kineticEnergy)

virtual void	StartTracking (G4Track *)

virtual void	CorrectionsAlongStep (const G4MaterialCutsCouple , const G4DynamicParticle , G4double &eloss, G4double &niel, G4double length)

virtual G4double	Value (const G4MaterialCutsCouple , const G4ParticleDefinition , G4double kineticEnergy)

virtual G4double	MinPrimaryEnergy (const G4Material , const G4ParticleDefinition , G4double cut=0.0)

virtual G4double	MinEnergyCut (const G4ParticleDefinition , const G4MaterialCutsCouple )

virtual void	SetupForMaterial (const G4ParticleDefinition , const G4Material , G4double kineticEnergy)

virtual void	DefineForRegion (const G4Region *)

virtual void	ModelDescription (std::ostream &outFile) const

void	InitialiseElementSelectors (const G4ParticleDefinition *, const G4DataVector &)

std::vector < G4EmElementSelector * > *	GetElementSelectors ()

void	SetElementSelectors (std::vector< G4EmElementSelector * > *)

virtual G4double	ComputeDEDX (const G4MaterialCutsCouple , const G4ParticleDefinition , G4double kineticEnergy, G4double cutEnergy=DBL_MAX)

G4double	CrossSection (const G4MaterialCutsCouple , const G4ParticleDefinition , G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)

G4double	ComputeMeanFreePath (const G4ParticleDefinition , G4double kineticEnergy, const G4Material , G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)

G4double	ComputeCrossSectionPerAtom (const G4ParticleDefinition , const G4Element , G4double kinEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)

G4int	SelectIsotopeNumber (const G4Element *)

const G4Element *	SelectRandomAtom (const G4MaterialCutsCouple , const G4ParticleDefinition , G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)

const G4Element *	SelectRandomAtom (const G4Material , const G4ParticleDefinition , G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)

G4int	SelectRandomAtomNumber (const G4Material *)

void	SetParticleChange (G4VParticleChange , G4VEmFluctuationModel f=nullptr)

void	SetCrossSectionTable (G4PhysicsTable *, G4bool isLocal)

G4ElementData *	GetElementData ()

G4PhysicsTable *	GetCrossSectionTable ()

G4VEmFluctuationModel *	GetModelOfFluctuations ()

G4VEmAngularDistribution *	GetAngularDistribution ()

void	SetAngularDistribution (G4VEmAngularDistribution *)

G4double	HighEnergyLimit () const

G4double	LowEnergyLimit () const

G4double	HighEnergyActivationLimit () const

G4double	LowEnergyActivationLimit () const

G4double	PolarAngleLimit () const

G4double	SecondaryThreshold () const

G4bool	LPMFlag () const

G4bool	DeexcitationFlag () const

G4bool	ForceBuildTableFlag () const

G4bool	UseAngularGeneratorFlag () const

void	SetAngularGeneratorFlag (G4bool)

void	SetHighEnergyLimit (G4double)

void	SetLowEnergyLimit (G4double)

void	SetActivationHighEnergyLimit (G4double)

void	SetActivationLowEnergyLimit (G4double)

G4bool	IsActive (G4double kinEnergy)

void	SetPolarAngleLimit (G4double)

void	SetSecondaryThreshold (G4double)

void	SetLPMFlag (G4bool val)

void	SetDeexcitationFlag (G4bool val)

void	SetForceBuildTable (G4bool val)

void	SetFluctuationFlag (G4bool val)

void	SetMasterThread (G4bool val)

G4bool	IsMaster () const

G4double	MaxSecondaryKinEnergy (const G4DynamicParticle *dynParticle)

const G4String &	GetName () const

void	SetCurrentCouple (const G4MaterialCutsCouple *)

const G4Element *	GetCurrentElement () const

const G4Isotope *	GetCurrentIsotope () const

G4bool	IsLocked () const

void	SetLocked (G4bool)

Protected Attributes
G4ParticleChangeForGamma *	fParticleChange

Protected Attributes inherited from G4VEmModel
G4ElementData *	fElementData

G4VParticleChange *	pParticleChange

G4PhysicsTable *	xSectionTable

const std::vector< G4double > *	theDensityFactor

const std::vector< G4int > *	theDensityIdx

size_t	idxTable

G4bool	lossFlucFlag

Additional Inherited Members
Protected Member Functions inherited from G4VEmModel
G4ParticleChangeForLoss *	GetParticleChangeForLoss ()

G4ParticleChangeForGamma *	GetParticleChangeForGamma ()

virtual G4double	MaxSecondaryEnergy (const G4ParticleDefinition *, G4double kineticEnergy)

const G4MaterialCutsCouple *	CurrentCouple () const

void	SetCurrentElement (const G4Element *)

Static Protected Attributes inherited from G4VEmModel
static const G4double	inveplus = 1.0/CLHEP::eplus

Detailed Description

Definition at line 50 of file G4LivermorePhotoElectricModel.hh.

Constructor & Destructor Documentation

G4LivermorePhotoElectricModel::G4LivermorePhotoElectricModel ( const G4String & nam = "LivermorePhElectric" )

Definition at line 64 of file G4LivermorePhotoElectricModel.cc.

   : G4VEmModel(nam),fParticleChange(nullptr),maxZ(99),
     nShellLimit(100),fDeexcitationActive(false),isInitialised(false),
     fAtomDeexcitation(nullptr)
 { 
   verboseLevel= 0;
   // Verbosity scale:
   // 0 = nothing 
   // 1 = warning for energy non-conservation 
   // 2 = details of energy budget
   // 3 = calculation of cross sections, file openings, sampling of atoms
   // 4 = entering in methods
 
   theGamma    = G4Gamma::Gamma();
   theElectron = G4Electron::Electron();
 
   // default generator
   SetAngularDistribution(new G4SauterGavrilaAngularDistribution());
 
   if(verboseLevel>0) {
     G4cout << "Livermore PhotoElectric is constructed " 
        << " nShellLimit= " << nShellLimit << G4endl;
   }
 
   //Mark this model as "applicable" for atomic deexcitation
   SetDeexcitationFlag(true);
   fSandiaCof.resize(4,0.0);
   fCurrSection = 0.0;
 }

Here is the call graph for this function:

G4LivermorePhotoElectricModel::~G4LivermorePhotoElectricModel ( )

virtual

Definition at line 97 of file G4LivermorePhotoElectricModel.cc.

 {  
   if(IsMaster()) {
     delete fShellCrossSection;
     for(G4int i=0; i<maxZ; ++i) { 
       delete fParam[i];
       fParam[i] = 0;
       delete fCrossSection[i];
       fCrossSection[i] = 0;
       delete fCrossSectionLE[i];
       fCrossSectionLE[i] = 0;
     }
   }
 }

Here is the call graph for this function:

Member Function Documentation

G4double G4LivermorePhotoElectricModel::ComputeCrossSectionPerAtom	(	const G4ParticleDefinition *	,
		G4double	energy,
		G4double	Z,
		G4double	A = `0`,
		G4double	cut = `0`,
		G4double	emax = `DBL_MAX`
	)

virtual

Reimplemented from G4VEmModel.

Definition at line 205 of file G4LivermorePhotoElectricModel.cc.

 {
   if (verboseLevel > 3) {
     G4cout << "G4LivermorePhotoElectricModel::ComputeCrossSectionPerAtom():" 
        << " Z= " << ZZ << "  R(keV)= " << energy/keV << G4endl;
   }
   G4double cs = 0.0;
   G4int Z = G4lrint(ZZ);
   if(Z < 1 || Z >= maxZ) { return cs; }
 
   // if element was not initialised
   // do initialisation safely for MT mode
   if(!fCrossSection[Z]) {
     InitialiseForElement(0, Z);
     if(!fCrossSection[Z]) { return cs; }
   }
 
   G4int idx = fNShells[Z]*6 - 4;
   if (energy < (*(fParam[Z]))[idx-1]) { energy = (*(fParam[Z]))[idx-1]; }
   
   G4double x1 = 1.0/energy;
   G4double x2 = x1*x1;
   G4double x3 = x2*x1;
 
   // parameterisation
   if(energy >= (*(fParam[Z]))[0]) {
     G4double x4 = x2*x2;
     cs = x1*((*(fParam[Z]))[idx] + x1*(*(fParam[Z]))[idx+1]
          + x2*(*(fParam[Z]))[idx+2] + x3*(*(fParam[Z]))[idx+3] 
          + x4*(*(fParam[Z]))[idx+4]);
     // high energy part
   } else if(energy >= (*(fParam[Z]))[1]) {
     cs = x3*(fCrossSection[Z])->Value(energy);
 
     // low energy part
   } else {
     cs = x3*(fCrossSectionLE[Z])->Value(energy);
   }
   if (verboseLevel > 1) { 
     G4cout << "LivermorePhotoElectricModel: E(keV)= " << energy/keV
        << " Z= " << Z << " cross(barn)= " << cs/barn << G4endl;
   }
   return cs;
 }

Here is the call graph for this function:

G4double G4LivermorePhotoElectricModel::CrossSectionPerVolume	(	const G4Material *	material,
		const G4ParticleDefinition *	p,
		G4double	energy,
		G4double	cutEnergy = `0.0`,
		G4double	maxEnergy = `DBL_MAX`
	)

virtual

Reimplemented from G4VEmModel.

Definition at line 176 of file G4LivermorePhotoElectricModel.cc.

 {
   fCurrSection = 0.0;
   if(fWater && (material == fWater || 
         material->GetBaseMaterial() == fWater)) {
     if(energy <= fWaterEnergyLimit) { 
       fWater->GetSandiaTable()->GetSandiaCofWater(energy, fSandiaCof);
 
       G4double energy2 = energy*energy;
       G4double energy3 = energy*energy2;
       G4double energy4 = energy2*energy2;
 
       fCurrSection = material->GetDensity()*
     (fSandiaCof[0]/energy  + fSandiaCof[1]/energy2 +
      fSandiaCof[2]/energy3 + fSandiaCof[3]/energy4);
     } 
   }
   if(0.0 == fCurrSection) {
     fCurrSection = G4VEmModel::CrossSectionPerVolume(material, p, energy);
   }
   return fCurrSection;
 }

Here is the call graph for this function:

void G4LivermorePhotoElectricModel::Initialise	(	const G4ParticleDefinition *	,
		const G4DataVector &
	)

virtual

Implements G4VEmModel.

Definition at line 115 of file G4LivermorePhotoElectricModel.cc.

 {
   if (verboseLevel > 2) {
     G4cout << "Calling G4LivermorePhotoElectricModel::Initialise()" << G4endl;
   }
 
   if(IsMaster()) {
 
     if(!fWater) { 
       fWater = G4Material::GetMaterial("G4_WATER", false); 
       if(fWater) { fWaterEnergyLimit = 13.6*eV; }
     }
 
     if(!fShellCrossSection) { fShellCrossSection = new G4ElementData(); }
 
     char* path = getenv("G4LEDATA");
 
     G4ProductionCutsTable* theCoupleTable =
       G4ProductionCutsTable::GetProductionCutsTable();
     G4int numOfCouples = theCoupleTable->GetTableSize();
   
     for(G4int i=0; i<numOfCouples; ++i) {
       const G4MaterialCutsCouple* couple = 
     theCoupleTable->GetMaterialCutsCouple(i);
       const G4Material* material = couple->GetMaterial();
       const G4ElementVector* theElementVector = material->GetElementVector();
       G4int nelm = material->GetNumberOfElements();
     
       for (G4int j=0; j<nelm; ++j) {        
     G4int Z = (G4int)(*theElementVector)[j]->GetZ();
     if(Z < 1)          { Z = 1; }
     else if(Z > maxZ)  { Z = maxZ; }
     if(!fCrossSection[Z]) { ReadData(Z, path); }
       }
     }
   }  
   //  
   if (verboseLevel > 2) {
     G4cout << "Loaded cross section files for LivermorePhotoElectric model" 
        << G4endl;
   }
   if(!isInitialised) {
     isInitialised = true;
     fParticleChange = GetParticleChangeForGamma();
 
     fAtomDeexcitation = G4LossTableManager::Instance()->AtomDeexcitation();
   }
   fDeexcitationActive = false;
   if(fAtomDeexcitation) { 
     fDeexcitationActive = fAtomDeexcitation->IsFluoActive(); 
   }
 
   if (verboseLevel > 0) { 
     G4cout << "LivermorePhotoElectric model is initialized " << G4endl
        << G4endl;
   }
 }

Here is the call graph for this function:

void G4LivermorePhotoElectricModel::InitialiseForElement	(	const G4ParticleDefinition *	,
		G4int	Z
	)

virtual

Reimplemented from G4VEmModel.

Definition at line 596 of file G4LivermorePhotoElectricModel.cc.

 {
   G4AutoLock l(&LivermorePhotoElectricModelMutex);
   //  G4cout << "G4LivermorePhotoElectricModel::InitialiseForElement Z= " 
   //   << Z << G4endl;
   if(!fCrossSection[Z]) { ReadData(Z); }
   l.unlock();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void G4LivermorePhotoElectricModel::SampleSecondaries	(	std::vector< G4DynamicParticle * > *	fvect,
		const G4MaterialCutsCouple *	couple,
		const G4DynamicParticle *	aDynamicGamma,
		G4double	tmin,
		G4double	maxEnergy
	)

virtual

Implements G4VEmModel.

Definition at line 257 of file G4LivermorePhotoElectricModel.cc.

 {
   G4double gammaEnergy = aDynamicGamma->GetKineticEnergy();
   if (verboseLevel > 3) {
     G4cout << "G4LivermorePhotoElectricModel::SampleSecondaries() Egamma(keV)= "
        << gammaEnergy/keV << G4endl;
   }
   
   // kill incident photon
   fParticleChange->ProposeTrackStatus(fStopAndKill);   
   fParticleChange->SetProposedKineticEnergy(0.);
 
   // low-energy photo-effect in water - full absorption
   const G4Material* material = couple->GetMaterial();
   if(fWater && (material == fWater || 
         material->GetBaseMaterial() == fWater)) {
     if(gammaEnergy <= fWaterEnergyLimit) { 
       fParticleChange->ProposeLocalEnergyDeposit(gammaEnergy);      
       return;
     }
   }
  
   // Returns the normalized direction of the momentum
   G4ThreeVector photonDirection = aDynamicGamma->GetMomentumDirection(); 
 
   // Select randomly one element in the current material
   //G4cout << "Select random atom Egamma(keV)= " << gammaEnergy/keV << G4endl;
   const G4Element* elm = SelectRandomAtom(material, theGamma, gammaEnergy);
   G4int Z = G4lrint(elm->GetZ());
 
   // Select the ionised shell in the current atom according to shell 
   //   cross sections
   // G4cout << "Select random shell Z= " << Z << G4endl;
 
   if(Z >= maxZ) { Z = maxZ-1; }
 
   // element was not initialised gamma should be absorbed
   if(!fCrossSection[Z]) {
     fParticleChange->ProposeLocalEnergyDeposit(gammaEnergy);
     return;
   }
   
   // shell index
   size_t shellIdx = 0;
   size_t nn = fNShellsUsed[Z];
 
   if(nn > 1) {
     if(gammaEnergy >= (*(fParam[Z]))[0]) {
       G4double x1 = 1.0/gammaEnergy;
       G4double x2 = x1*x1;
       G4double x3 = x2*x1;
       G4double x4 = x3*x1;
       G4int idx   = nn*6 - 4;
       // when do sampling common factors are not taken into account
       // so cross section is not real
       G4double cs0 = G4UniformRand()*((*(fParam[Z]))[idx] 
                       + x1*(*(fParam[Z]))[idx+1]
                       + x2*(*(fParam[Z]))[idx+2] 
                       + x3*(*(fParam[Z]))[idx+3] 
                       + x4*(*(fParam[Z]))[idx+4]);
       for(shellIdx=0; shellIdx<nn; ++shellIdx) {
     idx = shellIdx*6 + 2;
     if(gammaEnergy > (*(fParam[Z]))[idx-1]) {
       G4double cs = (*(fParam[Z]))[idx] + x1*(*(fParam[Z]))[idx+1] 
         + x2*(*(fParam[Z]))[idx+2] + x3*(*(fParam[Z]))[idx+3] 
         + x4*(*(fParam[Z]))[idx+4];
       if(cs >= cs0) { break; }
     }
       }
       if(shellIdx >= nn) { shellIdx = nn-1; }
 
     } else {
 
       // when do sampling common factors are not taken into account
       // so cross section is not real
       G4double cs = G4UniformRand();
 
       if(gammaEnergy >= (*(fParam[Z]))[1]) {
     cs *= (fCrossSection[Z])->Value(gammaEnergy);
       } else {
     cs *= (fCrossSectionLE[Z])->Value(gammaEnergy);
       }
 
       for(size_t j=0; j<nn; ++j) {
     shellIdx = (size_t)fShellCrossSection->GetComponentID(Z, j);
     if(gammaEnergy > (*(fParam[Z]))[6*shellIdx+1]) {
       cs -= fShellCrossSection->GetValueForComponent(Z, j, gammaEnergy);
     }
     if(cs <= 0.0 || j+1 == nn) { break; }
       }
     }
   }
 
   G4double bindingEnergy = (*(fParam[Z]))[shellIdx*6 + 1];
   //G4cout << "Z= " << Z << " shellIdx= " << shellIdx 
   //       << " nShells= " << fNShells[Z] 
   //       << " Ebind(keV)= " << bindingEnergy/keV 
   //       << " Egamma(keV)= " << gammaEnergy/keV << G4endl;
 
   const G4AtomicShell* shell = 0;
 
   // no de-excitation from the last shell
   if(fDeexcitationActive && shellIdx + 1 < nn) {
     G4AtomicShellEnumerator as = G4AtomicShellEnumerator(shellIdx);
     shell = fAtomDeexcitation->GetAtomicShell(Z, as);
   }
 
   // If binding energy of the selected shell is larger than photon energy
   //    do not generate secondaries
   if(gammaEnergy < bindingEnergy) {
     fParticleChange->ProposeLocalEnergyDeposit(gammaEnergy);
     return;
   }
 
   // Primary outcoming electron
   G4double eKineticEnergy = gammaEnergy - bindingEnergy;
   G4double edep = bindingEnergy;
 
   // Calculate direction of the photoelectron
   G4ThreeVector electronDirection = 
     GetAngularDistribution()->SampleDirection(aDynamicGamma, 
                           eKineticEnergy,
                           shellIdx, 
                           couple->GetMaterial());
 
   // The electron is created 
   G4DynamicParticle* electron = new G4DynamicParticle (theElectron,
                                electronDirection,
                                eKineticEnergy);
   fvect->push_back(electron);
 
   // Sample deexcitation
   if(shell) {
     G4int index = couple->GetIndex();
     if(fAtomDeexcitation->CheckDeexcitationActiveRegion(index)) {
       G4int nbefore = fvect->size();
 
       fAtomDeexcitation->GenerateParticles(fvect, shell, Z, index);
       G4int nafter = fvect->size();
       if(nafter > nbefore) {
     G4double esec = 0.0;
     for (G4int j=nbefore; j<nafter; ++j) {
 
       G4double e = ((*fvect)[j])->GetKineticEnergy();
       if(esec + e > edep) {
         // correct energy in order to have energy balance
         e = edep - esec;
         ((*fvect)[j])->SetKineticEnergy(e);
         esec += e;
         // delete the rest of secondaries (should not happens)
         for (G4int jj=nafter-1; jj>j; --jj) { 
           delete (*fvect)[jj]; 
           fvect->pop_back(); 
         }
         break;        
       }
       esec += e; 
     }
         edep -= esec;
       }
     }
   }
   // energy balance - excitation energy left
   if(edep > 0.0) {
     fParticleChange->ProposeLocalEnergyDeposit(edep);
   }
 }

Here is the call graph for this function:

void G4LivermorePhotoElectricModel::SetLimitNumberOfShells ( G4int n )

inline

Definition at line 122 of file G4LivermorePhotoElectricModel.hh.

 {
   nShellLimit = n;
 }

Member Data Documentation

G4ParticleChangeForGamma* G4LivermorePhotoElectricModel::fParticleChange

protected

Definition at line 88 of file G4LivermorePhotoElectricModel.hh.

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

source/geant4.10.03.p02/source/processes/electromagnetic/lowenergy/include/G4LivermorePhotoElectricModel.hh
source/geant4.10.03.p02/source/processes/electromagnetic/lowenergy/src/G4LivermorePhotoElectricModel.cc

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation