#include <G4KleinNishinaModel.hh>

Inheritance diagram for G4KleinNishinaModel:

Collaboration diagram for G4KleinNishinaModel:

Public Member Functions
	G4KleinNishinaModel (const G4String &nam="KleinNishina")

virtual	~G4KleinNishinaModel ()

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

virtual void	InitialiseLocal (const G4ParticleDefinition , G4VEmModel masterModel)

virtual G4double	ComputeCrossSectionPerAtom (const G4ParticleDefinition *, G4double kinEnergy, G4double Z, G4double A, G4double cut, G4double emax)

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

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

virtual	~G4VEmModel ()

virtual void	InitialiseForMaterial (const G4ParticleDefinition , const G4Material )

virtual void	InitialiseForElement (const G4ParticleDefinition *, G4int Z)

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

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

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

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

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=0)

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	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
G4ParticleDefinition *	theGamma

G4ParticleDefinition *	theElectron

G4ParticleChangeForGamma *	fParticleChange

G4double	lowestSecondaryEnergy

Protected Attributes inherited from G4VEmModel
G4ElementData *	fElementData

G4VParticleChange *	pParticleChange

G4PhysicsTable *	xSectionTable

const std::vector< G4double > *	theDensityFactor

const std::vector< G4int > *	theDensityIdx

size_t	idxTable

Private Member Functions
G4KleinNishinaModel &	operator= (const G4KleinNishinaModel &right)

	G4KleinNishinaModel (const G4KleinNishinaModel &)

Private Attributes
G4LorentzVector	lv1

G4LorentzVector	lv2

G4ThreeVector	bst

G4VAtomDeexcitation *	fAtomDeexcitation

G4double	limitFactor

std::vector< G4double >	fProbabilities

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 59 of file G4KleinNishinaModel.hh.

Constructor & Destructor Documentation

◆ G4KleinNishinaModel() [1/2]

G4KleinNishinaModel::G4KleinNishinaModel ( const G4String & nam = "KleinNishina" )

Definition at line 77 of file G4KleinNishinaModel.cc.

   : G4VEmModel(nam), 
     lv1(0.,0.,0.,0.),
     lv2(0.,0.,0.,0.),
     bst(0.,0.,0.)
 {
   theGamma = G4Gamma::Gamma();
   theElectron = G4Electron::Electron();
   lowestSecondaryEnergy = 10*eV;
   limitFactor       = 4;
   fProbabilities.resize(9,0.0);
   SetDeexcitationFlag(true);
   fParticleChange = nullptr;
   fAtomDeexcitation = nullptr;
 }

Here is the call graph for this function:

◆ ~G4KleinNishinaModel()

G4KleinNishinaModel::~G4KleinNishinaModel ( )

virtual

Definition at line 95 of file G4KleinNishinaModel.cc.

96 {}

◆ G4KleinNishinaModel() [2/2]

G4KleinNishinaModel::G4KleinNishinaModel ( const G4KleinNishinaModel & )

private

Member Function Documentation

◆ ComputeCrossSectionPerAtom()

G4double G4KleinNishinaModel::ComputeCrossSectionPerAtom	(	const G4ParticleDefinition *	,
		G4double	kinEnergy,
		G4double	Z,
		G4double	A,
		G4double	cut,
		G4double	emax
	)

virtual

Reimplemented from G4VEmModel.

Definition at line 121 of file G4KleinNishinaModel.cc.

 {
   G4double xSection = 0.0 ;
   if (gammaEnergy <= LowEnergyLimit()) { return xSection; }
 
   static const G4double a = 20.0 , b = 230.0 , c = 440.0;
   
   G4double p1Z = Z*(d1 + e1*Z + f1*Z*Z), p2Z = Z*(d2 + e2*Z + f2*Z*Z),
            p3Z = Z*(d3 + e3*Z + f3*Z*Z), p4Z = Z*(d4 + e4*Z + f4*Z*Z);
 
   G4double T0  = 15.0*keV; 
   if (Z < 1.5) { T0 = 40.0*keV; } 
 
   G4double X   = max(gammaEnergy, T0) / electron_mass_c2;
   xSection = p1Z*G4Log(1.+2.*X)/X
                + (p2Z + p3Z*X + p4Z*X*X)/(1. + a*X + b*X*X + c*X*X*X);
                 
   //  modification for low energy. (special case for Hydrogen)
   if (gammaEnergy < T0) {
     X = (T0+dT0) / electron_mass_c2 ;
     G4double sigma = p1Z*G4Log(1.+2*X)/X
                     + (p2Z + p3Z*X + p4Z*X*X)/(1. + a*X + b*X*X + c*X*X*X);
     G4double   c1 = -T0*(sigma-xSection)/(xSection*dT0);             
     G4double   c2 = 0.150; 
     if (Z > 1.5) { c2 = 0.375-0.0556*G4Log(Z); }
     G4double    y = G4Log(gammaEnergy/T0);
     xSection *= G4Exp(-y*(c1+c2*y));          
   }
 
   if(xSection < 0.0) { xSection = 0.0; }
   //  G4cout << "e= " << GammaEnergy << " Z= " << Z 
   //  << " cross= " << xSection << G4endl;
   return xSection;
 }

Here is the call graph for this function:

◆ Initialise()

void G4KleinNishinaModel::Initialise	(	const G4ParticleDefinition *	p,
		const G4DataVector &	cuts
	)

virtual

Implements G4VEmModel.

Definition at line 100 of file G4KleinNishinaModel.cc.

 {
   fAtomDeexcitation = G4LossTableManager::Instance()->AtomDeexcitation();
   if(IsMaster()) { InitialiseElementSelectors(p, cuts); }
   if(nullptr == fParticleChange) { 
     fParticleChange = GetParticleChangeForGamma(); 
   }
 }

Here is the call graph for this function:

◆ InitialiseLocal()

void G4KleinNishinaModel::InitialiseLocal	(	const G4ParticleDefinition *	,
		G4VEmModel *	masterModel
	)

virtual

Reimplemented from G4VEmModel.

Definition at line 112 of file G4KleinNishinaModel.cc.

 {
   SetElementSelectors(masterModel->GetElementSelectors());
 }

Here is the call graph for this function:

◆ operator=()

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

private

◆ SampleSecondaries()

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

virtual

Implements G4VEmModel.

Definition at line 161 of file G4KleinNishinaModel.cc.

 {
   // primary gamma
   G4double energy = aDynamicGamma->GetKineticEnergy();
 
   // do nothing below the threshold
   if(energy <= LowEnergyLimit()) { return; }
 
   G4ThreeVector direction = aDynamicGamma->GetMomentumDirection();
 
   // select atom
   const G4Element* elm = SelectRandomAtom(couple, theGamma, energy);
 
   // select shell first
   G4int nShells = elm->GetNbOfAtomicShells();
   if(nShells > (G4int)fProbabilities.size()) { fProbabilities.resize(nShells); }
   G4double totprob = 0.0;
   G4int i;
   for(i=0; i<nShells; ++i) {
     //G4double bindingEnergy = elm->GetAtomicShell(i);
     totprob += elm->GetNbOfShellElectrons(i);
     //totprob += elm->GetNbOfShellElectrons(i)/(bindingEnergy*bindingEnergy);
     fProbabilities[i] = totprob; 
   }
 
   // Loop on sampling
   G4int nloop = 0;
 
   G4double bindingEnergy, ePotEnergy, eKinEnergy;
   G4double gamEnergy0, gamEnergy1;
 
   CLHEP::HepRandomEngine* rndmEngineMod = G4Random::getTheEngine();
   G4double rndm[4];
 
   do {
     ++nloop;
 
     // 4 random numbers to select e-
     rndmEngineMod->flatArray(4, rndm);
     G4double xprob = totprob*rndm[0];
 
     // select shell
     for(i=0; i<nShells; ++i) { if(xprob <= fProbabilities[i]) { break; } }
    
     bindingEnergy = elm->GetAtomicShell(i);
     lv1.set(0.0,0.0,energy,energy);
     /*
     G4cout << "nShells= " << nShells << " i= " << i 
        << " Egamma= " << energy << " Ebind= " << bindingEnergy
        << G4endl;
     */
     // for rest frame of the electron
     G4double x = -G4Log(rndm[1]);
     eKinEnergy = bindingEnergy*x;
     ePotEnergy = bindingEnergy*(1.0 + x);
 
     // for rest frame of the electron
     G4double eTotMomentum = sqrt(eKinEnergy*(eKinEnergy + 2*electron_mass_c2));
     G4double phi = rndm[2]*twopi;
     G4double costet = 2*rndm[3] - 1;
     G4double sintet = sqrt((1 - costet)*(1 + costet));
     lv2.set(eTotMomentum*sintet*cos(phi),eTotMomentum*sintet*sin(phi),
             eTotMomentum*costet,eKinEnergy + electron_mass_c2);
     bst = lv2.boostVector();
     lv1.boost(-bst);
 
     gamEnergy0 = lv1.e();
    
     // In the rest frame of the electron
     // The scattered gamma energy is sampled according to Klein-Nishina formula
     // The random number techniques of Butcher & Messel are used 
     // (Nuc Phys 20(1960),15). 
     G4double E0_m = gamEnergy0/electron_mass_c2;
 
     //G4cout << "Nloop= "<< nloop << " Ecm(keV)= " << gamEnergy0/keV << G4endl;
     //
     // sample the energy rate of the scattered gamma 
     //
 
     G4double epsilon, epsilonsq, onecost, sint2, greject ;
 
     G4double eps0       = 1./(1 + 2*E0_m);
     G4double epsilon0sq = eps0*eps0;
     G4double alpha1     = - G4Log(eps0);
     G4double alpha2     = alpha1 + 0.5*(1 - epsilon0sq);
 
     do {
       ++nloop;
       // false interaction if too many iterations
       if(nloop > nlooplim) { return; }
 
       // 3 random numbers to sample scattering
       rndmEngineMod->flatArray(3, rndm);
 
       if ( alpha1 > alpha2*rndm[0] ) {
         epsilon   = G4Exp(-alpha1*rndm[1]);   // epsilon0**r
         epsilonsq = epsilon*epsilon; 
 
       } else {
         epsilonsq = epsilon0sq + (1.- epsilon0sq)*rndm[1];
         epsilon   = sqrt(epsilonsq);
       }
 
       onecost = (1.- epsilon)/(epsilon*E0_m);
       sint2   = onecost*(2.-onecost);
       greject = 1. - epsilon*sint2/(1.+ epsilonsq);
 
       // Loop checking, 03-Aug-2015, Vladimir Ivanchenko
     } while (greject < rndm[2]);
     gamEnergy1 = epsilon*gamEnergy0;
  
     // before scattering total 4-momentum in e- system
     lv2.set(0.0,0.0,0.0,electron_mass_c2);
     lv2 += lv1;
  
     //
     // scattered gamma angles. ( Z - axis along the parent gamma)
     //
     if(sint2 < 0.0) { sint2 = 0.0; }
     costet = 1. - onecost; 
     sintet = sqrt(sint2);
     phi  = twopi * rndmEngineMod->flat();
 
     // e- recoil
     //
     // in  rest frame of the electron
     G4ThreeVector gamDir = lv1.vect().unit();
     G4ThreeVector v = G4ThreeVector(sintet*cos(phi),sintet*sin(phi),costet);
     v.rotateUz(gamDir);
     lv1.set(gamEnergy1*v.x(),gamEnergy1*v.y(),gamEnergy1*v.z(),gamEnergy1);
     lv2 -= lv1;
     //G4cout<<"Egam(keV)= " << lv1.e()/keV
     //          <<" Ee(keV)= " << (lv2.e()-electron_mass_c2)/keV << G4endl;
     lv2.boost(bst);
     eKinEnergy = lv2.e() - electron_mass_c2 - ePotEnergy;   
     //G4cout << "Nloop= " << nloop << " eKinEnergy= " << eKinEnergy << G4endl;
 
     // Loop checking, 03-Aug-2015, Vladimir Ivanchenko
   } while ( eKinEnergy < 0.0 );
 
   //
   // update G4VParticleChange for the scattered gamma
   //
    
   lv1.boost(bst);
   gamEnergy1 = lv1.e();
   if(gamEnergy1 > lowestSecondaryEnergy) {
     G4ThreeVector gamDirection1 = lv1.vect().unit();
     gamDirection1.rotateUz(direction);
     fParticleChange->ProposeMomentumDirection(gamDirection1);
   } else { 
     fParticleChange->ProposeTrackStatus(fStopAndKill);
     gamEnergy1 = 0.0;
   }
   fParticleChange->SetProposedKineticEnergy(gamEnergy1);
 
   //
   // kinematic of the scattered electron
   //
 
   if(eKinEnergy > lowestSecondaryEnergy) {
     G4ThreeVector eDirection = lv2.vect().unit();
     eDirection.rotateUz(direction);
     G4DynamicParticle* dp = 
       new G4DynamicParticle(theElectron,eDirection,eKinEnergy);
     fvect->push_back(dp);
   } else { eKinEnergy = 0.0; }
 
   G4double edep = energy - gamEnergy1 - eKinEnergy;
   G4double esec = 0.0;
   
   // sample deexcitation
   //
   if(fAtomDeexcitation) {
     G4int index = couple->GetIndex();
     if(fAtomDeexcitation->CheckDeexcitationActiveRegion(index)) {
       G4int Z = G4lrint(elm->GetZ());
       G4AtomicShellEnumerator as = G4AtomicShellEnumerator(i);
       const G4AtomicShell* shell = fAtomDeexcitation->GetAtomicShell(Z, as);
       G4int nbefore = fvect->size();
       fAtomDeexcitation->GenerateParticles(fvect, shell, Z, index);
       G4int nafter = fvect->size();
       //G4cout << "N1= " << nbefore << "  N2= " << nafter << G4endl;
       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;
           /*            
             G4cout << "### G4KleinNishinaModel Edep(eV)= " << edep/eV 
                    << " Esec(eV)= " << esec/eV 
                    << " E["<< j << "](eV)= " << e/eV
                    << " N= " << nafter
                    << " Z= " << Z << " shell= " << i 
                    << "  Ebind(keV)= " << bindingEnergy/keV 
                    << "  Eshell(keV)= " << shell->BindingEnergy()/keV 
                    << G4endl;
           */
           // 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;
     }
   }
   if(fabs(energy - gamEnergy1 - eKinEnergy - esec - edep) > eV) {
     G4cout << "### G4KleinNishinaModel dE(eV)= " 
            << (energy - gamEnergy1 - eKinEnergy - esec - edep)/eV 
            << " shell= " << i 
            << "  E(keV)= " << energy/keV 
            << "  Ebind(keV)= " << bindingEnergy/keV 
            << "  Eg(keV)= " << gamEnergy1/keV 
            << "  Ee(keV)= " << eKinEnergy/keV 
            << "  Esec(keV)= " << esec/keV 
            << "  Edep(keV)= " << edep/keV 
            << G4endl;
   }
   // energy balance
   if(edep > 0.0) { 
     fParticleChange->ProposeLocalEnergyDeposit(edep);
   }
 }

Here is the call graph for this function:

Member Data Documentation

◆ bst

G4ThreeVector G4KleinNishinaModel::bst

private

Definition at line 101 of file G4KleinNishinaModel.hh.

◆ fAtomDeexcitation

G4VAtomDeexcitation* G4KleinNishinaModel::fAtomDeexcitation

private

Definition at line 103 of file G4KleinNishinaModel.hh.

◆ fParticleChange

G4ParticleChangeForGamma* G4KleinNishinaModel::fParticleChange

protected

Definition at line 91 of file G4KleinNishinaModel.hh.

◆ fProbabilities

std::vector<G4double> G4KleinNishinaModel::fProbabilities

private

Definition at line 105 of file G4KleinNishinaModel.hh.

◆ limitFactor

G4double G4KleinNishinaModel::limitFactor

private

Definition at line 104 of file G4KleinNishinaModel.hh.

◆ lowestSecondaryEnergy

G4double G4KleinNishinaModel::lowestSecondaryEnergy

protected

Definition at line 92 of file G4KleinNishinaModel.hh.

◆ lv1

G4LorentzVector G4KleinNishinaModel::lv1

private

Definition at line 100 of file G4KleinNishinaModel.hh.

◆ lv2

G4LorentzVector G4KleinNishinaModel::lv2

private

Definition at line 100 of file G4KleinNishinaModel.hh.

◆ theElectron

G4ParticleDefinition* G4KleinNishinaModel::theElectron

protected

Definition at line 90 of file G4KleinNishinaModel.hh.

◆ theGamma

G4ParticleDefinition* G4KleinNishinaModel::theGamma

protected

Definition at line 89 of file G4KleinNishinaModel.hh.

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

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ G4KleinNishinaModel() [1/2]

◆ ~G4KleinNishinaModel()

◆ G4KleinNishinaModel() [2/2]

Member Function Documentation

◆ ComputeCrossSectionPerAtom()

◆ Initialise()

◆ InitialiseLocal()

◆ operator=()

◆ SampleSecondaries()

Member Data Documentation

◆ bst

◆ fAtomDeexcitation

◆ fParticleChange

◆ fProbabilities

◆ limitFactor

◆ lowestSecondaryEnergy

◆ lv1

◆ lv2

◆ theElectron

◆ theGamma