G4DNAPTBIonisationModel Class Reference

The G4DNAPTBIonisationModel class Implements the PTB ionisation model. More...

#include <G4DNAPTBIonisationModel.hh>

Inheritance diagram for G4DNAPTBIonisationModel:

Public Member Functions
	G4DNAPTBIonisationModel (const G4String &applyToMaterial="all", const G4ParticleDefinition *p=0, const G4String &nam="DNAPTBIonisationModel", const G4bool isAuger=true)
	G4DNAPTBIonisationModel Constructor.
virtual	~G4DNAPTBIonisationModel ()
	~G4DNAPTBIonisationModel Destructor
virtual void	Initialise (const G4ParticleDefinition *particle, const G4DataVector &= *(new G4DataVector()), G4ParticleChangeForGamma *fpChangeForGamme=nullptr)
	Initialise Method called once at the beginning of the simulation. It is used to setup the list of the materials managed by the model and the energy limits. All the materials are setup but only a part of them can be activated by the user through the constructor.
virtual G4double	CrossSectionPerVolume (const G4Material *material, const G4String &materialName, const G4ParticleDefinition *p, G4double ekin, G4double emin, G4double emax)
	CrossSectionPerVolume Mandatory for every model the CrossSectionPerVolume method is in charge of returning the cross section value corresponding to the material, particle and energy current values.
virtual void	SampleSecondaries (std::vector< G4DynamicParticle * > *, const G4MaterialCutsCouple *, const G4String &materialName, const G4DynamicParticle *, G4ParticleChangeForGamma *particleChangeForGamma, G4double tmin, G4double tmax)
	SampleSecondaries If the model is selected for the ModelInterface then SampleSecondaries will be called. The method sets the characteristics of the particles implied with the physical process after the ModelInterface (energy, momentum...). This method is mandatory for every model.
Public Member Functions inherited from G4VDNAModel
	G4VDNAModel (const G4String &nam, const G4String &applyToMaterial)
	G4VDNAModel Constructeur of the G4VDNAModel class.
virtual	~G4VDNAModel ()
	~G4VDNAModel
virtual void	Initialise (const G4ParticleDefinition *particle, const G4DataVector &cuts, G4ParticleChangeForGamma *fpChangeForGamme=nullptr)=0
	Initialise Each model must implement an Initialize method.
virtual G4double	CrossSectionPerVolume (const G4Material *material, const G4String &materialName, const G4ParticleDefinition *p, G4double ekin, G4double emin, G4double emax)=0
	CrossSectionPerVolume Every model must implement its own CrossSectionPerVolume method. It is used by the process to determine the step path and must return a cross section times a number of molecules per volume unit.
virtual void	SampleSecondaries (std::vector< G4DynamicParticle * > *, const G4MaterialCutsCouple *, const G4String &materialName, const G4DynamicParticle *, G4ParticleChangeForGamma *particleChangeForGamma, G4double tmin=0, G4double tmax=DBL_MAX)=0
	SampleSecondaries Each model must implement SampleSecondaries to decide if a particle will be created after the ModelInterface or if any charateristic of the incident particle will change.
G4bool	IsMaterialDefine (const G4String &materialName)
	IsMaterialDefine Check if the given material is defined in the simulation.
G4bool	IsMaterialExistingInModel (const G4String &materialName)
	IsMaterialExistingInModel Check if the given material is defined in the current model class.
G4bool	IsParticleExistingInModelForMaterial (const G4String &particleName, const G4String &materialName)
	IsParticleExistingInModelForMaterial To check two things: 1- is the material existing in model ? 2- if yes, is the particle defined for that material ?
G4String	GetName ()
	GetName.
G4double	GetHighELimit (const G4String &material, const G4String &particle)
	GetHighEnergyLimit.
G4double	GetLowELimit (const G4String &material, const G4String &particle)
	GetLowEnergyLimit.
void	SetHighELimit (const G4String &material, const G4String &particle, G4double lim)
	SetHighEnergyLimit.
void	SetLowELimit (const G4String &material, const G4String &particle, G4double lim)
	SetLowEnergyLimit.

Additional Inherited Members
Protected Types inherited from G4VDNAModel
typedef std::map< G4String, std::map< G4String, G4DNACrossSectionDataSet *, std::less< G4String > > >	TableMapData
typedef std::map< G4String, std::map< G4String, G4double > >	RatioMapData
typedef std::map< G4String, G4double >::const_iterator	ItCompoMapData
Protected Member Functions inherited from G4VDNAModel
TableMapData *	GetTableData ()
	GetTableData.
std::vector< G4String >	BuildApplyToMatVect (const G4String &materials)
	BuildApplyToMatVect Build the material name vector which is used to know the materials the user want to include in the model.
void	ReadAndSaveCSFile (const G4String &materialName, const G4String &particleName, const G4String &file, G4double scaleFactor)
	ReadAndSaveCSFile Read and save a "simple" cross section file : use of G4DNACrossSectionDataSet->loadData()
G4int	RandomSelectShell (G4double k, const G4String &particle, const G4String &materialName)
	RandomSelectShell Method to randomely select a shell from the data table uploaded. The size of the table (number of columns) is used to determine the total number of possible shells.
void	AddCrossSectionData (G4String materialName, G4String particleName, G4String fileCS, G4String fileDiffCS, G4double scaleFactor)
	AddCrossSectionData Method used during the initialization of the model class to add a new material. It adds a material to the model and fills vectors with informations.
void	AddCrossSectionData (G4String materialName, G4String particleName, G4String fileCS, G4double scaleFactor)
	AddCrossSectionData Method used during the initialization of the model class to add a new material. It adds a material to the model and fills vectors with informations. Not every model needs differential cross sections.
void	LoadCrossSectionData (const G4String &particleName)
	LoadCrossSectionData Method to loop on all the registered materials in the model and load the corresponding data.
virtual void	ReadDiffCSFile (const G4String &materialName, const G4String &particleName, const G4String &path, const G4double scaleFactor)
	ReadDiffCSFile Virtual method that need to be implemented if one wish to use the differential cross sections. The read method for that kind of information is not standardized yet.
void	EnableForMaterialAndParticle (const G4String &materialName, const G4String &particleName)
	EnableMaterialAndParticle.

Detailed Description

The G4DNAPTBIonisationModel class Implements the PTB ionisation model.

Definition at line 53 of file G4DNAPTBIonisationModel.hh.

Constructor & Destructor Documentation

G4DNAPTBIonisationModel()

G4DNAPTBIonisationModel::G4DNAPTBIonisationModel	(	const G4String &	applyToMaterial = "all",
		const G4ParticleDefinition *	p = 0,
		const G4String &	nam = "DNAPTBIonisationModel",
		const G4bool	isAuger = true
	)

G4DNAPTBIonisationModel Constructor.

Parameters

applyToMaterial
p
nam
isAuger

Definition at line 38 of file G4DNAPTBIonisationModel.cc.

    : G4VDNAModel(nam, applyToMaterial)
{
    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
 
    if( verboseLevel>0 )
    {
        G4cout << "PTB ionisation model is constructed " << G4endl;
    }
 
    if(isAuger)
    {
        // create the PTB Auger model
        fDNAPTBAugerModel = new G4DNAPTBAugerModel("e-_G4DNAPTBAugerModel");
    }
    else
    {
        // no PTB Auger model
        fDNAPTBAugerModel = 0;
    }
}

~G4DNAPTBIonisationModel()

G4DNAPTBIonisationModel::~G4DNAPTBIonisationModel ( )

virtual

~G4DNAPTBIonisationModel Destructor

Definition at line 70 of file G4DNAPTBIonisationModel.cc.

{
    // To delete the DNAPTBAugerModel created at initialisation of the ionisation class
    if(fDNAPTBAugerModel) delete fDNAPTBAugerModel;
}

Member Function Documentation

CrossSectionPerVolume()

G4double G4DNAPTBIonisationModel::CrossSectionPerVolume ( const G4Material *  material, const G4String &  materialName, const G4ParticleDefinition *  p, G4double  ekin, G4double  emin, G4double  emax  )

virtual

CrossSectionPerVolume Mandatory for every model the CrossSectionPerVolume method is in charge of returning the cross section value corresponding to the material, particle and energy current values.

Parameters

material
materialName
p
ekin
emin
emax

Returns

the cross section value

Implements G4VDNAModel.

Definition at line 250 of file G4DNAPTBIonisationModel.cc.

{
    if(verboseLevel > 3)
        G4cout << "Calling CrossSectionPerVolume() of G4DNAPTBIonisationModel" << G4endl;
 
    // initialise the cross section value (output value)
    G4double sigma(0);
 
    // Get the current particle name
    const G4String& particleName = p->GetParticleName();
 
    // Set the low and high energy limits
    G4double lowLim = GetLowELimit(materialName, particleName);
    G4double highLim = GetHighELimit(materialName, particleName);
 
    // Check that we are in the correct energy range
    if (ekin >= lowLim && ekin < highLim)
    {
        // Get the map with all the model data tables
        TableMapData* tableData = GetTableData();
 
        // Retrieve the cross section value for the current material, particle and energy values
        sigma = (*tableData)[materialName][particleName]->FindValue(ekin);
 
        if (verboseLevel > 2)
        {
            G4cout << "__________________________________" << G4endl;
            G4cout << "°°° G4DNAPTBIonisationModel - XS INFO START" << G4endl;
            G4cout << "°°° Kinetic energy(eV)=" << ekin/eV << " particle : " << particleName << G4endl;
            G4cout << "°°° Cross section per "<< materialName <<" molecule (cm^2)=" << sigma/cm/cm << G4endl;
            G4cout << "°°° G4DNAPTBIonisationModel - XS INFO END" << G4endl;
        }
    }
 
    // Return the cross section value
    return sigma;
}

Initialise()

void G4DNAPTBIonisationModel::Initialise ( const G4ParticleDefinition *  particle, const G4DataVector &  = *(new G4DataVector()), G4ParticleChangeForGamma *  fpChangeForGamme = nullptr  )

virtual

Initialise Method called once at the beginning of the simulation. It is used to setup the list of the materials managed by the model and the energy limits. All the materials are setup but only a part of them can be activated by the user through the constructor.

Implements G4VDNAModel.

Definition at line 78 of file G4DNAPTBIonisationModel.cc.

{
 
    if (verboseLevel > 3)
        G4cout << "Calling G4DNAPTBIonisationModel::Initialise()" << G4endl;
 
    G4double scaleFactor = 1e-16 * cm*cm;
    G4double scaleFactorBorn = (1.e-22 / 3.343) * m*m;
 
    G4ParticleDefinition* electronDef = G4Electron::ElectronDefinition();
    G4ParticleDefinition* protonDef= G4Proton::ProtonDefinition();
 
    //*******************************************************
    // Cross section data
    //*******************************************************
 
    if(particle == electronDef)
    {
        G4String particleName = particle->GetParticleName();
 
        // Raw materials
        //
        AddCrossSectionData("THF",
                            particleName,
                            "dna/sigma_ionisation_e-_PTB_THF",
                            "dna/sigmadiff_cumulated_ionisation_e-_PTB_THF",
                            scaleFactor);
        SetLowELimit("THF", particleName, 12.*eV);
        SetHighELimit("THF", particleName, 1.*keV);
 
        AddCrossSectionData("PY",
                            particleName,
                            "dna/sigma_ionisation_e-_PTB_PY",
                            "dna/sigmadiff_cumulated_ionisation_e-_PTB_PY",
                            scaleFactor);
        SetLowELimit("PY", particleName, 12.*eV);
        SetHighELimit("PY", particleName, 1.*keV);
 
        AddCrossSectionData("PU",
                            particleName,
                            "dna/sigma_ionisation_e-_PTB_PU",
                            "dna/sigmadiff_cumulated_ionisation_e-_PTB_PU",
                            scaleFactor);
        SetLowELimit("PU", particleName, 12.*eV);
        SetHighELimit("PU", particleName, 1.*keV);
 
        AddCrossSectionData("TMP",
                            particleName,
                            "dna/sigma_ionisation_e-_PTB_TMP",
                            "dna/sigmadiff_cumulated_ionisation_e-_PTB_TMP",
                            scaleFactor);
        SetLowELimit("TMP", particleName, 12.*eV);
        SetHighELimit("TMP", particleName, 1.*keV);
 
        AddCrossSectionData("G4_WATER",
                            particleName,
                            "dna/sigma_ionisation_e_born",
                            "dna/sigmadiff_ionisation_e_born",
                            scaleFactorBorn);
        SetLowELimit("G4_WATER", particleName, 12.*eV);
        SetHighELimit("G4_WATER", particleName, 1.*keV);
 
        // DNA materials
        //
        AddCrossSectionData("backbone_THF",
                            particleName,
                            "dna/sigma_ionisation_e-_PTB_THF",
                            "dna/sigmadiff_cumulated_ionisation_e-_PTB_THF",
                            scaleFactor*33./30);
        SetLowELimit("backbone_THF", particleName, 12.*eV);
        SetHighELimit("backbone_THF", particleName, 1.*keV);
 
        AddCrossSectionData("cytosine_PY",
                            particleName,
                            "dna/sigma_ionisation_e-_PTB_PY",
                            "dna/sigmadiff_cumulated_ionisation_e-_PTB_PY",
                            scaleFactor*42./30);
        SetLowELimit("cytosine_PY", particleName, 12.*eV);
        SetHighELimit("cytosine_PY", particleName, 1.*keV);
 
        AddCrossSectionData("thymine_PY",
                            particleName,
                            "dna/sigma_ionisation_e-_PTB_PY",
                            "dna/sigmadiff_cumulated_ionisation_e-_PTB_PY",
                            scaleFactor*48./30);
        SetLowELimit("thymine_PY", particleName, 12.*eV);
        SetHighELimit("thymine_PY", particleName, 1.*keV);
 
        AddCrossSectionData("adenine_PU",
                            particleName,
                            "dna/sigma_ionisation_e-_PTB_PU",
                            "dna/sigmadiff_cumulated_ionisation_e-_PTB_PU",
                            scaleFactor*50./44);
        SetLowELimit("adenine_PU", particleName, 12.*eV);
        SetHighELimit("adenine_PU", particleName, 1.*keV);
 
        AddCrossSectionData("guanine_PU",
                            particleName,
                            "dna/sigma_ionisation_e-_PTB_PU",
                            "dna/sigmadiff_cumulated_ionisation_e-_PTB_PU",
                            scaleFactor*56./44);
        SetLowELimit("guanine_PU", particleName, 12.*eV);
        SetHighELimit("guanine_PU", particleName, 1.*keV);
 
        AddCrossSectionData("backbone_TMP",
                            particleName,
                            "dna/sigma_ionisation_e-_PTB_TMP",
                            "dna/sigmadiff_cumulated_ionisation_e-_PTB_TMP",
                            scaleFactor*33./50);
        SetLowELimit("backbone_TMP", particleName, 12.*eV);
        SetHighELimit("backbone_TMP", particleName, 1.*keV);
    }
 
    else if (particle == protonDef)
    {
        G4String particleName = particle->GetParticleName();
 
        // Raw materials
        //
        AddCrossSectionData("THF",
                            particleName,
                            "dna/sigma_ionisation_p_HKS_THF",
                            "dna/sigmadiff_cumulated_ionisation_p_PTB_THF",
                            scaleFactor);
        SetLowELimit("THF", particleName, 70.*keV);
        SetHighELimit("THF", particleName, 10.*MeV);
 
 
        AddCrossSectionData("PY",
                            particleName,
                            "dna/sigma_ionisation_p_HKS_PY",
                            "dna/sigmadiff_cumulated_ionisation_p_PTB_PY",
                            scaleFactor);
        SetLowELimit("PY", particleName, 70.*keV);
        SetHighELimit("PY", particleName, 10.*MeV);
 
        /*
         AddCrossSectionData("PU",
                                    particleName,
                                    "dna/sigma_ionisation_e-_PTB_PU",
                                    "dna/sigmadiff_cumulated_ionisation_e-_PTB_PU",
                                    scaleFactor);
                SetLowELimit("PU", particleName2, 70.*keV);
                SetHighELimit("PU", particleName2, 10.*keV);
*/
 
        AddCrossSectionData("TMP",
                            particleName,
                            "dna/sigma_ionisation_p_HKS_TMP",
                            "dna/sigmadiff_cumulated_ionisation_p_PTB_TMP",
                            scaleFactor);
        SetLowELimit("TMP", particleName, 70.*keV);
        SetHighELimit("TMP", particleName, 10.*MeV);
    }
 
    // *******************************************************
    // deal with composite materials
    // *******************************************************
 
    LoadCrossSectionData(particle->GetParticleName() );
 
    // *******************************************************
    // Verbose
    // *******************************************************
 
    // initialise DNAPTBAugerModel
    if(fDNAPTBAugerModel) fDNAPTBAugerModel->Initialise();
}

SampleSecondaries()

void G4DNAPTBIonisationModel::SampleSecondaries ( std::vector< G4DynamicParticle * > *  fvect, const G4MaterialCutsCouple *  , const G4String &  materialName, const G4DynamicParticle *  aDynamicParticle, G4ParticleChangeForGamma *  particleChangeForGamma, G4double  tmin, G4double  tmax  )

virtual

SampleSecondaries If the model is selected for the ModelInterface then SampleSecondaries will be called. The method sets the characteristics of the particles implied with the physical process after the ModelInterface (energy, momentum...). This method is mandatory for every model.

Parameters

materialName
particleChangeForGamma
tmin
tmax

Implements G4VDNAModel.

Definition at line 295 of file G4DNAPTBIonisationModel.cc.

{
    if (verboseLevel > 3)
        G4cout << "Calling SampleSecondaries() of G4DNAPTBIonisationModel" << G4endl;
 
    // Get the current particle energy
    G4double k = aDynamicParticle->GetKineticEnergy();
 
    // Get the current particle name
    const G4String& particleName = aDynamicParticle->GetDefinition()->GetParticleName();
 
    // Get the energy limits
    G4double lowLim = GetLowELimit(materialName, particleName);
    G4double highLim = GetHighELimit(materialName, particleName);
 
    // Check if we are in the correct energy range
    if (k >= lowLim && k < highLim)
    {
        G4ParticleMomentum primaryDirection = aDynamicParticle->GetMomentumDirection();
        G4double particleMass = aDynamicParticle->GetDefinition()->GetPDGMass();
        G4double totalEnergy = k + particleMass;
        G4double pSquare = k * (totalEnergy + particleMass);
        G4double totalMomentum = std::sqrt(pSquare);
 
        // Get the ionisation shell from a random sampling
        G4int ionizationShell = RandomSelectShell(k, particleName, materialName);
 
        // Get the binding energy from the ptbStructure class
        G4double bindingEnergy = ptbStructure.IonisationEnergy(ionizationShell, materialName);
 
        // Initialize the secondary kinetic energy to a negative value.
        G4double secondaryKinetic (-1000*eV);
 
        if(materialName!="G4_WATER")
        {
            // Get the energy of the secondary particle
            secondaryKinetic = RandomizeEjectedElectronEnergyFromCumulated(aDynamicParticle->GetDefinition(),k/eV,ionizationShell, materialName);
        }
        else
        {
            secondaryKinetic = RandomizeEjectedElectronEnergy(aDynamicParticle->GetDefinition(),k,ionizationShell, materialName);
        }
 
        if(secondaryKinetic<=0)
        {
            G4cout<<"Fatal error *************************************** "<<secondaryKinetic/eV<<G4endl;
            G4cout<<"secondaryKinetic: "<<secondaryKinetic/eV<<G4endl;
            G4cout<<"k: "<<k/eV<<G4endl;
            G4cout<<"shell: "<<ionizationShell<<G4endl;
            G4cout<<"material:"<<materialName<<G4endl;
            exit(EXIT_FAILURE);
        }
 
        G4double cosTheta = 0.;
        G4double phi = 0.;
        RandomizeEjectedElectronDirection(aDynamicParticle->GetDefinition(), k, secondaryKinetic, cosTheta, phi);
 
        G4double sinTheta = std::sqrt(1.-cosTheta*cosTheta);
        G4double dirX = sinTheta*std::cos(phi);
        G4double dirY = sinTheta*std::sin(phi);
        G4double dirZ = cosTheta;
        G4ThreeVector deltaDirection(dirX,dirY,dirZ);
        deltaDirection.rotateUz(primaryDirection);
 
        // The model is written only for electron  and thus we want the change the direction of the incident electron
        // after each ionization. However, if other particle are going to be introduced within this model the following should be added:
        //
        // Check if the particle is an electron
        if(aDynamicParticle->GetDefinition() == G4Electron::ElectronDefinition() )
        {
            // If yes do the following code until next commented "else" statement
 
            G4double deltaTotalMomentum = std::sqrt(secondaryKinetic*(secondaryKinetic + 2.*electron_mass_c2 ));
            G4double finalPx = totalMomentum*primaryDirection.x() - deltaTotalMomentum*deltaDirection.x();
            G4double finalPy = totalMomentum*primaryDirection.y() - deltaTotalMomentum*deltaDirection.y();
            G4double finalPz = totalMomentum*primaryDirection.z() - deltaTotalMomentum*deltaDirection.z();
            G4double finalMomentum = std::sqrt(finalPx*finalPx + finalPy*finalPy + finalPz*finalPz);
            finalPx /= finalMomentum;
            finalPy /= finalMomentum;
            finalPz /= finalMomentum;
 
            G4ThreeVector direction(finalPx,finalPy,finalPz);
            if(direction.unit().getX()>1||direction.unit().getY()>1||direction.unit().getZ()>1)
            {
                G4cout<<"Fatal error ****************************"<<G4endl;
                G4cout<<"direction problem "<<direction.unit()<<G4endl;
                exit(EXIT_FAILURE);
            }
 
            // Give the new direction to the particle
            particleChangeForGamma->ProposeMomentumDirection(direction.unit()) ;
        }
        // If the particle is not an electron
        else particleChangeForGamma->ProposeMomentumDirection(primaryDirection) ;
 
        // note that secondaryKinetic is the energy of the delta ray, not of all secondaries.
        G4double scatteredEnergy = k-bindingEnergy-secondaryKinetic;
 
        if(scatteredEnergy<=0)
        {
            G4cout<<"Fatal error ****************************"<<G4endl;
            G4cout<<"k: "<<k/eV<<G4endl;
            G4cout<<"secondaryKinetic: "<<secondaryKinetic/eV<<G4endl;
            G4cout<<"shell: "<<ionizationShell<<G4endl;
            G4cout<<"bindingEnergy: "<<bindingEnergy/eV<<G4endl;
            G4cout<<"scatteredEnergy: "<<scatteredEnergy/eV<<G4endl;
            G4cout<<"material: "<<materialName<<G4endl;
            exit(EXIT_FAILURE);
        }
 
        // Set the new energy of the particle
        particleChangeForGamma->SetProposedKineticEnergy(scatteredEnergy);
 
        // Set the energy deposited by the ionization
        particleChangeForGamma->ProposeLocalEnergyDeposit(k-scatteredEnergy-secondaryKinetic);
 
        // Create the new particle with its characteristics
        G4DynamicParticle* dp = new G4DynamicParticle (G4Electron::Electron(),deltaDirection,secondaryKinetic) ;
        fvect->push_back(dp);
 
        // Check if the auger model is activated (ie instanciated)
        if(fDNAPTBAugerModel)
        {
            // run the PTB Auger model
            if(materialName!="G4_WATER") fDNAPTBAugerModel->ComputeAugerEffect(fvect, materialName, bindingEnergy);
        }
    }
}

---

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

• G4DNAPTBIonisationModel.hh
• G4DNAPTBIonisationModel.cc