#include <G4LowEnergyPhotoElectric.hh>

Inheritance diagram for G4LowEnergyPhotoElectric:

Public Member Functions
	G4LowEnergyPhotoElectric (const G4String &processName="LowEnPhotoElec")

	~G4LowEnergyPhotoElectric ()

G4bool	IsApplicable (const G4ParticleDefinition &)

void	BuildPhysicsTable (const G4ParticleDefinition &photon)

G4VParticleChange *	PostStepDoIt (const G4Track &aTrack, const G4Step &aStep)

void	SetCutForLowEnSecPhotons (G4double)

void	SetCutForLowEnSecElectrons (G4double)

void	ActivateAuger (G4bool)

void	SetAngularGenerator (G4RDVPhotoElectricAngularDistribution *distribution)

void	SetAngularGenerator (const G4String &name)

G4double	DumpMeanFreePath (const G4Track &aTrack, G4double previousStepSize, G4ForceCondition *condition)

Public Member Functions inherited from G4VDiscreteProcess
	G4VDiscreteProcess (const G4String &, G4ProcessType aType=fNotDefined)

	G4VDiscreteProcess (G4VDiscreteProcess &)

virtual	~G4VDiscreteProcess ()

virtual G4double	PostStepGetPhysicalInteractionLength (const G4Track &track, G4double previousStepSize, G4ForceCondition *condition)

virtual G4double	AlongStepGetPhysicalInteractionLength (const G4Track &, G4double, G4double, G4double &, G4GPILSelection *)

virtual G4double	AtRestGetPhysicalInteractionLength (const G4Track &, G4ForceCondition *)

virtual G4VParticleChange *	AtRestDoIt (const G4Track &, const G4Step &)

virtual G4VParticleChange *	AlongStepDoIt (const G4Track &, const G4Step &)

Public Member Functions inherited from G4VProcess
	G4VProcess (const G4String &aName="NoName", G4ProcessType aType=fNotDefined)

	G4VProcess (const G4VProcess &right)

virtual	~G4VProcess ()

G4int	operator== (const G4VProcess &right) const

G4int	operator!= (const G4VProcess &right) const

G4double	GetCurrentInteractionLength () const

void	SetPILfactor (G4double value)

G4double	GetPILfactor () const

G4double	AlongStepGPIL (const G4Track &track, G4double previousStepSize, G4double currentMinimumStep, G4double &proposedSafety, G4GPILSelection *selection)

G4double	AtRestGPIL (const G4Track &track, G4ForceCondition *condition)

G4double	PostStepGPIL (const G4Track &track, G4double previousStepSize, G4ForceCondition *condition)

virtual void	PreparePhysicsTable (const G4ParticleDefinition &)

virtual G4bool	StorePhysicsTable (const G4ParticleDefinition *, const G4String &, G4bool)

virtual G4bool	RetrievePhysicsTable (const G4ParticleDefinition *, const G4String &, G4bool)

const G4String &	GetPhysicsTableFileName (const G4ParticleDefinition *, const G4String &directory, const G4String &tableName, G4bool ascii=false)

const G4String &	GetProcessName () const

G4ProcessType	GetProcessType () const

void	SetProcessType (G4ProcessType)

G4int	GetProcessSubType () const

void	SetProcessSubType (G4int)

virtual void	StartTracking (G4Track *)

virtual void	EndTracking ()

virtual void	SetProcessManager (const G4ProcessManager *)

virtual const G4ProcessManager *	GetProcessManager ()

virtual void	ResetNumberOfInteractionLengthLeft ()

G4double	GetNumberOfInteractionLengthLeft () const

G4double	GetTotalNumberOfInteractionLengthTraversed () const

G4bool	isAtRestDoItIsEnabled () const

G4bool	isAlongStepDoItIsEnabled () const

G4bool	isPostStepDoItIsEnabled () const

virtual void	DumpInfo () const

void	SetVerboseLevel (G4int value)

G4int	GetVerboseLevel () const

virtual void	SetMasterProcess (G4VProcess *masterP)

const G4VProcess *	GetMasterProcess () const

virtual void	BuildWorkerPhysicsTable (const G4ParticleDefinition &part)

virtual void	PrepareWorkerPhysicsTable (const G4ParticleDefinition &)

Protected Member Functions
G4double	GetMeanFreePath (const G4Track &aTrack, G4double previousStepSize, G4ForceCondition *condition)

Protected Member Functions inherited from G4VProcess
void	SubtractNumberOfInteractionLengthLeft (G4double previousStepSize)

void	ClearNumberOfInteractionLengthLeft ()

Additional Inherited Members
Static Public Member Functions inherited from G4VProcess
static const G4String &	GetProcessTypeName (G4ProcessType)

Protected Attributes inherited from G4VProcess
const G4ProcessManager *	aProcessManager

G4VParticleChange *	pParticleChange

G4ParticleChange	aParticleChange

G4double	theNumberOfInteractionLengthLeft

G4double	currentInteractionLength

G4double	theInitialNumberOfInteractionLength

G4String	theProcessName

G4String	thePhysicsTableFileName

G4ProcessType	theProcessType

G4int	theProcessSubType

G4double	thePILfactor

G4bool	enableAtRestDoIt

G4bool	enableAlongStepDoIt

G4bool	enablePostStepDoIt

G4int	verboseLevel

Detailed Description

Definition at line 65 of file G4LowEnergyPhotoElectric.hh.

Constructor & Destructor Documentation

G4LowEnergyPhotoElectric::G4LowEnergyPhotoElectric ( const G4String & processName = "LowEnPhotoElec" )

Definition at line 97 of file G4LowEnergyPhotoElectric.cc.

References FatalException, G4cout, G4endl, G4Exception(), G4VProcess::GetProcessName(), python.hepunit::GeV, python.hepunit::keV, and G4VProcess::verboseLevel.

   : G4VDiscreteProcess(processName), lowEnergyLimit(250*eV), highEnergyLimit(100*GeV),
     intrinsicLowEnergyLimit(10*eV),
     intrinsicHighEnergyLimit(100*GeV),
     cutForLowEnergySecondaryPhotons(250.*eV),
     cutForLowEnergySecondaryElectrons(250.*eV)
 {
   if (lowEnergyLimit < intrinsicLowEnergyLimit || 
       highEnergyLimit > intrinsicHighEnergyLimit)
     {
       G4Exception("G4LowEnergyPhotoElectric::G4LowEnergyPhotoElectric()",
                   "OutOfRange", FatalException,
                   "Energy limit outside intrinsic process validity range!");
     }
 
   crossSectionHandler = new G4RDCrossSectionHandler();
   shellCrossSectionHandler = new G4RDCrossSectionHandler();
   meanFreePathTable = 0;
   rangeTest = new G4RDRangeNoTest;
   generatorName = "geant4.6.2";
   ElectronAngularGenerator = new G4RDPhotoElectricAngularGeneratorSimple("GEANTSimpleGenerator");              // default generator
 
 
   if (verboseLevel > 0)
     {
       G4cout << GetProcessName() << " is created " << G4endl
          << "Energy range: "
          << lowEnergyLimit / keV << " keV - "
          << highEnergyLimit / GeV << " GeV"
          << G4endl;
     }
 }

G4LowEnergyPhotoElectric::~G4LowEnergyPhotoElectric ( )

Definition at line 130 of file G4LowEnergyPhotoElectric.cc.

 {
   delete crossSectionHandler;
   delete shellCrossSectionHandler;
   delete meanFreePathTable;
   delete rangeTest;
   delete ElectronAngularGenerator;
 }

Member Function Documentation

void G4LowEnergyPhotoElectric::ActivateAuger ( G4bool val )

Definition at line 359 of file G4LowEnergyPhotoElectric.cc.

References G4RDAtomicDeexcitation::ActivateAugerElectronProduction().

Referenced by eRositaPhysicsList::ConstructEM().

 {
   deexcitationManager.ActivateAugerElectronProduction(val);
 }

void G4LowEnergyPhotoElectric::BuildPhysicsTable ( const G4ParticleDefinition & photon )

virtual

Reimplemented from G4VProcess.

Definition at line 139 of file G4LowEnergyPhotoElectric.cc.

References G4RDVCrossSectionHandler::BuildMeanFreePathForMaterials(), G4RDVCrossSectionHandler::Clear(), G4RDVCrossSectionHandler::LoadData(), and G4RDVCrossSectionHandler::LoadShellData().

 {
 
   crossSectionHandler->Clear();
   G4String crossSectionFile = "phot/pe-cs-";
   crossSectionHandler->LoadData(crossSectionFile);
 
   shellCrossSectionHandler->Clear();
   G4String shellCrossSectionFile = "phot/pe-ss-cs-";
   shellCrossSectionHandler->LoadShellData(shellCrossSectionFile);
 
   delete meanFreePathTable;
   meanFreePathTable = crossSectionHandler->BuildMeanFreePathForMaterials();
 }

G4double G4LowEnergyPhotoElectric::DumpMeanFreePath	(	const G4Track &	aTrack,
		G4double	previousStepSize,
		G4ForceCondition *	condition
	)

inline

Definition at line 91 of file G4LowEnergyPhotoElectric.hh.

References GetMeanFreePath().

94 { return GetMeanFreePath(aTrack, previousStepSize, condition); }

condition

G4double condition(const G4ErrorSymMatrix &m)

G4LowEnergyPhotoElectric::GetMeanFreePath

G4double GetMeanFreePath(const G4Track &aTrack, G4double previousStepSize, G4ForceCondition *condition)

Definition: G4LowEnergyPhotoElectric.cc:325

G4double G4LowEnergyPhotoElectric::GetMeanFreePath	(	const G4Track &	aTrack,
		G4double	previousStepSize,
		G4ForceCondition *	condition
	)

protectedvirtual

Implements G4VDiscreteProcess.

Definition at line 325 of file G4LowEnergyPhotoElectric.cc.

References DBL_MAX, energy(), G4Track::GetDynamicParticle(), G4DynamicParticle::GetKineticEnergy(), G4Track::GetMaterial(), eplot::material, photon, and G4RDVCrossSectionHandler::ValueForMaterial().

Referenced by DumpMeanFreePath().

 {
   const G4DynamicParticle* photon = track.GetDynamicParticle();
   G4double energy = photon->GetKineticEnergy();
   G4Material* material = track.GetMaterial();
   //  size_t materialIndex = material->GetIndex();
 
   G4double meanFreePath = DBL_MAX;
 
   //  if (energy > highEnergyLimit) 
   //    meanFreePath = meanFreePathTable->FindValue(highEnergyLimit,materialIndex);
   //  else if (energy < lowEnergyLimit) meanFreePath = DBL_MAX;
   //  else meanFreePath = meanFreePathTable->FindValue(energy,materialIndex);
 
   G4double cross = shellCrossSectionHandler->ValueForMaterial(material,energy);
   if(cross > 0.0) meanFreePath = 1.0/cross;
 
   return meanFreePath;
 }

G4bool G4LowEnergyPhotoElectric::IsApplicable ( const G4ParticleDefinition & particle )

virtual

Reimplemented from G4VProcess.

Definition at line 320 of file G4LowEnergyPhotoElectric.cc.

References G4Gamma::Gamma().

 {
   return ( &particle == G4Gamma::Gamma() );
 }

G4VParticleChange * G4LowEnergyPhotoElectric::PostStepDoIt	(	const G4Track &	aTrack,
		const G4Step &	aStep
	)

virtual

Reimplemented from G4VDiscreteProcess.

Definition at line 154 of file G4LowEnergyPhotoElectric.cc.

References G4ParticleChange::AddSecondary(), G4VProcess::aParticleChange, G4InuclSpecialFunctions::bindingEnergy(), G4RDAtomicShell::BindingEnergy(), G4InuclParticleNames::electron, G4Electron::Electron(), G4RDVRangeTest::Escape(), fStopAndKill, G4cout, G4endl, G4RDAtomicDeexcitation::GenerateParticles(), G4DynamicParticle::GetDefinition(), G4Track::GetDynamicParticle(), G4ProductionCutsTable::GetEnergyCutsVector(), G4MaterialCutsCouple::GetIndex(), G4DynamicParticle::GetKineticEnergy(), G4Track::GetMaterialCutsCouple(), G4DynamicParticle::GetMomentumDirection(), G4RDVPhotoElectricAngularDistribution::GetPhotoElectronDirection(), G4DynamicParticle::GetPolarization(), G4Step::GetPostStepPoint(), G4ProductionCutsTable::GetProductionCutsTable(), G4StepPoint::GetSafety(), G4ParticleChange::Initialize(), G4RDAtomicTransitionManager::Instance(), G4INCL::Math::min(), G4VDiscreteProcess::PostStepDoIt(), G4ParticleChange::ProposeEnergy(), G4VParticleChange::ProposeLocalEnergyDeposit(), G4ParticleChange::ProposeMomentumDirection(), G4VParticleChange::ProposeTrackStatus(), G4RDVCrossSectionHandler::SelectRandomAtom(), G4RDVCrossSectionHandler::SelectRandomShell(), G4VParticleChange::SetNumberOfSecondaries(), G4RDAtomicTransitionManager::Shell(), and G4RDAtomicShell::ShellId().

 {
   // Fluorescence generated according to:
   // J. Stepanek ,"A program to determine the radiation spectra due to a single atomic
   // subshell ionisation by a particle or due to deexcitation or decay of radionuclides", 
   // Comp. Phys. Comm. 1206 pp 1-1-9 (1997)
  
   aParticleChange.Initialize(aTrack);
   
   const G4DynamicParticle* incidentPhoton = aTrack.GetDynamicParticle();
   G4double photonEnergy = incidentPhoton->GetKineticEnergy();
   if (photonEnergy <= lowEnergyLimit)
     {
       aParticleChange.ProposeTrackStatus(fStopAndKill);
       aParticleChange.ProposeEnergy(0.);
       aParticleChange.ProposeLocalEnergyDeposit(photonEnergy);
       return G4VDiscreteProcess::PostStepDoIt(aTrack,aStep);
     }
  
   G4ThreeVector photonDirection = incidentPhoton->GetMomentumDirection(); // Returns the normalized direction of the momentum
 
   // Select randomly one element in the current material
   const G4MaterialCutsCouple* couple = aTrack.GetMaterialCutsCouple();
   G4int Z = crossSectionHandler->SelectRandomAtom(couple,photonEnergy);
 
   // Select the ionised shell in the current atom according to shell cross sections
   size_t shellIndex = shellCrossSectionHandler->SelectRandomShell(Z,photonEnergy);
 
   // Retrieve the corresponding identifier and binding energy of the selected shell
   const G4RDAtomicTransitionManager* transitionManager = G4RDAtomicTransitionManager::Instance();
   const G4RDAtomicShell* shell = transitionManager->Shell(Z,shellIndex);
   G4double bindingEnergy = shell->BindingEnergy();
   G4int shellId = shell->ShellId();
 
   // Create lists of pointers to DynamicParticles (photons and electrons)
   // (Is the electron vector necessary? To be checked)
   std::vector<G4DynamicParticle*>* photonVector = 0;
   std::vector<G4DynamicParticle*> electronVector;
 
   G4double energyDeposit = 0.0;
 
   // Primary outcoming electron
   G4double eKineticEnergy = photonEnergy - bindingEnergy;
 
   // There may be cases where the binding energy of the selected shell is > photon energy
   // In such cases do not generate secondaries
   if (eKineticEnergy > 0.)
     {
       // Generate the electron only if with large enough range w.r.t. cuts and safety
       G4double safety = aStep.GetPostStepPoint()->GetSafety();
 
       if (rangeTest->Escape(G4Electron::Electron(),couple,eKineticEnergy,safety))
     {
 
       // Calculate direction of the photoelectron
       G4ThreeVector gammaPolarization = incidentPhoton->GetPolarization();
       G4ThreeVector electronDirection = ElectronAngularGenerator->GetPhotoElectronDirection(photonDirection,eKineticEnergy,gammaPolarization,shellId);
 
       // The electron is created ...
       G4DynamicParticle* electron = new G4DynamicParticle (G4Electron::Electron(),
                                    electronDirection,
                                    eKineticEnergy);
       electronVector.push_back(electron);
     }
       else
     {
       energyDeposit += eKineticEnergy;
     }
     }
   else
     {
       bindingEnergy = photonEnergy;
     }
 
   G4int nElectrons = electronVector.size();
   size_t nTotPhotons = 0;
   G4int nPhotons=0;
   const G4ProductionCutsTable* theCoupleTable=
         G4ProductionCutsTable::GetProductionCutsTable();
 
   size_t index = couple->GetIndex();
   G4double cutg = (*(theCoupleTable->GetEnergyCutsVector(0)))[index];
   cutg = std::min(cutForLowEnergySecondaryPhotons,cutg);
   
   G4double cute = (*(theCoupleTable->GetEnergyCutsVector(1)))[index];
   cute = std::min(cutForLowEnergySecondaryPhotons,cute);
 
   G4DynamicParticle* aPhoton;
 
   // Generation of fluorescence
   // Data in EADL are available only for Z > 5
   // Protection to avoid generating photons in the unphysical case of
   // shell binding energy > photon energy
   if (Z > 5  && (bindingEnergy > cutg || bindingEnergy > cute))
     {
       photonVector = deexcitationManager.GenerateParticles(Z,shellId);
       nTotPhotons = photonVector->size();
       for (size_t k=0; k<nTotPhotons; k++)
     {
       aPhoton = (*photonVector)[k];
       if (aPhoton)
         {
               G4double itsCut = cutg;
               if(aPhoton->GetDefinition() == G4Electron::Electron()) itsCut = cute;
           G4double itsEnergy = aPhoton->GetKineticEnergy();
 
           if (itsEnergy > itsCut && itsEnergy <= bindingEnergy)
         {
           nPhotons++;
           // Local energy deposit is given as the sum of the
           // energies of incident photons minus the energies
           // of the outcoming fluorescence photons
           bindingEnergy -= itsEnergy;
 
         }
           else
         {
                   delete aPhoton;
                   (*photonVector)[k] = 0;
                 }
         }
     }
     }
 
   energyDeposit += bindingEnergy;
 
   G4int nSecondaries  = nElectrons + nPhotons;
   aParticleChange.SetNumberOfSecondaries(nSecondaries);
 
   for (G4int l = 0; l<nElectrons; l++ )
     {
       aPhoton = electronVector[l];
       if(aPhoton) {
         aParticleChange.AddSecondary(aPhoton);
       }
     }
   for ( size_t ll = 0; ll < nTotPhotons; ll++)
     {
       aPhoton = (*photonVector)[ll];
       if(aPhoton) {
         aParticleChange.AddSecondary(aPhoton);
       }
     }
 
   delete photonVector;
 
   if (energyDeposit < 0)
     {
       G4cout << "WARNING - "
          << "G4LowEnergyPhotoElectric::PostStepDoIt - Negative energy deposit"
          << G4endl;
       energyDeposit = 0;
     }
 
   // Kill the incident photon
   aParticleChange.ProposeMomentumDirection( 0., 0., 0. );
   aParticleChange.ProposeEnergy( 0. );
 
   aParticleChange.ProposeLocalEnergyDeposit(energyDeposit);
   aParticleChange.ProposeTrackStatus( fStopAndKill );
 
   // Reset NbOfInteractionLengthLeft and return aParticleChange
   return G4VDiscreteProcess::PostStepDoIt( aTrack, aStep );
 }

void G4LowEnergyPhotoElectric::SetAngularGenerator ( G4RDVPhotoElectricAngularDistribution * distribution )

Definition at line 364 of file G4LowEnergyPhotoElectric.cc.

References G4RDVPhotoElectricAngularDistribution::PrintGeneratorInformation().

 {
   ElectronAngularGenerator = distribution;
   ElectronAngularGenerator->PrintGeneratorInformation();
 }

void G4LowEnergyPhotoElectric::SetAngularGenerator ( const G4String & name )

Definition at line 370 of file G4LowEnergyPhotoElectric.cc.

References FatalException, G4Exception(), and G4RDVPhotoElectricAngularDistribution::PrintGeneratorInformation().

 {
   if (name == "default") 
     {
       delete ElectronAngularGenerator;
       ElectronAngularGenerator = new G4RDPhotoElectricAngularGeneratorSimple("GEANT4LowEnergySimpleGenerator");
       generatorName = name;
     }
   else if (name == "standard")
     {
       delete ElectronAngularGenerator;
       ElectronAngularGenerator = new G4RDPhotoElectricAngularGeneratorSauterGavrila("GEANT4SauterGavrilaGenerator");
       generatorName = name;
     }
   else if (name == "polarized")
     {
       delete ElectronAngularGenerator;
       ElectronAngularGenerator = new G4RDPhotoElectricAngularGeneratorPolarized("GEANT4LowEnergyPolarizedGenerator");
       generatorName = name;
     }
   else
     {
       G4Exception("G4LowEnergyPhotoElectric::SetAngularGenerator()",
                   "InvalidSetup", FatalException,
                   "Generator does not exist!");
     }
 
   ElectronAngularGenerator->PrintGeneratorInformation();
 }

void G4LowEnergyPhotoElectric::SetCutForLowEnSecElectrons ( G4double cut )

Definition at line 353 of file G4LowEnergyPhotoElectric.cc.

References G4RDAtomicDeexcitation::SetCutForAugerElectrons().

Referenced by eRositaPhysicsList::ConstructEM().

 {
   cutForLowEnergySecondaryElectrons = cut;
   deexcitationManager.SetCutForAugerElectrons(cut);
 }

void G4LowEnergyPhotoElectric::SetCutForLowEnSecPhotons ( G4double cut )

Definition at line 347 of file G4LowEnergyPhotoElectric.cc.

References G4RDAtomicDeexcitation::SetCutForSecondaryPhotons().

Referenced by eRositaPhysicsList::ConstructEM().

 {
   cutForLowEnergySecondaryPhotons = cut;
   deexcitationManager.SetCutForSecondaryPhotons(cut);
 }

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation