#include <G4VDNAModel.hh>

Inheritance diagram for G4VDNAModel:

Public Member Functions
	G4VDNAModel (const G4String &nam, const G4String &applyToMaterial="")
	G4VDNAModel Constructeur of the G4VDNAModel class.

	~G4VDNAModel () override
	~G4VDNAModel

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

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

void	SampleSecondaries (std::vector< G4DynamicParticle * > , const G4MaterialCutsCouple , const G4DynamicParticle *, G4double tmin=0, G4double tmax=DBL_MAX) override=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 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 Types
using	MaterialParticleMapData

Protected Member Functions
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
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 G4VDNAModel class.

All the models using the DNA material management should inherit from that class. The goal is to allow the use of the material management system with little code interferences within the model classes.

Definition at line 50 of file G4VDNAModel.hh.

Member Typedef Documentation

◆ MaterialParticleMapData

using G4VDNAModel::MaterialParticleMapData

protected

Initial value:

std::map<size_t ,

std::map<const G4ParticleDefinition*, std::unique_ptr<G4DNACrossSectionDataSet>>>

Definition at line 173 of file G4VDNAModel.hh.

Constructor & Destructor Documentation

◆ G4VDNAModel()

G4VDNAModel::G4VDNAModel	(	const G4String &	nam,
		const G4String &	applyToMaterial = "" )

G4VDNAModel Constructeur of the G4VDNAModel class.

Parameters

nam
applyToMaterial

Definition at line 36 of file G4VDNAModel.cc.

37 : G4VEmModel(nam), fStringOfMaterials(applyToMaterial)

38{}

G4VEmModel::G4VEmModel

G4VEmModel(const G4String &nam)

Definition G4VEmModel.cc:67

◆ ~G4VDNAModel()

G4VDNAModel::~G4VDNAModel ( )

overridedefault

~G4VDNAModel

Member Function Documentation

◆ AddCrossSectionData() [1/2]

void G4VDNAModel::AddCrossSectionData	(	const size_t &	materialName,
		const G4ParticleDefinition *	particleName,
		const G4String &	fileCS,
		const G4double &	scaleFactor )

protected

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.

Parameters

materialName

param particleName

Parameters

fileCS

param scaleFactor

◆ AddCrossSectionData() [2/2]

void G4VDNAModel::AddCrossSectionData	(	const size_t &	materialName,
		const G4ParticleDefinition *	particleName,
		const G4String &	fileCS,
		const G4String &	fileDiffCS,
		const G4double &	scaleFactor )

protected

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.

Parameters

materialName

param particleName

Parameters

fileCS

param fileDiffCS

Parameters

scaleFactor

Referenced by G4DNACPA100ElasticModel::Initialise(), G4DNACPA100ExcitationModel::Initialise(), G4DNACPA100IonisationModel::Initialise(), G4DNAPTBElasticModel::Initialise(), G4DNAPTBExcitationModel::Initialise(), and G4DNAPTBIonisationModel::Initialise().

◆ BuildApplyToMatVect()

std::vector< G4String > G4VDNAModel::BuildApplyToMatVect ( const G4String & materials )

protected

BuildApplyToMatVect Build the material name vector which is used to know the materials the user want to include in the model.

Parameters

materials

Returns: a vector with all the material names

Definition at line 138 of file G4VDNAModel.cc.

{
  // output material vector
  std::vector<G4String> materialVect;
 
  // if we don't find any "/" then it means we only have one "material" (could be the "all" option)
  if (materials.find('/') == std::string::npos) {
    // we add the material to the output vector
    materialVect.push_back(materials);
  }
  // if we have several materials listed in the string then we must retrieve them
  else {
    G4String materialsNonIdentified = materials;
 
    while (materialsNonIdentified.find_first_of('/') != std::string::npos) {
      // we select the first material and stop at the "/" caracter
      G4String mat = materialsNonIdentified.substr(0, materialsNonIdentified.find_first_of('/'));
      materialVect.push_back(mat);
 
      // we remove the previous material from the materialsNonIdentified string
      materialsNonIdentified = materialsNonIdentified.substr(
        materialsNonIdentified.find_first_of('/') + 1,
        materialsNonIdentified.size() - materialsNonIdentified.find_first_of('/'));
    }
 
    // we don't find "/" anymore, it means we only have one material string left
    // we get it
    materialVect.push_back(materialsNonIdentified);
  }
 
  return materialVect;
}

Referenced by LoadCrossSectionData().

◆ CrossSectionPerVolume()

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

overridepure virtual

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

Reimplemented from G4VEmModel.

Implemented in G4DNACPA100ElasticModel, G4DNACPA100ExcitationModel, G4DNACPA100IonisationModel, G4DNAPTBElasticModel, G4DNAPTBExcitationModel, G4DNAPTBIonisationModel, and G4DNAVacuumModel.

◆ EnableForMaterialAndParticle()

void G4VDNAModel::EnableForMaterialAndParticle	(	const size_t &	materialID,
		const G4ParticleDefinition *	p )

protected

EnableMaterialAndParticle.

Parameters

materialName
particleName	Meant to fill fTableData with 0 for the specified material and particle, therefore allowing the ModelInterface class to proceed with the material and particle even if no data are registered here. The data should obviously be registered somewhere in the child class. This method is here to allow an easy use of the no-ModelInterface dna models within the ModelInterface system.

Definition at line 132 of file G4VDNAModel.cc.

{
  fData[materialID][p] = nullptr;
}

Referenced by G4DNAVacuumModel::Initialise().

◆ GetData()

MaterialParticleMapData * G4VDNAModel::GetData ( )

inlineprotected

GetTableData.

Returns: a pointer to a map with the following structure: [materialName][particleName]=G4DNACrossSectionDataSet*

Definition at line 183 of file G4VDNAModel.hh.

  {
    return &fData;
  }

Referenced by G4DNACPA100ElasticModel::CrossSectionPerVolume(), G4DNACPA100ExcitationModel::CrossSectionPerVolume(), G4DNACPA100IonisationModel::CrossSectionPerVolume(), G4DNAPTBElasticModel::CrossSectionPerVolume(), G4DNAPTBExcitationModel::CrossSectionPerVolume(), and G4DNAPTBIonisationModel::CrossSectionPerVolume().

◆ GetHighELimit()

G4double G4VDNAModel::GetHighELimit	(	const size_t &	materialID,
		const G4ParticleDefinition *	particle )

inline

GetHighEnergyLimit.

Parameters

material
particle

Returns: fHighEnergyLimits[material][particle]

Definition at line 130 of file G4VDNAModel.hh.

  {
    return fHighEnergyLimits[materialID][particle];
  }

Referenced by G4DNACPA100ElasticModel::CrossSectionPerVolume(), G4DNACPA100ExcitationModel::CrossSectionPerVolume(), G4DNACPA100IonisationModel::CrossSectionPerVolume(), G4DNAPTBElasticModel::CrossSectionPerVolume(), G4DNAPTBExcitationModel::CrossSectionPerVolume(), G4DNAPTBIonisationModel::CrossSectionPerVolume(), G4DNACPA100ExcitationModel::SampleSecondaries(), G4DNACPA100IonisationModel::SampleSecondaries(), G4DNAPTBElasticModel::SampleSecondaries(), G4DNAPTBExcitationModel::SampleSecondaries(), and G4DNAPTBIonisationModel::SampleSecondaries().

◆ GetLowELimit()

G4double G4VDNAModel::GetLowELimit	(	const size_t &	materialID,
		const G4ParticleDefinition *	particle )

inline

GetLowEnergyLimit.

Parameters

material
particle

Returns: fLowEnergyLimits[material][particle]

Definition at line 141 of file G4VDNAModel.hh.

  {
    return fLowEnergyLimits[materialID][particle];
  }

Referenced by G4DNACPA100ElasticModel::CrossSectionPerVolume(), G4DNACPA100ExcitationModel::CrossSectionPerVolume(), G4DNACPA100IonisationModel::CrossSectionPerVolume(), G4DNAPTBElasticModel::CrossSectionPerVolume(), G4DNAPTBExcitationModel::CrossSectionPerVolume(), G4DNAPTBIonisationModel::CrossSectionPerVolume(), G4DNACPA100ExcitationModel::SampleSecondaries(), G4DNACPA100IonisationModel::SampleSecondaries(), G4DNAPTBElasticModel::SampleSecondaries(), G4DNAPTBExcitationModel::SampleSecondaries(), and G4DNAPTBIonisationModel::SampleSecondaries().

◆ GetName()

G4String G4VDNAModel::GetName ( )

inline

GetName.

Returns: the name of the model

Definition at line 119 of file G4VDNAModel.hh.

  {
    return fName;
  }

Referenced by G4DNACPA100ElasticModel::CrossSectionPerVolume(), G4DNACPA100ExcitationModel::CrossSectionPerVolume(), G4DNACPA100IonisationModel::CrossSectionPerVolume(), RandomSelectShell(), and G4DNACPA100ExcitationModel::SampleSecondaries().

◆ Initialise()

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

overridepure virtual

Initialise Each model must implement an Initialize method.

Parameters

particle
cuts

Implements G4VEmModel.

Implemented in G4DNACPA100ElasticModel, G4DNACPA100ExcitationModel, G4DNACPA100IonisationModel, G4DNAPTBElasticModel, G4DNAPTBExcitationModel, G4DNAPTBIonisationModel, and G4DNAVacuumModel.

◆ IsMaterialDefine()

G4bool G4VDNAModel::IsMaterialDefine ( const size_t & materialID )

IsMaterialDefine Check if the given material is defined in the simulation.

Parameters

materialName

Returns: true if the material is defined in the simulation

Definition at line 228 of file G4VDNAModel.cc.

{
  // Check if the given material is defined in the simulation
 
  G4bool exist(false);
 
  G4double matTableSize = G4Material::GetMaterialTable()->size();
 
  for (int i = 0; i < matTableSize; i++) {
    if (materialID == G4Material::GetMaterialTable()->at(i)->GetIndex()) {
      exist = true;
      return exist;
    }
  }
 
  G4Exception("G4VDNAModel::IsMaterialDefine", "em0003", FatalException,
              "Materials are not defined!!");
  return exist;
}

◆ IsParticleExistingInModelForMaterial()

G4bool G4VDNAModel::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 ?

Parameters

particleName
materialName

Returns: true if the particle/material couple is defined in the model

Definition at line 260 of file G4VDNAModel.cc.

{
  // To check two things:
  // 1- is the material existing in model ?
  // 2- if yes, is the particle defined for that material ?
 
  if (IsMaterialExistingInModel(materialID)) {
    for (const auto& it : fModelParticles) {
      if (it == particleName) {
        return true;
      }
    }
  }
  return false;
}

◆ LoadCrossSectionData()

void G4VDNAModel::LoadCrossSectionData ( const G4ParticleDefinition * particleName )

protected

LoadCrossSectionData Method to loop on all the registered materials in the model and load the corresponding data.

Definition at line 64 of file G4VDNAModel.cc.

{
  G4String fileElectron, fileDiffElectron = "";
  G4String materialName, modelParticleName;
  G4double scaleFactor;
  std::size_t materialID;
 
  const G4ParticleDefinition* pParticle;
 
  // construct applyToMatVect with materials specified by the user
  std::vector<G4String> applyToMatVect = BuildApplyToMatVect(fStringOfMaterials);
 
  // iterate on each material contained into the fStringOfMaterials variable (through
  // applyToMatVect)
  for (const auto & i : applyToMatVect) {
    auto pMat = G4Material::GetMaterial(i, false);
    if (i != "all" && pMat == nullptr) {
      continue;
    }
 
    // We have selected a material coming from applyToMatVect
    // We try to find if this material correspond to a model registered material
    // If it is, then isMatFound becomes true
    G4bool isMatFound = false;
 
    // We iterate on each model registered materials to load the CS data
    // We have to do a for loop because of the "all" option
    // applyToMatVect[i] == "all" implies applyToMatVect.size()=1 and we want to iterate on all
    // registered materials
    for (std::size_t j = 0; j < fModelMaterials.size(); ++j) {
      if (i == "all" || pMat->GetIndex() == fModelMaterials[j]) {
        isMatFound = true;
        materialID = fModelMaterials[j];
        pParticle = fModelParticles[j];
        fileElectron = fModelCSFiles[j];
        if (!fModelDiffCSFiles.empty()) fileDiffElectron = fModelDiffCSFiles[j];
        scaleFactor = fModelScaleFactors[j];
 
        ReadAndSaveCSFile(materialID, pParticle, fileElectron, scaleFactor);
 
        if (!fileDiffElectron.empty())
          ReadDiffCSFile(materialID, pParticle, fileDiffElectron, scaleFactor);
      }
    }
 
    // check if we found a correspondance, if not: fatal error
    if (!isMatFound) {
      std::ostringstream oss;
      oss << i
          << " material was not found. It means the material specified in the UserPhysicsList is "
             "not a model material for ";
      oss << particleName;
      G4Exception("G4VDNAModel::LoadCrossSectionData", "em0003", FatalException, oss.str().c_str());
      return;
    }
  }
}

Referenced by G4DNACPA100ElasticModel::Initialise(), G4DNACPA100ExcitationModel::Initialise(), G4DNACPA100IonisationModel::Initialise(), G4DNAPTBElasticModel::Initialise(), G4DNAPTBExcitationModel::Initialise(), and G4DNAPTBIonisationModel::Initialise().

◆ RandomSelectShell()

G4int G4VDNAModel::RandomSelectShell	(	const G4double &	k,
		const G4ParticleDefinition *	particle,
		const size_t &	materialName )

protected

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.

Parameters

k

param particle

Parameters

materialName

Returns: the selected shell

Definition at line 179 of file G4VDNAModel.cc.

{
  G4int level = 0;
 
  auto pos = fData[materialID].find(particle);
 
  if (pos != fData[materialID].end()) {
    G4DNACrossSectionDataSet* table = pos->second.get();
 
    if (table != nullptr) {
      auto valuesBuffer = new G4double[table->NumberOfComponents()];
      auto n = (G4int)table->NumberOfComponents();
      G4int i(n);
      G4double value = 0.;
 
      while (i > 0) {
        --i;
        valuesBuffer[i] = table->GetComponent(i)->FindValue(k);
        value += valuesBuffer[i];
      }
 
      value *= G4UniformRand();
 
      i = n;
 
      while (i > 0) {
        --i;
 
        if (valuesBuffer[i] > value) {
          delete[] valuesBuffer;
          return i;
        }
        value -= valuesBuffer[i];
      }
 
      delete[] valuesBuffer;
    }
  }
  else {
    G4cout << "particle : " << particle->GetParticleName()
           << " Materials : " << (*G4Material::GetMaterialTable())[materialID]->GetName() << "  "
           << this->GetName() << G4endl;
    G4Exception("G4VDNAModel::RandomSelectShell", "em0002", FatalException,
                "Model not applicable to particle type : ");
  }
  return level;
}

Referenced by G4DNACPA100ExcitationModel::SampleSecondaries(), G4DNACPA100IonisationModel::SampleSecondaries(), G4DNAPTBExcitationModel::SampleSecondaries(), and G4DNAPTBIonisationModel::SampleSecondaries().

◆ ReadAndSaveCSFile()

void G4VDNAModel::ReadAndSaveCSFile	(	const size_t &	materialID,
		const G4ParticleDefinition *	p,
		const G4String &	file,
		const G4double &	scaleFactor )

protected

ReadAndSaveCSFile Read and save a "simple" cross section file : use of G4DNACrossSectionDataSet->loadData()

Parameters

materialName
particleName
file
scaleFactor

Definition at line 171 of file G4VDNAModel.cc.

{
  fData[materialID][p] =
    std::make_unique<G4DNACrossSectionDataSet>(new G4LogLogInterpolation, eV, scaleFactor);
  fData[materialID][p]->LoadData(file);
}

Referenced by LoadCrossSectionData().

◆ ReadDiffCSFile()

void G4VDNAModel::ReadDiffCSFile	(	const size_t &	materialName,
		const G4ParticleDefinition *	particleName,
		const G4String &	path,
		const G4double &	scaleFactor )

protectedvirtual

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.

Parameters

materialName
particleName
path
scaleFactor

Definition at line 122 of file G4VDNAModel.cc.

{
  G4String text(
    "ReadDiffCSFile must be implemented in the model class using a differential cross section data "
    "file");
 
  G4Exception("G4VDNAModel::ReadDiffCSFile", "em0003", FatalException, text);
}

Referenced by LoadCrossSectionData().

◆ SampleSecondaries()

void G4VDNAModel::SampleSecondaries	(	std::vector< G4DynamicParticle * > *	,
		const G4MaterialCutsCouple *	,
		const G4DynamicParticle *	,
		G4double	tmin = 0,
		G4double	tmax = DBL_MAX )

overridepure virtual

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 G4VEmModel.

Implemented in G4DNACPA100ElasticModel, G4DNACPA100ExcitationModel, G4DNACPA100IonisationModel, G4DNAPTBElasticModel, G4DNAPTBExcitationModel, G4DNAPTBIonisationModel, and G4DNAVacuumModel.

◆ SetHighELimit()

void G4VDNAModel::SetHighELimit	(	const size_t &	materialID,
		const G4ParticleDefinition *	particle,
		G4double	lim )

inline

SetHighEnergyLimit.

Parameters

material
particle
lim

Definition at line 152 of file G4VDNAModel.hh.

  {
    fHighEnergyLimits[materialID][particle] = lim;
  }

Referenced by G4DNACPA100ElasticModel::Initialise(), G4DNACPA100ExcitationModel::Initialise(), G4DNACPA100IonisationModel::Initialise(), G4DNAPTBElasticModel::Initialise(), G4DNAPTBExcitationModel::Initialise(), and G4DNAPTBIonisationModel::Initialise().

◆ SetLowELimit()

void G4VDNAModel::SetLowELimit	(	const size_t &	materialID,
		const G4ParticleDefinition *	particle,
		G4double	lim )

inline

SetLowEnergyLimit.

Parameters

material
particle
lim

Definition at line 163 of file G4VDNAModel.hh.

  {
    fLowEnergyLimits[materialID][particle] = lim;
  }

Referenced by G4DNACPA100ElasticModel::Initialise(), G4DNACPA100ExcitationModel::Initialise(), G4DNACPA100IonisationModel::Initialise(), G4DNAPTBElasticModel::Initialise(), G4DNAPTBExcitationModel::Initialise(), and G4DNAPTBIonisationModel::Initialise().

Member Data Documentation

◆ isInitialised

G4bool G4VDNAModel::isInitialised = false

protected

Definition at line 169 of file G4VDNAModel.hh.

Referenced by G4DNAPTBElasticModel::Initialise(), G4DNAPTBExcitationModel::Initialise(), and G4DNAPTBIonisationModel::Initialise().

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ MaterialParticleMapData

Constructor & Destructor Documentation

◆ G4VDNAModel()

◆ ~G4VDNAModel()

Member Function Documentation

◆ AddCrossSectionData() [1/2]

◆ AddCrossSectionData() [2/2]

◆ BuildApplyToMatVect()

◆ CrossSectionPerVolume()

◆ EnableForMaterialAndParticle()

◆ GetData()

◆ GetHighELimit()

◆ GetLowELimit()

◆ GetName()

◆ Initialise()

◆ IsMaterialDefine()

◆ IsParticleExistingInModelForMaterial()

◆ LoadCrossSectionData()

◆ RandomSelectShell()

◆ ReadAndSaveCSFile()

◆ ReadDiffCSFile()

◆ SampleSecondaries()

◆ SetHighELimit()

◆ SetLowELimit()

Member Data Documentation

◆ isInitialised