G4UAtomicDeexcitation Class Reference

#include <G4UAtomicDeexcitation.hh>

Inheritance diagram for G4UAtomicDeexcitation:

Public Member Functions
	G4UAtomicDeexcitation ()
virtual	~G4UAtomicDeexcitation ()
void	InitialiseForNewRun () override
	initialisation methods
void	InitialiseForExtraAtom (G4int Z) override
void	SetCutForSecondaryPhotons (G4double cut)
	Set threshold energy for fluorescence.
void	SetCutForAugerElectrons (G4double cut)
	Set threshold energy for Auger electron production.
const G4AtomicShell *	GetAtomicShell (G4int Z, G4AtomicShellEnumerator shell) override
void	GenerateParticles (std::vector< G4DynamicParticle * > *secVect, const G4AtomicShell *, G4int Z, G4double gammaCut, G4double eCut) override
	generation of deexcitation for given atom, shell vacancy and cuts
G4double	GetShellIonisationCrossSectionPerAtom (const G4ParticleDefinition *, G4int Z, G4AtomicShellEnumerator shell, G4double kinE, const G4Material *mat=nullptr) override
	access or compute PIXE cross section
G4double	ComputeShellIonisationCrossSectionPerAtom (const G4ParticleDefinition *, G4int Z, G4AtomicShellEnumerator shell, G4double kinE, const G4Material *mat=nullptr) override
	access or compute PIXE cross section
	G4UAtomicDeexcitation (G4UAtomicDeexcitation &)=delete
G4UAtomicDeexcitation &	operator= (const G4UAtomicDeexcitation &right)=delete
Public Member Functions inherited from G4VAtomDeexcitation
	G4VAtomDeexcitation (const G4String &modname="Deexcitation")
virtual	~G4VAtomDeexcitation ()
void	InitialiseAtomicDeexcitation ()
virtual void	InitialiseForNewRun ()=0
virtual void	InitialiseForExtraAtom (G4int Z)=0
void	SetDeexcitationActiveRegion (const G4String &rname, G4bool valDeexcitation, G4bool valAuger, G4bool valPIXE)
void	SetFluo (G4bool)
G4bool	IsFluoActive () const
void	SetAuger (G4bool)
G4bool	IsAugerActive () const
void	SetAugerCascade (G4bool)
G4bool	IsAugerCascadeActive () const
void	SetPIXE (G4bool)
G4bool	IsPIXEActive () const
const G4String &	GetName () const
const std::vector< G4bool > &	GetListOfActiveAtoms () const
void	SetVerboseLevel (G4int)
G4int	GetVerboseLevel () const
G4bool	CheckDeexcitationActiveRegion (G4int coupleIndex)
G4bool	CheckAugerActiveRegion (G4int coupleIndex)
virtual const G4AtomicShell *	GetAtomicShell (G4int Z, G4AtomicShellEnumerator shell)=0
void	GenerateParticles (std::vector< G4DynamicParticle * > *secVect, const G4AtomicShell *, G4int Z, G4int coupleIndex)
virtual void	GenerateParticles (std::vector< G4DynamicParticle * > *secVect, const G4AtomicShell *, G4int Z, G4double gammaCut, G4double eCut)=0
virtual G4double	GetShellIonisationCrossSectionPerAtom (const G4ParticleDefinition *, G4int Z, G4AtomicShellEnumerator shell, G4double kinE, const G4Material *mat=nullptr)=0
virtual G4double	ComputeShellIonisationCrossSectionPerAtom (const G4ParticleDefinition *, G4int Z, G4AtomicShellEnumerator shell, G4double kinE, const G4Material *mat=nullptr)=0
void	AlongStepDeexcitation (std::vector< G4Track * > &tracks, const G4Step &step, G4double &eLoss, G4int coupleIndex)
	G4VAtomDeexcitation (G4VAtomDeexcitation &)=delete
G4VAtomDeexcitation &	operator= (const G4VAtomDeexcitation &right)=delete

Detailed Description

Definition at line 60 of file G4UAtomicDeexcitation.hh.

Constructor & Destructor Documentation

G4UAtomicDeexcitation() [1/2]

G4UAtomicDeexcitation::G4UAtomicDeexcitation ( )

explicit

Definition at line 77 of file G4UAtomicDeexcitation.cc.

                                            :
  G4VAtomDeexcitation("UAtomDeexcitation"),
  minGammaEnergy(DBL_MAX), 
  minElectronEnergy(DBL_MAX),
  newShellId(-1)
{
  anaPIXEshellCS = nullptr;
  PIXEshellCS    = nullptr;
  ePIXEshellCS   = nullptr;
  emcorr = G4LossTableManager::Instance()->EmCorrections();
  theElectron = G4Electron::Electron();
  thePositron = G4Positron::Positron();
  transitionManager = G4AtomicTransitionManager::Instance();
}

~G4UAtomicDeexcitation()

G4UAtomicDeexcitation::~G4UAtomicDeexcitation ( )

virtual

Definition at line 94 of file G4UAtomicDeexcitation.cc.

{
  delete anaPIXEshellCS;
  delete PIXEshellCS;
  delete ePIXEshellCS;
}

G4UAtomicDeexcitation() [2/2]

G4UAtomicDeexcitation::G4UAtomicDeexcitation ( G4UAtomicDeexcitation &  )

delete

Member Function Documentation

ComputeShellIonisationCrossSectionPerAtom()

G4double G4UAtomicDeexcitation::ComputeShellIonisationCrossSectionPerAtom ( const G4ParticleDefinition *  p, G4int  Z, G4AtomicShellEnumerator  shell, G4double  kinE, const G4Material *  mat = nullptr  )

overridevirtual

access or compute PIXE cross section

Implements G4VAtomDeexcitation.

Definition at line 369 of file G4UAtomicDeexcitation.cc.

{
  return GetShellIonisationCrossSectionPerAtom(p,Z,shell,kinE,mat);
}

GenerateParticles()

void G4UAtomicDeexcitation::GenerateParticles ( std::vector< G4DynamicParticle * > *  secVect, const G4AtomicShell *  atomicShell, G4int  Z, G4double  gammaCut, G4double  eCut  )

overridevirtual

generation of deexcitation for given atom, shell vacancy and cuts

Implements G4VAtomDeexcitation.

Definition at line 186 of file G4UAtomicDeexcitation.cc.

{
  // Defined initial conditions
  G4int givenShellId = atomicShell->ShellId();
  minGammaEnergy = gammaCut;
  minElectronEnergy = eCut;
 
  // generation secondaries
  G4DynamicParticle* aParticle=0;
  G4int provShellId = 0;
  
  //ORIGINAL METHOD BY ALFONSO MANTERO
  if (!IsAugerCascadeActive())
    {
      //----------------------------  
      G4int counter = 0;
      
      // limits of the EPDL data
      if (Z>5 && Z<105) {
 
    // The aim of this loop is to generate more than one fluorecence photon 
    // from the same ionizing event 
    do
      {
        if (counter == 0) 
          // First call to GenerateParticles(...):
          // givenShellId is given by the process
          {
        provShellId = SelectTypeOfTransition(Z, givenShellId);
        
        if (provShellId >0) 
          {
            aParticle =
              GenerateFluorescence(Z, givenShellId, provShellId);
          }
        else if (provShellId == -1)
          {
            aParticle = GenerateAuger(Z, givenShellId);
          }
          }
        else 
          // Following calls to GenerateParticles(...):
          // newShellId is given by GenerateFluorescence(...)
          {
        provShellId = SelectTypeOfTransition(Z,newShellId);
        if (provShellId >0)
          {
            aParticle = GenerateFluorescence(Z,newShellId,provShellId);
          }
        else if ( provShellId == -1)
          {
            aParticle = GenerateAuger(Z, newShellId);       
          }
          }
        ++counter;
        if (aParticle != 0) 
          {
        vectorOfParticles->push_back(aParticle);
          }
        else {provShellId = -2;}
      }  
    while (provShellId > -2); 
      }
    } // Auger cascade is not active
 
  //END OF ORIGINAL METHOD BY ALFONSO MANTERO
  //----------------------
 
  // NEW METHOD
  // Auger cascade by Burkhant Suerfu on March 24 2015 (Bugzilla 1727)
  if (IsAugerCascadeActive())
    {
      //----------------------
      vacancyArray.push_back(givenShellId);
 
      // let's check that 5<Z<100
      if (Z<6 || Z>104){
    return;
      }
 
      // as long as there is vacancy to be filled by either fluo or auger, stay in the loop.
      while(!vacancyArray.empty()){
    //  prepare to process the last element, and then delete it from the vector.
    givenShellId = vacancyArray[0];
    provShellId = SelectTypeOfTransition(Z,givenShellId);
 
    //G4cout<<"\n------ Atom Transition with Z: "<<Z<<"\tbetween current:"
    //      <<givenShellId<<" & target:"<<provShellId<<G4endl;
    if(provShellId>0){
      aParticle = GenerateFluorescence(Z,givenShellId,provShellId);
    }
    else if(provShellId == -1){
      aParticle = GenerateAuger(Z, givenShellId);
    }
    //  if a particle is created, put it in the vector of new particles
    if(aParticle!=0)
      vectorOfParticles->push_back(aParticle);
 
    //  one vacancy has been processed. Erase it.
    vacancyArray.erase(vacancyArray.begin());
      }
      //----------------------
      //End of Auger cascade by Burkhant Suerfu on March 24 2015 (Bugzilla 1727)
 
    } // Auger cascade is active
}

GetAtomicShell()

const G4AtomicShell * G4UAtomicDeexcitation::GetAtomicShell ( G4int  Z, G4AtomicShellEnumerator  shell  )

overridevirtual

Get atomic shell by shell index, used by discrete processes (for example, photoelectric), when shell vacancy sampled by the model

Implements G4VAtomDeexcitation.

Definition at line 179 of file G4UAtomicDeexcitation.cc.

{
  return transitionManager->Shell(Z, (std::size_t)shell);
}

GetShellIonisationCrossSectionPerAtom()

G4double G4UAtomicDeexcitation::GetShellIonisationCrossSectionPerAtom ( const G4ParticleDefinition *  pdef, G4int  Z, G4AtomicShellEnumerator  shell, G4double  kinE, const G4Material *  mat = nullptr  )

overridevirtual

access or compute PIXE cross section

Implements G4VAtomDeexcitation.

Definition at line 301 of file G4UAtomicDeexcitation.cc.

{
  // we must put a control on the shell that are passed: 
  // some shells should not pass (line "0" or "2")
 
  // check atomic number
  G4double xsec = 0.0;
  if(Z > 93 || Z < 6 ) { return xsec; } //corrected by alf - Z<6 missing
  G4int idx = G4int(shellEnum);
  if(idx >= G4AtomicShells::GetNumberOfShells(Z)) { return xsec; }
 
  if(pdef == theElectron || pdef == thePositron) {
    xsec = ePIXEshellCS->CrossSection(Z,shellEnum,kineticEnergy,0.0,mat);
    return xsec;
  }
 
  G4double mass = pdef->GetPDGMass();
  G4double escaled = kineticEnergy;
  G4double q2 = 0.0;
 
  // scaling to protons for all particles excluding protons and alpha
  G4int pdg = pdef->GetPDGEncoding();
  if (pdg != 2212 && pdg != 1000020040)
    {
      mass = proton_mass_c2;
      escaled = kineticEnergy*mass/(pdef->GetPDGMass());
 
      if(mat) {
    q2 = emcorr->EffectiveChargeSquareRatio(pdef,mat,kineticEnergy);
      } else {
    G4double q = pdef->GetPDGCharge()/eplus;
    q2 = q*q;
      }
    }
  
  if(PIXEshellCS) {
    xsec = PIXEshellCS->CrossSection(Z,shellEnum,escaled,mass,mat);
  }
  if(xsec < 1e-100) {     
    xsec = anaPIXEshellCS->CrossSection(Z,shellEnum,escaled,mass,mat); 
  }
 
  if (q2)  {xsec *= q2;}
 
  return xsec;
}

Referenced by ComputeShellIonisationCrossSectionPerAtom().

InitialiseForExtraAtom()

void G4UAtomicDeexcitation::InitialiseForExtraAtom ( G4int  Z )

overridevirtual

Implements G4VAtomDeexcitation.

Definition at line 173 of file G4UAtomicDeexcitation.cc.

{}

InitialiseForNewRun()

void G4UAtomicDeexcitation::InitialiseForNewRun ( )

overridevirtual

initialisation methods

Implements G4VAtomDeexcitation.

Definition at line 103 of file G4UAtomicDeexcitation.cc.

{
  if(!IsFluoActive()) { return; }
  transitionManager->Initialise();
  if(!IsPIXEActive()) { return; }
 
  if(!anaPIXEshellCS) {
    anaPIXEshellCS = new G4teoCrossSection("ECPSSR_Analytical");
  }
  G4cout << G4endl;
  G4cout << "### === G4UAtomicDeexcitation::InitialiseForNewRun()" << G4endl;
 
  G4EmParameters* param = G4EmParameters::Instance();
  G4String namePIXExsModel = param->PIXECrossSectionModel();
  G4String namePIXExsElectronModel = param->PIXEElectronCrossSectionModel();
 
  // Check if old cross section for p/ion should be deleted 
  if(PIXEshellCS && namePIXExsModel != PIXEshellCS->GetName()) 
    {
      delete PIXEshellCS;
      PIXEshellCS = nullptr;
    }
 
  // Instantiate new proton/ion cross section
  if(!PIXEshellCS) {
    if (namePIXExsModel == "ECPSSR_FormFactor")
      {
    PIXEshellCS = new G4teoCrossSection(namePIXExsModel);
      }
    else if(namePIXExsModel == "ECPSSR_ANSTO")
      {
    PIXEshellCS = new G4teoCrossSection(namePIXExsModel);
      }    
    else if(namePIXExsModel == "Empirical")
      {
    PIXEshellCS = new G4empCrossSection(namePIXExsModel);
      }
  }
 
  // Check if old cross section for e+- should be deleted 
  if(ePIXEshellCS && namePIXExsElectronModel != ePIXEshellCS->GetName()) 
    {
      delete ePIXEshellCS;
      ePIXEshellCS = nullptr;
    } 
 
  // Instantiate new e+- cross section
  if(nullptr == ePIXEshellCS) 
    {
      if(namePIXExsElectronModel == "Empirical")
    {
      ePIXEshellCS = new G4empCrossSection("Empirical");
    }
      else if(namePIXExsElectronModel == "ECPSSR_Analytical") 
    {
      ePIXEshellCS = new G4teoCrossSection("ECPSSR_Analytical");
    }
      else if (namePIXExsElectronModel == "Penelope")
    {
      ePIXEshellCS = new G4PenelopeIonisationCrossSection();
    }
      else 
    {
      ePIXEshellCS = new G4LivermoreIonisationCrossSection();
    }
    } 
}

operator=()

G4UAtomicDeexcitation & G4UAtomicDeexcitation::operator= ( const G4UAtomicDeexcitation &  right )

delete

SetCutForAugerElectrons()

void G4UAtomicDeexcitation::SetCutForAugerElectrons

(

G4double

cut

)

Set threshold energy for Auger electron production.

Definition at line 362 of file G4UAtomicDeexcitation.cc.

{
  minElectronEnergy = cut;
}

SetCutForSecondaryPhotons()

void G4UAtomicDeexcitation::SetCutForSecondaryPhotons

(

G4double

cut

)

Set threshold energy for fluorescence.

Definition at line 355 of file G4UAtomicDeexcitation.cc.

{
  minGammaEnergy = cut;
}

---

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

• G4UAtomicDeexcitation.hh
• G4UAtomicDeexcitation.cc