#include <G4DNACPA100IonisationModel.hh>

Inheritance diagram for G4DNACPA100IonisationModel:

Public Member Functions
	G4DNACPA100IonisationModel (const G4ParticleDefinition *p=nullptr, const G4String &nam="DNACPA100IonisationModel")

	~G4DNACPA100IonisationModel () override=default

void	Initialise (const G4ParticleDefinition *, const G4DataVector &) override
	Initialise Each model must implement an Initialize method.

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

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

G4double	DifferentialCrossSection (PartKineticInMat info, const G4double &energyTransfer)

void	SelectFasterComputation (G4bool input)

void	SelectUseDcs (G4bool input)

void	SelectStationary (G4bool input)

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

	G4DNACPA100IonisationModel (const G4DNACPA100IonisationModel &)=delete

void	ReadDiffCSFile (const std::size_t &materialID, const G4ParticleDefinition *p, const G4String &file, const G4double &scaleFactor) override

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

Protected Attributes
G4ParticleChangeForGamma *	fParticleChangeForGamma = nullptr

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

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

Detailed Description

Definition at line 56 of file G4DNACPA100IonisationModel.hh.

Constructor & Destructor Documentation

◆ G4DNACPA100IonisationModel() [1/2]

G4DNACPA100IonisationModel::G4DNACPA100IonisationModel	(	const G4ParticleDefinition *	p = nullptr,
		const G4String &	nam = "DNACPA100IonisationModel" )

explicit

Definition at line 62 of file G4DNACPA100IonisationModel.cc.

  : G4VDNAModel(nam, "all")
{
  fpGuanine = G4Material::GetMaterial("G4_GUANINE", false);
  fpG4_WATER = G4Material::GetMaterial("G4_WATER", false);
  fpDeoxyribose = G4Material::GetMaterial("G4_DEOXYRIBOSE", false);
  fpCytosine = G4Material::GetMaterial("G4_CYTOSINE", false);
  fpThymine = G4Material::GetMaterial("G4_THYMINE", false);
  fpAdenine = G4Material::GetMaterial("G4_ADENINE", false);
  fpPhosphate = G4Material::GetMaterial("G4_PHOSPHORIC_ACID", false);
  fpParticle = G4Electron::ElectronDefinition();
}

◆ ~G4DNACPA100IonisationModel()

G4DNACPA100IonisationModel::~G4DNACPA100IonisationModel ( )

overridedefault

◆ G4DNACPA100IonisationModel() [2/2]

G4DNACPA100IonisationModel::G4DNACPA100IonisationModel ( const G4DNACPA100IonisationModel & )

delete

Member Function Documentation

◆ CrossSectionPerVolume()

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

overridevirtual

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.

Parameters

material

param materialName

Parameters

p

param ekin

Parameters

emin
emax

Returns: crossSection*numberOfMoleculesPerVolumeUnit

Implements G4VDNAModel.

Definition at line 205 of file G4DNACPA100IonisationModel.cc.

{
  // initialise the cross section value (output value)
  G4double sigma(0);
 
  // Get the current particle name
  const G4String& particleName = p->GetParticleName();
 
  if (p != fpParticle) {
    G4Exception("G4DNACPA100IonisationModel::CrossSectionPerVolume", "em00223", FatalException,
                "No model is registered for this particle");
  }
 
  auto 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("G4DNACPA100IonisationModel::CrossSectionPerVolume", "em00236", FatalException,
                  "No model is registered");
    }
    else {
      sigma = (*tableData)[matID][p]->FindValue(ekin);
    }
 
    if (verboseLevel > 2) {
      auto MolDensity =
        (*G4DNAMolecularMaterial::Instance()->GetNumMolPerVolTableFor(material))[matID];
      G4cout << "__________________________________" << G4endl;
      G4cout << "°°° G4DNACPA100IonisationModel - XS INFO START" << G4endl;
      G4cout << "°°° Kinetic energy(eV)=" << ekin / eV << " particle : " << particleName << G4endl;
      G4cout << "°°° lowLim (eV) = " << lowLim / eV << " highLim (eV) : " << highLim / eV << G4endl;
      G4cout << "°°° Materials = " << (*G4Material::GetMaterialTable())[matID]->GetName() << G4endl;
      G4cout << "°°° Cross section per " << matID << " index molecule (cm^2)=" << sigma / cm / cm
             << G4endl;
      G4cout << "°°° Cross section per Phosphate molecule (cm^-1)="
             << sigma * MolDensity / (1. / cm) << G4endl;
      G4cout << "°°° G4DNACPA100IonisationModel - XS INFO END" << G4endl;
    }
  }
 
  auto MolDensity = (*G4DNAMolecularMaterial::Instance()->GetNumMolPerVolTableFor(material))[matID];
  return sigma * MolDensity;
}

◆ DifferentialCrossSection()

G4double G4DNACPA100IonisationModel::DifferentialCrossSection	(	PartKineticInMat	info,
		const G4double &	energyTransfer )

Definition at line 465 of file G4DNACPA100IonisationModel.cc.

{
  auto MatID = std::get<0>(info);
  auto k = std::get<1>(info) / eV;  // in eV unit
  auto shell = std::get<2>(info);
  G4double sigma = 0.;
  G4double shellEnergy = iStructure.IonisationEnergy(shell, MatID);
  G4double kSE(energyTransfer - shellEnergy);
 
  if (energyTransfer >= shellEnergy) {
    G4double valueT1 = 0;
    G4double valueT2 = 0;
    G4double valueE21 = 0;
    G4double valueE22 = 0;
    G4double valueE12 = 0;
    G4double valueE11 = 0;
 
    G4double xs11 = 0;
    G4double xs12 = 0;
    G4double xs21 = 0;
    G4double xs22 = 0;
 
    auto t2 = std::upper_bound(fTMapWithVec[MatID][fpParticle].begin(),
                               fTMapWithVec[MatID][fpParticle].end(), k);
    auto t1 = t2 - 1;
 
    if (kSE <= fEMapWithVector[MatID][fpParticle][(*t1)].back()
        && kSE <= fEMapWithVector[MatID][fpParticle][(*t2)].back())
    {
      auto e12 = std::upper_bound(fEMapWithVector[MatID][fpParticle][(*t1)].begin(),
                                  fEMapWithVector[MatID][fpParticle][(*t1)].end(), kSE);
      auto e11 = e12 - 1;
 
      auto e22 = std::upper_bound(fEMapWithVector[MatID][fpParticle][(*t2)].begin(),
                                  fEMapWithVector[MatID][fpParticle][(*t2)].end(), kSE);
      auto e21 = e22 - 1;
 
      valueT1 = *t1;
      valueT2 = *t2;
      valueE21 = *e21;
      valueE22 = *e22;
      valueE12 = *e12;
      valueE11 = *e11;
 
      xs11 = diffCrossSectionData[MatID][fpParticle][shell][valueT1][valueE11];
      xs12 = diffCrossSectionData[MatID][fpParticle][shell][valueT1][valueE12];
      xs21 = diffCrossSectionData[MatID][fpParticle][shell][valueT2][valueE21];
      xs22 = diffCrossSectionData[MatID][fpParticle][shell][valueT2][valueE22];
    }
 
    G4double xsProduct = xs11 * xs12 * xs21 * xs22;
 
    if (xsProduct != 0.) {
      sigma = QuadInterpolator(valueE11, valueE12, valueE21, valueE22, xs11, xs12, xs21, xs22,
                               valueT1, valueT2, k, kSE);
    }
  }
 
  return sigma;
}

◆ Initialise()

void G4DNACPA100IonisationModel::Initialise	(	const G4ParticleDefinition *	particle,
		const G4DataVector &	cuts )

overridevirtual

Initialise Each model must implement an Initialize method.

Parameters

particle
cuts

Implements G4VDNAModel.

Definition at line 78 of file G4DNACPA100IonisationModel.cc.

{
  if (isInitialised) {
    return;
  }
  if (verboseLevel > 3) {
    G4cout << "Calling G4DNACPA100IonisationModel::Initialise()" << G4endl;
  }
 
  if (!G4DNAMaterialManager::Instance()->IsLocked()) {
    if (p != fpParticle) {
      std::ostringstream oss;
      oss << " Model is not applied for this particle " << p->GetParticleName();
      G4Exception("G4DNACPA100IonisationModel::G4DNACPA100IonisationModel", "CPA001",
                  FatalException, oss.str().c_str());
    }
 
    const char* path = G4FindDataDir("G4LEDATA");
 
    if (path == nullptr) {
      G4Exception("G4DNACPA100IonisationModel::Initialise", "em0006", FatalException,
                  "G4LEDATA environment variable not set.");
      return;
    }
 
    std::size_t index;
    if (fpG4_WATER != nullptr) {
      index = fpG4_WATER->GetIndex();
      G4String eFullFileName = "";
      fasterCode ? eFullFileName = "/dna/sigmadiff_cumulated_ionisation_e_cpa100_rel"
                 : eFullFileName = "/dna/sigmadiff_ionisation_e_cpa100_rel";
      AddCrossSectionData(index, p, "dna/sigma_ionisation_e_cpa100_form_rel", eFullFileName,
                          1.e-20 * m * m);
      SetLowELimit(index, p, 11 * eV);
      SetHighELimit(index, p, 255955 * eV);
    }
    if (fpGuanine != nullptr) {
      index = fpGuanine->GetIndex();
      G4String eFullFileName = "";
      if(useDcs) {
        fasterCode ? eFullFileName = "/dna/sigmadiff_cumulated_elastic_e_cpa100_guanine"
                   : eFullFileName = "/dna/sigmadiff_ionisation_e_cpa100_guanine";
      }
      AddCrossSectionData(index, p, "dna/sigma_ionisation_e_cpa100_guanine", eFullFileName,
                          1. * cm * cm);
      SetLowELimit(index, p, 11 * eV);
      SetHighELimit(index, p, 1 * MeV);
    }
    if (fpDeoxyribose != nullptr) {
      index = fpDeoxyribose->GetIndex();
      G4String eFullFileName = "";
      if(useDcs) {
        eFullFileName = "/dna/sigmadiff_cumulated_ionisation_e_cpa100_deoxyribose";
      }
      AddCrossSectionData(index, p, "dna/sigma_ionisation_e_cpa100_deoxyribose", eFullFileName,
                          1. * cm * cm);
      SetLowELimit(index, p, 11 * eV);
      SetHighELimit(index, p, 1 * MeV);
    }
    if (fpCytosine != nullptr) {
      index = fpCytosine->GetIndex();
      G4String eFullFileName = "";
      if(useDcs) {
        fasterCode ? eFullFileName = "/dna/sigmadiff_cumulated_ionisation_e_cpa100_cytosine"
                   : eFullFileName = "/dna/sigmadiff_ionisation_e_cpa100_cytosine";
      }
      AddCrossSectionData(index, p, "dna/sigma_ionisation_e_cpa100_cytosine", eFullFileName,
                          1. * cm * cm);
      SetLowELimit(index, p, 11 * eV);
      SetHighELimit(index, p, 1 * MeV);
    }
    if (fpThymine != nullptr) {
      index = fpThymine->GetIndex();
      G4String eFullFileName = "";
      if(useDcs) {
        fasterCode ? eFullFileName = "/dna/sigmadiff_cumulated_ionisation_e_cpa100_thymine"
                   : eFullFileName = "/dna/sigmadiff_ionisation_e_cpa100_thymine";
      }
      AddCrossSectionData(index, p, "dna/sigma_ionisation_e_cpa100_thymine", eFullFileName,
                          1. * cm * cm);
      SetLowELimit(index, p, 11 * eV);
      SetHighELimit(index, p, 1 * MeV);
    }
    if (fpAdenine != nullptr) {
      index = fpAdenine->GetIndex();
      G4String eFullFileName = "";
      if(useDcs) {
        fasterCode ? eFullFileName = "/dna/sigmadiff_cumulated_ionisation_e_cpa100_adenine"
                   : eFullFileName = "/dna/sigmadiff_ionisation_e_cpa100_adenine";
      }
      AddCrossSectionData(index, p, "dna/sigma_ionisation_e_cpa100_adenine", eFullFileName,
                          1. * cm * cm);
      SetLowELimit(index, p, 11 * eV);
      SetHighELimit(index, p, 1 * MeV);
    }
    if (fpPhosphate != nullptr) {
      index = fpPhosphate->GetIndex();
      G4String eFullFileName = "";
      if(useDcs) {
        eFullFileName = "dna/sigmadiff_cumulated_ionisation_e_cpa100_phosphoric_acid";
      }
      AddCrossSectionData(index, p, "dna/sigma_ionisation_e_cpa100_phosphoric_acid",eFullFileName,
                          1. * cm * cm);
      SetLowELimit(index, p, 11 * eV);
      SetHighELimit(index, p, 1 * MeV);
    }
    LoadCrossSectionData(p);
    G4DNAMaterialManager::Instance()->SetMasterDataModel(DNAModelType::fDNAIonisation, this);
    fpModelData = this;
  }
  else {
    auto dataModel = dynamic_cast<G4DNACPA100IonisationModel*>(
      G4DNAMaterialManager::Instance()->GetModel(DNAModelType::fDNAIonisation));
    if (dataModel == nullptr) {
      G4cout << "G4DNACPA100IonisationModel::CrossSectionPerVolume:: not good modelData" << G4endl;
      throw;
    }
    fpModelData = dataModel;
  }
 
  fAtomDeexcitation = G4LossTableManager::Instance()->AtomDeexcitation();
 
  fParticleChangeForGamma = GetParticleChangeForGamma();
  isInitialised = true;
}

◆ operator=()

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

delete

◆ ReadDiffCSFile()

void G4DNACPA100IonisationModel::ReadDiffCSFile	(	const std::size_t &	materialID,
		const G4ParticleDefinition *	p,
		const G4String &	file,
		const G4double &	scaleFactor )

override

Definition at line 802 of file G4DNACPA100IonisationModel.cc.

{
  const char* path = G4FindDataDir("G4LEDATA");
  if (path == nullptr) {
    G4Exception("G4DNACPA100IonisationModel::ReadAllDiffCSFiles", "em0006", FatalException,
                "G4LEDATA environment variable was not set.");
    return;
  }
 
  std::ostringstream fullFileName;
  fullFileName << path << "/" << file << ".dat";
 
  std::ifstream diffCrossSection(fullFileName.str().c_str());
  std::stringstream endPath;
  if (!diffCrossSection) {
    endPath << "Missing data file: " << file;
    G4Exception("G4DNACPA100IonisationModel::Initialise", "em0003", FatalException,
                endPath.str().c_str());
  }
 
  // load data from the file
  fTMapWithVec[materialID][p].push_back(0.);
 
  G4String line;
 
  while (!diffCrossSection.eof()) {
    G4double T, E;
    diffCrossSection >> T >> E;
 
    if (T != fTMapWithVec[materialID][p].back()) {
      fTMapWithVec[materialID][p].push_back(T);
    }
 
    // T is incident energy, E is the energy transferred
    if (T != fTMapWithVec[materialID][p].back()) {
      fTMapWithVec[materialID][p].push_back(T);
    }
 
    auto eshell = (G4int)iStructure.NumberOfLevels(materialID);
    for (G4int shell = 0; shell < eshell; ++shell) {
      diffCrossSection >> diffCrossSectionData[materialID][p][shell][T][E];
      if (fasterCode) {
        fEnergySecondaryData[materialID][p][shell][T]
                            [diffCrossSectionData[materialID][p][shell][T][E]] = E;
 
        fProbaShellMap[materialID][p][shell][T].push_back(
          diffCrossSectionData[materialID][p][shell][T][E]);
      }
      else {
        diffCrossSectionData[materialID][p][shell][T][E] *= scaleFactor;
        fEMapWithVector[materialID][p][T].push_back(E);
      }
    }
  }
}

◆ SampleSecondaries()

void G4DNACPA100IonisationModel::SampleSecondaries	(	std::vector< G4DynamicParticle * > *	,
		const G4MaterialCutsCouple *	,
		const G4DynamicParticle *	,
		G4double	tmin,
		G4double	tmax )

overridevirtual

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.

Parameters

materialName

param particleChangeForGamma

Parameters

tmin

param tmax

Implements G4VDNAModel.

Definition at line 261 of file G4DNACPA100IonisationModel.cc.

{
  if (verboseLevel > 3) {
    G4cout << "Calling SampleSecondaries() of G4DNACPA100IonisationModel" << G4endl;
  }
  auto k = particle->GetKineticEnergy();
 
  const G4Material* material = couple->GetMaterial();
 
  auto MatID = material->GetIndex();
 
  auto p = particle->GetDefinition();
 
  auto lowLim = fpModelData->GetLowELimit(MatID, p);
  auto highLim = fpModelData->GetHighELimit(MatID, p);
 
  // Check if we are in the correct energy range
  if (k >= lowLim && k < highLim) {
    const auto& primaryDirection = particle->GetMomentumDirection();
    auto particleMass = particle->GetDefinition()->GetPDGMass();
    auto totalEnergy = k + particleMass;
    auto pSquare = k * (totalEnergy + particleMass);
    auto totalMomentum = std::sqrt(pSquare);
    G4int shell = -1;
    G4double bindingEnergy, secondaryKinetic;
    shell = fpModelData->RandomSelectShell(k, p, MatID);
    bindingEnergy = iStructure.IonisationEnergy(shell, MatID);
 
    if (k < bindingEnergy) {
      return;
    }
 
    auto info = std::make_tuple(MatID, k, shell);
 
    secondaryKinetic = -1000 * eV;
    if (fpG4_WATER->GetIndex() != MatID) {//for DNA material useDcs = false
      secondaryKinetic = fpModelData->RandomizeEjectedElectronEnergyFromanalytical(info);
    }else if(fasterCode){
        secondaryKinetic = fpModelData->RandomizeEjectedElectronEnergyFromCumulatedDcs(info);
      }else{
        secondaryKinetic = fpModelData->RandomizeEjectedElectronEnergy(info);
      }
 
    G4double cosTheta = 0.;
    G4double phi = 0.;
    RandomizeEjectedElectronDirection(particle->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);
 
    // SI - For atom. deexc. tagging - 23/05/2017
    if (secondaryKinetic > 0) {
      auto dp = new G4DynamicParticle(G4Electron::Electron(), deltaDirection, secondaryKinetic);
      fvect->push_back(dp);
    }
 
    if (particle->GetDefinition() != fpParticle) {
      fParticleChangeForGamma->ProposeMomentumDirection(primaryDirection);
    }
    else {
      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;
      direction.set(finalPx, finalPy, finalPz);
 
      fParticleChangeForGamma->ProposeMomentumDirection(direction.unit());
    }
 
    // SI - For atom. deexc. tagging - 23/05/2017
 
    // AM: sample deexcitation
    // here we assume that H_{2}O electronic levels are the same of Oxigen.
    // this can be considered true with a rough 10% error in energy on K-shell,
 
    G4double scatteredEnergy = k - bindingEnergy - secondaryKinetic;
 
    // SI: only atomic deexcitation from K shell is considered
    // Hoang: only for water
    if (fpG4_WATER != nullptr && material == G4Material::GetMaterial("G4_WATER")) {
      std::size_t secNumberInit = 0;  // need to know at a certain point the energy of secondaries
      std::size_t secNumberFinal = 0;  // So I'll make the diference and then sum the energies
      if ((fAtomDeexcitation != nullptr) && shell == 4) {
        G4int Z = 8;
        auto Kshell = fAtomDeexcitation->GetAtomicShell(Z, G4AtomicShellEnumerator(0));
        secNumberInit = fvect->size();
        fAtomDeexcitation->GenerateParticles(fvect, Kshell, Z, 0, 0);
        secNumberFinal = fvect->size();
        if (secNumberFinal > secNumberInit) {
          for (std::size_t i = secNumberInit; i < secNumberFinal; ++i) {
            // Check if there is enough residual energy
            if (bindingEnergy >= ((*fvect)[i])->GetKineticEnergy()) {
              // Ok, this is a valid secondary: keep it
              bindingEnergy -= ((*fvect)[i])->GetKineticEnergy();
            }
            else {
              // Invalid secondary: not enough energy to create it!
              // Keep its energy in the local deposit
              delete (*fvect)[i];
              (*fvect)[i] = nullptr;
            }
          }
        }
      }
    }
 
    // This should never happen
    if (bindingEnergy < 0.0) {
      G4Exception("G4DNACPA100IonisatioModel1::SampleSecondaries()", "em2050", FatalException,
                  "Negative local energy deposit");
    }
    if (!statCode) {
      fParticleChangeForGamma->SetProposedKineticEnergy(scatteredEnergy);
      fParticleChangeForGamma->ProposeLocalEnergyDeposit(bindingEnergy);
    }
    else {
      fParticleChangeForGamma->SetProposedKineticEnergy(k);
      fParticleChangeForGamma->ProposeLocalEnergyDeposit(k - scatteredEnergy);
    }
 
    // only water for chemistry
    if (fpG4_WATER != nullptr && material == G4Material::GetMaterial("G4_WATER")) {
      const G4Track* theIncomingTrack = fParticleChangeForGamma->GetCurrentTrack();
      G4DNAChemistryManager::Instance()->CreateWaterMolecule(eIonizedMolecule, shell,
                                                             theIncomingTrack);
    }
  }
}

◆ SelectFasterComputation()

void G4DNACPA100IonisationModel::SelectFasterComputation ( G4bool input )

inline

Definition at line 159 of file G4DNACPA100IonisationModel.hh.

{
  fasterCode = input;
}

◆ SelectStationary()

void G4DNACPA100IonisationModel::SelectStationary ( G4bool input )

inline

Definition at line 175 of file G4DNACPA100IonisationModel.hh.

{
  statCode = input;
}

◆ SelectUseDcs()

void G4DNACPA100IonisationModel::SelectUseDcs ( G4bool input )

inline

Definition at line 166 of file G4DNACPA100IonisationModel.hh.

{
  useDcs = input;
}

Member Data Documentation

◆ fParticleChangeForGamma

G4ParticleChangeForGamma* G4DNACPA100IonisationModel::fParticleChangeForGamma = nullptr

protected

Definition at line 104 of file G4DNACPA100IonisationModel.hh.

Referenced by Initialise(), and SampleSecondaries().

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ G4DNACPA100IonisationModel() [1/2]

◆ ~G4DNACPA100IonisationModel()

◆ G4DNACPA100IonisationModel() [2/2]

Member Function Documentation

◆ CrossSectionPerVolume()

◆ DifferentialCrossSection()

◆ Initialise()

◆ operator=()

◆ ReadDiffCSFile()

◆ SampleSecondaries()

◆ SelectFasterComputation()

◆ SelectStationary()

◆ SelectUseDcs()

Member Data Documentation

◆ fParticleChangeForGamma