G4DNAPTBAugerModel Class Reference

The G4DNAPTBAugerModel class Implement the PTB Auger model. More...

#include <G4DNAPTBAugerModel.hh>

Public Member Functions
void	ComputeAugerEffect (std::vector< G4DynamicParticle * > *fvect, const G4String &materialNameIni, G4double bindingEnergy)
	ComputeAugerEffect Main method to be called by the ionisation model. More...
	G4DNAPTBAugerModel (const G4String &modelName)
	G4DNAPTBAugerModel Constructor. More...
virtual void	Initialise ()
	Initialise Set the verbose value. More...
void	SetCutForAugerElectrons (G4double cut)
	SetCutForAugerElectrons Set the cut for the auger electrons production. More...
virtual	~G4DNAPTBAugerModel ()
	~G4DNAPTBAugerModel Destructor More...

Private Member Functions
G4double	CalculAugerEnergyFor (G4int atomId)
	CalculAugerEnergyFor. More...
G4int	DetermineIonisedAtom (G4int atomId, const G4String &materialName, G4double bindingEnergy)
	DetermineIonisedAtom. More...
	G4DNAPTBAugerModel (G4DNAPTBAugerModel &)
void	GenerateAugerWithRandomDirection (std::vector< G4DynamicParticle * > *fvect, G4double kineticEnergy)
	GenerateAugerWithRandomDirection Generates the auger particle. More...
G4DNAPTBAugerModel &	operator= (const G4DNAPTBAugerModel &right)

Private Attributes
G4double	minElectronEnergy
const G4String	modelName
	name of the auger model More...
G4int	verboseLevel

Detailed Description

The G4DNAPTBAugerModel class Implement the PTB Auger model.

Definition at line 60 of file G4DNAPTBAugerModel.hh.

Constructor & Destructor Documentation

G4DNAPTBAugerModel() [1/2]

G4DNAPTBAugerModel::G4DNAPTBAugerModel

(

const G4String &

modelName

)

G4DNAPTBAugerModel Constructor.

Parameters

modelName

Definition at line 41 of file G4DNAPTBAugerModel.cc.

                                                                    : modelName(modelAugerName)
{
    // To inform the user that the Auger model is enabled
    G4cout << modelName <<" is constructed" << G4endl;
}

References G4cout, G4endl, and modelName.

~G4DNAPTBAugerModel()

G4DNAPTBAugerModel::~G4DNAPTBAugerModel ( )

virtual

~G4DNAPTBAugerModel Destructor

Definition at line 47 of file G4DNAPTBAugerModel.cc.

{
    if( verboseLevel>0 ) G4cout << modelName <<" is deleted" << G4endl;
}

References G4cout, G4endl, modelName, and verboseLevel.

G4DNAPTBAugerModel() [2/2]

G4DNAPTBAugerModel::G4DNAPTBAugerModel ( G4DNAPTBAugerModel &  )

private

Member Function Documentation

CalculAugerEnergyFor()

G4double G4DNAPTBAugerModel::CalculAugerEnergyFor ( G4int  atomId )

private

CalculAugerEnergyFor.

Parameters

atomId

Returns

the auger particle energy

Definition at line 136 of file G4DNAPTBAugerModel.cc.

{
    G4double kineticEnergy;
 
    if(atomId==2) // oxygen
    {
        kineticEnergy = 495*eV;
    }
    else
    {
        G4double f1, f2, f3, g1, g2, Y;
 
        Y = G4UniformRand();
 
        if(atomId == 1){ // carbon
            f1 = -7.331e-2;
            f2 = -3.306e-5;
            f3 = 2.433e0;
            g1 = 4.838e-1;
            g2 = 3.886e0;
        }
        else if(atomId == 4){ // nitrogen
            f1 = -7.518e-2;
            f2 = 1.178e-4;
            f3 = 2.600e0;
            g1 = 4.639e-1;
            g2 = 3.770e0;
        }
        else// if(atomId == 3) // carbon_TMP
        {
            f1 = -5.700e-2;
            f2 = 1.200e-4;
            f3 = 2.425e0;
            g1 = 5.200e-1;
            g2 = 2.560e0;
        }
 
        kineticEnergy = pow(10, f1*pow( abs( log10(Y) ) , g1) + f2*pow( abs( log10(Y) ) , g2) + f3 )*eV;
    }
 
    return kineticEnergy;
}

References eV, G4UniformRand, and Y().

Referenced by ComputeAugerEffect().

ComputeAugerEffect()

void G4DNAPTBAugerModel::ComputeAugerEffect	(	std::vector< G4DynamicParticle * > *	fvect,
		const G4String &	materialNameIni,
		G4double	bindingEnergy
	)

ComputeAugerEffect Main method to be called by the ionisation model.

Parameters

fvect
materialNameIni
bindingEnergy

Definition at line 65 of file G4DNAPTBAugerModel.cc.

{
    // Rename material if modified NIST material
    // This is needed when material is obtained from G4MaterialCutsCouple
    G4String materialName = materialNameIni;
    if(materialName.find("_MODIFIED")){
        materialName = materialName.substr(0,materialName.size()-9);
    }
 
    // check if there is a k-shell ionisation and find the ionised atom
    G4int atomId(0);
 
    atomId = DetermineIonisedAtom(atomId, materialName, bindingEnergy);
 
    if(atomId!=0)
    {
        G4double kineticEnergy = CalculAugerEnergyFor(atomId);
 
        if(kineticEnergy<0)
        {
            G4cerr<<"**************************"<<G4endl;
            G4cerr<<"FatalError. Auger kineticEnergy: "<<kineticEnergy<<G4endl;
            exit(EXIT_FAILURE);
        }
 
        if(atomId==1 || atomId==2 || atomId==3)
        {
            GenerateAugerWithRandomDirection(fvect, kineticEnergy);
        }
        else if(atomId==4)
        {
            GenerateAugerWithRandomDirection(fvect, kineticEnergy);
            GenerateAugerWithRandomDirection(fvect, kineticEnergy);
        }
    }
}

References G4InuclSpecialFunctions::bindingEnergy(), CalculAugerEnergyFor(), DetermineIonisedAtom(), g4zmq::exit(), G4cerr, G4endl, and GenerateAugerWithRandomDirection().

Referenced by G4DNAPTBIonisationModel::SampleSecondaries().

DetermineIonisedAtom()

G4int G4DNAPTBAugerModel::DetermineIonisedAtom ( G4int  atomId, const G4String &  materialName, G4double  bindingEnergy  )

private

DetermineIonisedAtom.

Parameters

atomId
materialName
bindingEnergy

Returns

the id of the chosen ionised atom

Definition at line 104 of file G4DNAPTBAugerModel.cc.

{
    if(materialName=="THF" || materialName=="backbone_THF"){
        if(bindingEnergy==305.07){
            atomId=1; //"carbon";
        }
        else if(bindingEnergy==557.94){
            atomId=2; //"oxygen";
        }
    }
    else if(materialName=="PY" || materialName=="PU"
            || materialName=="cytosine_PY" || materialName=="thymine_PY"
            || materialName=="adenine_PU" || materialName=="guanine_PU"
            )
    {
        if(bindingEnergy==307.52){
            atomId=1; //"carbon";
        }
        else if(bindingEnergy==423.44){
            atomId=4; //"nitrogen";
        }
    }
    else if(materialName=="TMP"|| materialName=="backbone_TMP"){
        if(bindingEnergy==209.59 || bindingEnergy==152.4)
            atomId=3; //"carbonTMP";
    }
 
    return atomId;
}

References G4InuclSpecialFunctions::bindingEnergy().

Referenced by ComputeAugerEffect().

GenerateAugerWithRandomDirection()

void G4DNAPTBAugerModel::GenerateAugerWithRandomDirection ( std::vector< G4DynamicParticle * > *  fvect, G4double  kineticEnergy  )

private

GenerateAugerWithRandomDirection Generates the auger particle.

Parameters

fvect
kineticEnergy

Definition at line 188 of file G4DNAPTBAugerModel.cc.

{
      // Isotropic angular distribution for the outcoming e-
      G4double newcosTh = 1.-2.*G4UniformRand();
      G4double  newsinTh = std::sqrt(1.-newcosTh*newcosTh);
      G4double newPhi = twopi*G4UniformRand();
      
      G4double xDir =  newsinTh*std::sin(newPhi);
      G4double yDir = newsinTh*std::cos(newPhi);
      G4double zDir = newcosTh;
      
      G4ThreeVector ElectronDirection(xDir,yDir,zDir);
 
      // generation of new particle
      G4DynamicParticle* dp = new G4DynamicParticle (G4Electron::Electron(), ElectronDirection, kineticEnergy) ;
      fvect->push_back(dp);
}

References G4Electron::Electron(), G4UniformRand, and twopi.

Referenced by ComputeAugerEffect().

Initialise()

void G4DNAPTBAugerModel::Initialise ( )

virtual

Initialise Set the verbose value.

Definition at line 52 of file G4DNAPTBAugerModel.cc.

{
    verboseLevel = 0;
 
    if( verboseLevel>0 )
    {
        G4cout << "PTB Auger model is initialised " << G4endl;
    }
 
}

References G4cout, G4endl, and verboseLevel.

Referenced by G4DNAPTBIonisationModel::Initialise().

operator=()

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

private

SetCutForAugerElectrons()

void G4DNAPTBAugerModel::SetCutForAugerElectrons

(

G4double

cut

)

SetCutForAugerElectrons Set the cut for the auger electrons production.

Parameters

cut

Definition at line 181 of file G4DNAPTBAugerModel.cc.

{
  minElectronEnergy = cut;
}

References minElectronEnergy.

Field Documentation

minElectronEnergy

G4double G4DNAPTBAugerModel::minElectronEnergy

private

Definition at line 105 of file G4DNAPTBAugerModel.hh.

Referenced by SetCutForAugerElectrons().

modelName

const G4String G4DNAPTBAugerModel::modelName

private

name of the auger model

Definition at line 102 of file G4DNAPTBAugerModel.hh.

Referenced by G4DNAPTBAugerModel(), and ~G4DNAPTBAugerModel().

verboseLevel

G4int G4DNAPTBAugerModel::verboseLevel

private

Definition at line 104 of file G4DNAPTBAugerModel.hh.

Referenced by Initialise(), and ~G4DNAPTBAugerModel().

---

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

• source/processes/electromagnetic/dna/models/include/G4DNAPTBAugerModel.hh
• source/processes/electromagnetic/dna/models/src/G4DNAPTBAugerModel.cc