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

#include <G4DNAPTBIonisationModel.hh>

Inheritance diagram for G4DNAPTBIonisationModel:

Public Types
using	TriDimensionMap

using	VecMap

using	VecMapWithShell

Public Member Functions
	G4DNAPTBIonisationModel (const G4String &applyToMaterial="all", const G4ParticleDefinition *p=nullptr, const G4String &nam="DNAPTBIonisationModel", const G4bool isAuger=true)
	G4DNAPTBIonisationModel Constructor.

	~G4DNAPTBIonisationModel () override=default
	~G4DNAPTBIonisationModel Destructor

	G4DNAPTBIonisationModel (const G4DNAPTBIonisationModel &)=delete

G4DNAPTBIonisationModel &	operator= (const G4DNAPTBIonisationModel &right)=delete

void	Initialise (const G4ParticleDefinition *particle, const G4DataVector &data) override
	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.

G4double	CrossSectionPerVolume (const G4Material material, const G4ParticleDefinition p, G4double ekin, G4double emin, G4double emax) override
	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.

void	SampleSecondaries (std::vector< G4DynamicParticle * > , const G4MaterialCutsCouple , const G4DynamicParticle *, G4double tmin, G4double tmax) override
	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.

	~G4VDNAModel () override
	~G4VDNAModel

G4bool	IsMaterialDefine (const size_t &materialID)
	IsMaterialDefine Check if the given material is defined in the simulation.

G4bool	IsParticleExistingInModelForMaterial (const G4ParticleDefinition *particleName, const size_t &materialID)
	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 size_t &materialID, const G4ParticleDefinition *particle)
	GetHighEnergyLimit.

G4double	GetLowELimit (const size_t &materialID, const G4ParticleDefinition *particle)
	GetLowEnergyLimit.

void	SetHighELimit (const size_t &materialID, const G4ParticleDefinition *particle, G4double lim)
	SetHighEnergyLimit.

void	SetLowELimit (const size_t &materialID, const G4ParticleDefinition *particle, G4double lim)
	SetLowEnergyLimit.

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

virtual	~G4VEmModel ()

virtual void	InitialiseLocal (const G4ParticleDefinition , G4VEmModel masterModel)

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	GetPartialCrossSection (const G4Material , G4int level, const G4ParticleDefinition , G4double kineticEnergy)

virtual G4double	ComputeCrossSectionPerAtom (const G4ParticleDefinition *, G4double kinEnergy, G4double Z, G4double A=0., G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)

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 , const G4double &length, G4double &eloss)

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	FillNumberOfSecondaries (G4int &numberOfTriplets, G4int &numberOfRecoil)

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)

const G4Element *	SelectRandomAtom (const G4MaterialCutsCouple , const G4ParticleDefinition , G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)

const G4Element *	SelectTargetAtom (const G4MaterialCutsCouple , const G4ParticleDefinition , G4double kineticEnergy, G4double logKineticEnergy, 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)

const G4Element *	GetCurrentElement (const G4Material *mat=nullptr) const

G4int	SelectRandomAtomNumber (const G4Material *) const

const G4Isotope *	GetCurrentIsotope (const G4Element *elm=nullptr) const

G4int	SelectIsotopeNumber (const G4Element *) const

void	SetParticleChange (G4VParticleChange , G4VEmFluctuationModel f=nullptr)

void	SetCrossSectionTable (G4PhysicsTable *, G4bool isLocal)

G4ElementData *	GetElementData ()

G4PhysicsTable *	GetCrossSectionTable ()

G4VEmFluctuationModel *	GetModelOfFluctuations ()

G4VEmAngularDistribution *	GetAngularDistribution ()

G4VEmModel *	GetTripletModel ()

void	SetTripletModel (G4VEmModel *)

void	SetAngularDistribution (G4VEmAngularDistribution *)

G4double	HighEnergyLimit () const

G4double	LowEnergyLimit () const

G4double	HighEnergyActivationLimit () const

G4double	LowEnergyActivationLimit () const

G4double	PolarAngleLimit () const

G4double	SecondaryThreshold () 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) const

void	SetPolarAngleLimit (G4double)

void	SetSecondaryThreshold (G4double)

void	SetDeexcitationFlag (G4bool val)

void	SetForceBuildTable (G4bool val)

void	SetFluctuationFlag (G4bool val)

void	SetMasterThread (G4bool val)

G4bool	IsMaster () const

void	SetUseBaseMaterials (G4bool val)

G4bool	UseBaseMaterials () const

G4double	MaxSecondaryKinEnergy (const G4DynamicParticle *dynParticle)

const G4String &	GetName () const

void	SetCurrentCouple (const G4MaterialCutsCouple *)

G4bool	IsLocked () const

void	SetLocked (G4bool)

void	SetLPMFlag (G4bool)

G4VEmModel &	operator= (const G4VEmModel &right)=delete

	G4VEmModel (const G4VEmModel &)=delete

Public Attributes
G4ParticleChangeForGamma *	fParticleChangeForGamma = nullptr

Additional Inherited Members
Protected Types inherited from G4VDNAModel
using	MaterialParticleMapData

Protected Member Functions inherited from G4VDNAModel
MaterialParticleMapData *	GetData ()
	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 size_t &materialID, const G4ParticleDefinition *p, const G4String &file, const G4double &scaleFactor)
	ReadAndSaveCSFile Read and save a "simple" cross section file : use of G4DNACrossSectionDataSet->loadData()

G4int	RandomSelectShell (const G4double &k, const G4ParticleDefinition *particle, const size_t &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 (const size_t &materialName, const G4ParticleDefinition *particleName, const G4String &fileCS, const G4String &fileDiffCS, const 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 (const size_t &materialName, const G4ParticleDefinition *particleName, const G4String &fileCS, const 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 G4ParticleDefinition *particleName)
	LoadCrossSectionData Method to loop on all the registered materials in the model and load the corresponding data.

virtual void	ReadDiffCSFile (const size_t &materialName, const G4ParticleDefinition *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 size_t &materialID, const G4ParticleDefinition *p)
	EnableMaterialAndParticle.

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

Protected Attributes inherited from G4VDNAModel
G4bool	isInitialised = false

Protected Attributes inherited from G4VEmModel
G4ElementData *	fElementData = nullptr

G4VParticleChange *	pParticleChange = nullptr

G4PhysicsTable *	xSectionTable = nullptr

const G4Material *	pBaseMaterial = nullptr

const std::vector< G4double > *	theDensityFactor = nullptr

const std::vector< G4int > *	theDensityIdx = nullptr

G4double	inveplus

G4double	pFactor = 1.0

std::size_t	currentCoupleIndex = 0

std::size_t	basedCoupleIndex = 0

G4bool	lossFlucFlag = true

Detailed Description

The G4DNAPTBIonisationModel class Implements the PTB ionisation model.

Definition at line 50 of file G4DNAPTBIonisationModel.hh.

Member Typedef Documentation

◆ TriDimensionMap

using G4DNAPTBIonisationModel::TriDimensionMap

Initial value:

 
    std::map<std::size_t, std::map<const G4ParticleDefinition*,
                       std::map<G4double, std::map<G4double, std::map<G4double, G4double>>>>>

Definition at line 53 of file G4DNAPTBIonisationModel.hh.

◆ VecMap

using G4DNAPTBIonisationModel::VecMap

Initial value:

std::map<std::size_t,

std::map<const G4ParticleDefinition*, std::map<G4double, std::vector<G4double>>>>

Definition at line 56 of file G4DNAPTBIonisationModel.hh.

◆ VecMapWithShell

using G4DNAPTBIonisationModel::VecMapWithShell

Initial value:

 
    std::map<std::size_t, std::map<const G4ParticleDefinition*,
                       std::map<G4double, std::map<G4double, std::vector<G4double>>>>>

Definition at line 58 of file G4DNAPTBIonisationModel.hh.

Constructor & Destructor Documentation

◆ G4DNAPTBIonisationModel() [1/2]

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

explicit

G4DNAPTBIonisationModel Constructor.

Parameters

applyToMaterial
p
nam
isAuger

Definition at line 39 of file G4DNAPTBIonisationModel.cc.

  : G4VDNAModel(nam, applyToMaterial)
{
  if (isAuger) {
    // create the PTB Auger model
    fpDNAPTBAugerModel = std::make_unique<G4DNAPTBAugerModel>("e-_G4DNAPTBAugerModel");
  }
  fpTHF = G4Material::GetMaterial("THF", false);
  fpPY = G4Material::GetMaterial("PY", false);
  fpPU = G4Material::GetMaterial("PU", false);
  fpTMP = G4Material::GetMaterial("TMP", false);
  fpG4_WATER = G4Material::GetMaterial("G4_WATER", false);
  fpBackbone_THF = G4Material::GetMaterial("backbone_THF", false);
  fpCytosine_PY = G4Material::GetMaterial("cytosine_PY", false);
  fpThymine_PY = G4Material::GetMaterial("thymine_PY", false);
  fpAdenine_PU = G4Material::GetMaterial("adenine_PU", false);
  fpBackbone_TMP = G4Material::GetMaterial("backbone_TMP", false);
  fpGuanine_PU = G4Material::GetMaterial("guanine_PU", false);
  fpN2 = G4Material::GetMaterial("N2", false);
}

◆ ~G4DNAPTBIonisationModel()

G4DNAPTBIonisationModel::~G4DNAPTBIonisationModel ( )

overridedefault

~G4DNAPTBIonisationModel Destructor

◆ G4DNAPTBIonisationModel() [2/2]

G4DNAPTBIonisationModel::G4DNAPTBIonisationModel ( const G4DNAPTBIonisationModel & )

delete

Member Function Documentation

◆ CrossSectionPerVolume()

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

overridevirtual

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 255 of file G4DNAPTBIonisationModel.cc.

{
  // initialise the cross section value (output value)
  G4double sigma(0);
 
  // Get the current particle name
  const G4String& particleName = p->GetParticleName();
  const std::size_t& matID = material->GetIndex();
 
  // Set the low and high energy limits
  G4double lowLim = fpModelData->GetLowELimit(matID, p);
  G4double highLim = fpModelData->GetHighELimit(matID, p);
 
  // Check that we are in the correct energy range
  if (ekin >= lowLim && ekin < highLim) {
    // Get the map with all the model data tables
    auto tableData = fpModelData->GetData();
    if ((*tableData)[matID][p] == nullptr) {
      G4Exception("G4DNAPTBIonisationModel::CrossSectionPerVolume", "em00236", FatalException,
                  "No model is registered");
    }
    // Retrieve the cross section value for the current material, particle and energy values
    sigma = (*tableData)[matID][p]->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 " << matID << " index molecule (cm^2)=" << sigma / cm / cm
             << G4endl;
      G4cout << "°°° G4DNAPTBIonisationModel - XS INFO END" << G4endl;
    }
  }
 
  // Return the cross section value
  auto MolDensity =
    (*G4DNAMolecularMaterial::Instance()->GetNumMolPerVolTableFor(material))[matID];
  return sigma * MolDensity;
}

◆ Initialise()

void G4DNAPTBIonisationModel::Initialise	(	const G4ParticleDefinition *	particle,
		const G4DataVector &	data )

overridevirtual

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 64 of file G4DNAPTBIonisationModel.cc.

{
  if (isInitialised) {
    return;
  }
  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
  //*******************************************************
  std::size_t index;
  if (particle == electronDef) {
    // Raw materials
    //
    // MPietrzak
    if (fpN2 != nullptr) {
      index = fpN2->GetIndex();
      AddCrossSectionData(index, particle, "dna/sigma_ionisation_e-_PTB_N2",
                          "dna/sigmadiff_cumulated_ionisation_e-_PTB_N2", scaleFactor);
      SetLowELimit(index, particle, 15.5 * eV);
      SetHighELimit(index, particle, 1.02 * MeV);
    }
 
    // MPietrzak
 
    if (fpTHF != nullptr) {
      index = fpTHF->GetIndex();
      AddCrossSectionData(index, particle, "dna/sigma_ionisation_e-_PTB_THF",
                          "dna/sigmadiff_cumulated_ionisation_e-_PTB_THF", scaleFactor);
      SetLowELimit(index, particle, 12. * eV);
      SetHighELimit(index, particle, 1. * keV);
    }
 
    if (fpPY != nullptr) {
      index = fpPY->GetIndex();
      AddCrossSectionData(index, particle, "dna/sigma_ionisation_e-_PTB_PY",
                          "dna/sigmadiff_cumulated_ionisation_e-_PTB_PY", scaleFactor);
      SetLowELimit(index, particle, 12. * eV);
      SetHighELimit(index, particle, 1. * keV);
    }
 
    if (fpPU != nullptr) {
      index = fpPU->GetIndex();
      AddCrossSectionData(index, particle, "dna/sigma_ionisation_e-_PTB_PU",
                          "dna/sigmadiff_cumulated_ionisation_e-_PTB_PU", scaleFactor);
      SetLowELimit(index, particle, 12. * eV);
      SetHighELimit(index, particle, 1. * keV);
    }
    if (fpTMP != nullptr) {
      index = fpTMP->GetIndex();
      AddCrossSectionData(index, particle, "dna/sigma_ionisation_e-_PTB_TMP",
                          "dna/sigmadiff_cumulated_ionisation_e-_PTB_TMP", scaleFactor);
      SetLowELimit(index, particle, 12. * eV);
      SetHighELimit(index, particle, 1. * keV);
    }
 
    if (fpG4_WATER != nullptr) {
      index = fpG4_WATER->GetIndex();
      AddCrossSectionData(index, particle, "dna/sigma_ionisation_e_born",
                          "dna/sigmadiff_ionisation_e_born", scaleFactorBorn);
      SetLowELimit(index, particle, 12. * eV);
      SetHighELimit(index, particle, 1. * keV);
    }
    // DNA materials
    //
    if (fpBackbone_THF != nullptr) {
      index = fpBackbone_THF->GetIndex();
      AddCrossSectionData(index, particle, "dna/sigma_ionisation_e-_PTB_THF",
                          "dna/sigmadiff_cumulated_ionisation_e-_PTB_THF", scaleFactor * 33. / 30);
      SetLowELimit(index, particle, 12. * eV);
      SetHighELimit(index, particle, 1. * keV);
    }
 
    if (fpCytosine_PY != nullptr) {
      index = fpCytosine_PY->GetIndex();
      AddCrossSectionData(index, particle, "dna/sigma_ionisation_e-_PTB_PY",
                          "dna/sigmadiff_cumulated_ionisation_e-_PTB_PY", scaleFactor * 42. / 30);
      SetLowELimit(index, particle, 12. * eV);
      SetHighELimit(index, particle, 1. * keV);
    }
 
    if (fpThymine_PY != nullptr) {
      index = fpThymine_PY->GetIndex();
      AddCrossSectionData(index, particle, "dna/sigma_ionisation_e-_PTB_PY",
                          "dna/sigmadiff_cumulated_ionisation_e-_PTB_PY", scaleFactor * 48. / 30);
      SetLowELimit(index, particle, 12. * eV);
      SetHighELimit(index, particle, 1. * keV);
    }
 
    if (fpAdenine_PU != nullptr) {
      index = fpAdenine_PU->GetIndex();
      AddCrossSectionData(index, particle, "dna/sigma_ionisation_e-_PTB_PU",
                          "dna/sigmadiff_cumulated_ionisation_e-_PTB_PU", scaleFactor * 50. / 44);
      SetLowELimit(index, particle, 12. * eV);
      SetHighELimit(index, particle, 1. * keV);
    }
 
    if (fpGuanine_PU != nullptr) {
      index = fpGuanine_PU->GetIndex();
      AddCrossSectionData(index, particle, "dna/sigma_ionisation_e-_PTB_PU",
                          "dna/sigmadiff_cumulated_ionisation_e-_PTB_PU", scaleFactor * 56. / 44);
      SetLowELimit(index, particle, 12. * eV);
      SetHighELimit(index, particle, 1. * keV);
    }
 
    if (fpBackbone_TMP != nullptr) {
      index = fpBackbone_TMP->GetIndex();
      AddCrossSectionData(index, particle, "dna/sigma_ionisation_e-_PTB_TMP",
                          "dna/sigmadiff_cumulated_ionisation_e-_PTB_TMP", scaleFactor * 33. / 50);
      SetLowELimit(index, particle, 12. * eV);
      SetHighELimit(index, particle, 1. * keV);
    }
  }
 
  else if (particle == protonDef) {
    G4String particleName = particle->GetParticleName();
 
    // Raw materials
    //
    if (fpTHF != nullptr) {
      index = fpTHF->GetIndex();
      AddCrossSectionData(index, particle, "dna/sigma_ionisation_p_HKS_THF",
                          "dna/sigmadiff_cumulated_ionisation_p_PTB_THF", scaleFactor);
      SetLowELimit(index, particle, 70. * keV);
      SetHighELimit(index, particle, 10. * MeV);
    }
 
    if (fpPY != nullptr) {
      index = fpPY->GetIndex();
      AddCrossSectionData(index, particle, "dna/sigma_ionisation_p_HKS_PY",
                          "dna/sigmadiff_cumulated_ionisation_p_PTB_PY", scaleFactor);
      SetLowELimit(index, particle, 70. * keV);
      SetHighELimit(index, particle, 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);
*/
 
    if (fpTMP != nullptr) {
      index = fpTMP->GetIndex();
      AddCrossSectionData(index, particle, "dna/sigma_ionisation_p_HKS_TMP",
                          "dna/sigmadiff_cumulated_ionisation_p_PTB_TMP", scaleFactor);
      SetLowELimit(index, particle, 70. * keV);
      SetHighELimit(index, particle, 10. * MeV);
    }
  }
  // *******************************************************
  // deal with composite materials
  // *******************************************************
  if (!G4DNAMaterialManager::Instance()->IsLocked()) {
    LoadCrossSectionData(particle);
    G4DNAMaterialManager::Instance()->SetMasterDataModel(DNAModelType::fDNAIonisation, this);
    fpModelData = this;
  }
  else {
    auto dataModel = dynamic_cast<G4DNAPTBIonisationModel*>(
      G4DNAMaterialManager::Instance()->GetModel(DNAModelType::fDNAIonisation));
    if (dataModel == nullptr) {
      G4cout << "G4DNAPTBIonisationModel::Initialise:: not good modelData" << G4endl;
      G4Exception("G4DNAPTBIonisationModel::Initialise", "PTB0004", FatalException,
                  "not good modelData");
    }
    else {
      fpModelData = dataModel;
    }
  }
  // initialise DNAPTBAugerModel
  if (fpDNAPTBAugerModel) {
    fpDNAPTBAugerModel->Initialise();
  }
  fParticleChangeForGamma = GetParticleChangeForGamma();
  isInitialised = true;
}

◆ operator=()

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

delete

◆ SampleSecondaries()

void G4DNAPTBIonisationModel::SampleSecondaries	(	std::vector< G4DynamicParticle * > *	fvect,
		const G4MaterialCutsCouple *	pCouple,
		const G4DynamicParticle *	aDynamicParticle,
		G4double	tmin,
		G4double	tmax )

overridevirtual

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

param particleChangeForGamma

Parameters

tmin

param tmax

Implements G4VDNAModel.

Definition at line 300 of file G4DNAPTBIonisationModel.cc.

{
  // Get the current particle energy
  G4double k = aDynamicParticle->GetKineticEnergy();
  const std::size_t& materialID = pCouple->GetMaterial()->GetIndex();
 
  // Get the current particle name
  const auto& p = aDynamicParticle->GetDefinition();
  auto materialName = pCouple->GetMaterial()->GetName();
  // Get the energy limits
  G4double lowLim = fpModelData->GetLowELimit(materialID, p);
  G4double highLim = fpModelData->GetHighELimit(materialID, p);
 
  // 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 = fpModelData->RandomSelectShell(k, p, materialID);
 
    // Get the binding energy from the ptbStructure class
    G4double bindingEnergy = ptbStructure.IonisationEnergy(ionizationShell, materialID);
 
    // Initialize the secondary kinetic energy to a negative value.
    G4double secondaryKinetic(-1000 * eV);
 
    if (fpG4_WATER == nullptr || materialID != fpG4_WATER->GetIndex()) {
      // Get the energy of the secondary particle
      secondaryKinetic = fpModelData->RandomizeEjectedElectronEnergyFromCumulated(
        aDynamicParticle->GetDefinition(), k / eV, ionizationShell, materialID);
    }
    else {
      secondaryKinetic = fpModelData->RandomizeEjectedElectronEnergy(
        aDynamicParticle->GetDefinition(), k, ionizationShell, materialID);
    }
 
    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;
      G4Exception("G4DNAPTBIonisationModel::SampleSecondaries", "em0026", FatalException,
                  "Fatal error:: scatteredEnergy <= 0");
    }
 
    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;
        G4Exception("G4DNAPTBIonisationModel::SampleSecondaries", "em0017", FatalException,
                    "Fatal error:: direction problem");
      }
 
      // Give the new direction to the particle
      fParticleChangeForGamma->ProposeMomentumDirection(direction.unit());
    }
    // If the particle is not an electron
    else {
      fParticleChangeForGamma->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;
      G4Exception("G4DNAPTBIonisationModel::SampleSecondaries", "em0016", FatalException,
                  "Fatal error:: scatteredEnergy <= 0");
    }
 
    // Set the new energy of the particle
    fParticleChangeForGamma->SetProposedKineticEnergy(scatteredEnergy);
 
    // Set the energy deposited by the ionization
    fParticleChangeForGamma->ProposeLocalEnergyDeposit(k - scatteredEnergy - secondaryKinetic);
 
    // Create the new particle with its characteristics
    auto dp = new G4DynamicParticle(G4Electron::Electron(), deltaDirection, secondaryKinetic);
    fvect->push_back(dp);
 
    // Check if the auger model is activated (ie instanciated)
    if (fpDNAPTBAugerModel) {
      // run the PTB Auger model
      if (materialName != "G4_WATER") {
        fpDNAPTBAugerModel->ComputeAugerEffect(fvect, materialName, bindingEnergy);
      }
    }
  }
}

Member Data Documentation

◆ fParticleChangeForGamma

G4ParticleChangeForGamma* G4DNAPTBIonisationModel::fParticleChangeForGamma = nullptr

Definition at line 118 of file G4DNAPTBIonisationModel.hh.

Referenced by Initialise(), and SampleSecondaries().

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

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TriDimensionMap

◆ VecMap

◆ VecMapWithShell

Constructor & Destructor Documentation

◆ G4DNAPTBIonisationModel() [1/2]

◆ ~G4DNAPTBIonisationModel()

◆ G4DNAPTBIonisationModel() [2/2]

Member Function Documentation

◆ CrossSectionPerVolume()

◆ Initialise()

◆ operator=()

◆ SampleSecondaries()

Member Data Documentation

◆ fParticleChangeForGamma