G4DNAPTBExcitationModel Class Reference

The G4DNAPTBExcitationModel class This class implements the PTB excitation model. More...

#include <G4DNAPTBExcitationModel.hh>

Inheritance diagram for G4DNAPTBExcitationModel:

Public Member Functions
	G4DNAPTBExcitationModel (const G4String &applyToMaterial="all", const G4ParticleDefinition *p=0, const G4String &nam="DNAPTBExcitationModel")
	G4DNAPTBExcitationModel Constructor.
virtual	~G4DNAPTBExcitationModel ()
	~G4DNAPTBExcitationModel Destructor
virtual void	Initialise (const G4ParticleDefinition *particle, const G4DataVector &= *(new G4DataVector()), G4ParticleChangeForGamma *fpChangeForGamme=nullptr)
	Initialise Set the materials for which the model can be used and defined the energy limits.
virtual G4double	CrossSectionPerVolume (const G4Material *material, const G4String &materialName, const G4ParticleDefinition *p, G4double ekin, G4double emin, G4double emax)
	CrossSectionPerVolume Retrieve the cross section corresponding to the current material, particle and energy.
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 the SampleSecondaries method will be called. The method sets the incident particle characteristics after the ModelInterface.
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 G4DNAPTBExcitationModel class This class implements the PTB excitation model.

Definition at line 50 of file G4DNAPTBExcitationModel.hh.

Constructor & Destructor Documentation

G4DNAPTBExcitationModel()

G4DNAPTBExcitationModel::G4DNAPTBExcitationModel	(	const G4String &	applyToMaterial = "all",
		const G4ParticleDefinition *	p = 0,
		const G4String &	nam = "DNAPTBExcitationModel"
	)

G4DNAPTBExcitationModel Constructor.

Parameters

applyToMaterial
p
nam

Definition at line 36 of file G4DNAPTBExcitationModel.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
 
    // initialisation of mean energy loss for each material
    tableMeanEnergyPTB["THF"] = 8.01*eV;
    tableMeanEnergyPTB["PY"] = 7.61*eV;
    tableMeanEnergyPTB["PU"] = 7.61*eV;
    tableMeanEnergyPTB["TMP"] = 8.01*eV;
 
    if( verboseLevel>0 )
    {
        G4cout << "PTB excitation model is constructed " << G4endl;
    }
}

~G4DNAPTBExcitationModel()

G4DNAPTBExcitationModel::~G4DNAPTBExcitationModel ( )

virtual

~G4DNAPTBExcitationModel Destructor

Definition at line 62 of file G4DNAPTBExcitationModel.cc.

{ 
 
}

Member Function Documentation

CrossSectionPerVolume()

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

virtual

CrossSectionPerVolume Retrieve the cross section corresponding to the current material, particle and energy.

Parameters

material
materialName
p
ekin
emin
emax

Returns

the cross section value

Implements G4VDNAModel.

Definition at line 186 of file G4DNAPTBExcitationModel.cc.

{
    if (verboseLevel > 3)
        G4cout << "Calling CrossSectionPerVolume() of G4DNAPTBExcitationModel" << G4endl;
 
    // Get the name of the current particle
    G4String particleName = particleDefinition->GetParticleName();
 
    // initialise variables
    G4double lowLim = 0;
    G4double highLim = 0;
    G4double sigma=0;
 
    // Get the low energy limit for the current particle
    lowLim = GetLowELimit(materialName, particleName);
 
    // Get the high energy limit for the current particle
    highLim = GetHighELimit(materialName, particleName);
 
    // Check that we are in the correct energy range
    if (ekin >= lowLim && ekin < highLim)
    {
        // Get the map with all the data tables
        TableMapData* tableData = GetTableData();
 
        // Retrieve the cross section value
        sigma = (*tableData)[materialName][particleName]->FindValue(ekin);
 
        if (verboseLevel > 2)
        {
            G4cout << "__________________________________" << G4endl;
            G4cout << "°°° G4DNAPTBExcitationModel - 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 << "°°° G4DNAPTBExcitationModel - XS INFO END" << G4endl;
        }
 
    }
 
    // Return the cross section value
    return sigma;
}

Initialise()

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

virtual

Initialise Set the materials for which the model can be used and defined the energy limits.

Implements G4VDNAModel.

Definition at line 69 of file G4DNAPTBExcitationModel.cc.

{
    if (verboseLevel > 3)
        G4cout << "Calling G4DNAPTBExcitationModel::Initialise()" << G4endl;
 
    G4double scaleFactor = 1e-16*cm*cm;
    G4double scaleFactorBorn = (1.e-22 / 3.343) * m*m;
 
    G4ParticleDefinition* electronDef = G4Electron::ElectronDefinition();
 
    //*******************************************************
    // Cross section data
    //*******************************************************
 
    if(particle == electronDef)
    {
        G4String particleName = particle->GetParticleName();
 
        AddCrossSectionData("THF",
                            particleName,
                            "dna/sigma_excitation_e-_PTB_THF",
                            scaleFactor);
        SetLowELimit("THF", particleName, 9.*eV);
        SetHighELimit("THF", particleName, 1.*keV);
 
        AddCrossSectionData("PY",
                            particleName,
                            "dna/sigma_excitation_e-_PTB_PY",
                            scaleFactor);
        SetLowELimit("PY", particleName, 9.*eV);
        SetHighELimit("PY", particleName, 1.*keV);
 
        AddCrossSectionData("PU",
                            particleName,
                            "dna/sigma_excitation_e-_PTB_PU",
                            scaleFactor);
        SetLowELimit("PU", particleName, 9.*eV);
        SetHighELimit("PU", particleName, 1.*keV);
 
        AddCrossSectionData("TMP",
                            particleName,
                            "dna/sigma_excitation_e-_PTB_TMP",
                            scaleFactor);
        SetLowELimit("TMP", particleName, 9.*eV);
        SetHighELimit("TMP", particleName, 1.*keV);
 
        AddCrossSectionData("G4_WATER",
                            particleName,
                            "dna/sigma_excitation_e_born",
                            scaleFactorBorn);
        SetLowELimit("G4_WATER", particleName, 9.*eV);
        SetHighELimit("G4_WATER", particleName, 1.*keV);
 
        // DNA materials
        //
        AddCrossSectionData("backbone_THF",
                            particleName,
                            "dna/sigma_excitation_e-_PTB_THF",
                            scaleFactor*33./30);
        SetLowELimit("backbone_THF", particleName, 9.*eV);
        SetHighELimit("backbone_THF", particleName, 1.*keV);
 
        AddCrossSectionData("cytosine_PY",
                            particleName,
                            "dna/sigma_excitation_e-_PTB_PY",
                            scaleFactor*42./30);
        SetLowELimit("cytosine_PY", particleName, 9.*eV);
        SetHighELimit("cytosine_PY", particleName, 1.*keV);
 
        AddCrossSectionData("thymine_PY",
                            particleName,
                            "dna/sigma_excitation_e-_PTB_PY",
                            scaleFactor*48./30);
        SetLowELimit("thymine_PY", particleName, 9.*eV);
        SetHighELimit("thymine_PY", particleName, 1.*keV);
 
        AddCrossSectionData("adenine_PU",
                            particleName,
                            "dna/sigma_excitation_e-_PTB_PU",
                            scaleFactor*50./44);
        SetLowELimit("adenine_PU", particleName, 9.*eV);
        SetHighELimit("adenine_PU", particleName, 1.*keV);
 
        AddCrossSectionData("guanine_PU",
                            particleName,
                            "dna/sigma_excitation_e-_PTB_PU",
                            scaleFactor*56./44);
        SetLowELimit("guanine_PU", particleName, 9.*eV);
        SetHighELimit("guanine_PU", particleName, 1.*keV);
 
        AddCrossSectionData("backbone_TMP",
                            particleName,
                            "dna/sigma_excitation_e-_PTB_TMP",
                            scaleFactor*33./50);
        SetLowELimit("backbone_TMP", particleName, 9.*eV);
        SetHighELimit("backbone_TMP", particleName, 1.*keV);
    }
 
    //*******************************************************
    // Load data
    //*******************************************************
 
    LoadCrossSectionData(particle->GetParticleName() );
 
    //*******************************************************
    // Verbose
    //*******************************************************
 
    if( verboseLevel>0 )
    {
        G4cout << "PTB excitation model is initialized " << G4endl;
    }
}

SampleSecondaries()

void G4DNAPTBExcitationModel::SampleSecondaries ( std::vector< G4DynamicParticle * > *  , 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 the SampleSecondaries method will be called. The method sets the incident particle characteristics after the ModelInterface.

Parameters

materialName
particleChangeForGamma
tmin
tmax

Implements G4VDNAModel.

Definition at line 236 of file G4DNAPTBExcitationModel.cc.

{
    if (verboseLevel > 3)
        G4cout << "Calling SampleSecondaries() of G4DNAPTBExcitationModel" << G4endl;
 
    // Get the incident particle kinetic energy
    G4double k = aDynamicParticle->GetKineticEnergy();
 
    if(materialName!="G4_WATER")
    {
        // Retrieve the excitation energy for the current material
        G4double excitationEnergy = tableMeanEnergyPTB[materialName];
 
        // Calculate the new energy of the particle
        G4double newEnergy = k - excitationEnergy;
 
        // Check that the new energy is above zero before applying it the particle.
        // Otherwise, do nothing.
        if (newEnergy > 0)
        {
            particleChangeForGamma->ProposeMomentumDirection(aDynamicParticle->GetMomentumDirection());
            particleChangeForGamma->SetProposedKineticEnergy(newEnergy);
            particleChangeForGamma->ProposeLocalEnergyDeposit(excitationEnergy);
        }
    }
    else
    {
        const G4String& particleName = aDynamicParticle->GetDefinition()->GetParticleName();
 
        G4int level = RandomSelectShell(k,particleName, materialName);
        G4double excitationEnergy = waterStructure.ExcitationEnergy(level);
        G4double newEnergy = k - excitationEnergy;
 
        if (newEnergy > 0)
        {
            particleChangeForGamma->ProposeMomentumDirection(aDynamicParticle->GetMomentumDirection());
            particleChangeForGamma->SetProposedKineticEnergy(newEnergy);
            particleChangeForGamma->ProposeLocalEnergyDeposit(excitationEnergy);
        }
 
        const G4Track * theIncomingTrack = particleChangeForGamma->GetCurrentTrack();
        G4DNAChemistryManager::Instance()->CreateWaterMolecule(eExcitedMolecule,
                                                               level,
                                                               theIncomingTrack);
    }
}

---

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

• G4DNAPTBExcitationModel.hh
• G4DNAPTBExcitationModel.cc