#include <G4VDNAModel.hh>

Inheritance diagram for G4VDNAModel:

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

virtual	~G4VDNAModel ()
	~G4VDNAModel

virtual void	Initialise (const G4ParticleDefinition particle, const G4DataVector &cuts, G4ParticleChangeForGamma fpChangeForGamme=nullptr)=0
	Initialise Each model must implement an Initialize method.

virtual G4double	CrossSectionPerVolume (const G4Material material, const G4String &materialName, const G4ParticleDefinition p, G4double ekin, G4double emin, G4double emax)=0
	CrossSectionPerVolume Every model must implement its own CrossSectionPerVolume method. It is used by the process to determine the step path and must return a cross section times a number of molecules per volume unit.

virtual void	SampleSecondaries (std::vector< G4DynamicParticle * > , const G4MaterialCutsCouple , const G4String &materialName, const G4DynamicParticle , G4ParticleChangeForGamma particleChangeForGamma, G4double tmin=0, G4double tmax=DBL_MAX)=0
	SampleSecondaries Each model must implement SampleSecondaries to decide if a particle will be created after the ModelInterface or if any charateristic of the incident particle will change.

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

G4bool	IsMaterialExistingInModel (const G4String &materialName)
	IsMaterialExistingInModel Check if the given material is defined in the current model class.

G4bool	IsParticleExistingInModelForMaterial (const G4String &particleName, const G4String &materialName)
	IsParticleExistingInModelForMaterial To check two things: 1- is the material existing in model ? 2- if yes, is the particle defined for that material ?

G4String	GetName ()
	GetName.

G4double	GetHighELimit (const G4String &material, const G4String &particle)
	GetHighEnergyLimit.

G4double	GetLowELimit (const G4String &material, const G4String &particle)
	GetLowEnergyLimit.

void	SetHighELimit (const G4String &material, const G4String &particle, G4double lim)
	SetHighEnergyLimit.

void	SetLowELimit (const G4String &material, const G4String &particle, G4double lim)
	SetLowEnergyLimit.

Protected Types
typedef std::map< G4String, std::map< G4String, G4DNACrossSectionDataSet *, std::less< G4String > > >	TableMapData

typedef std::map< G4String, std::map< G4String, G4double > >	RatioMapData

typedef std::map< G4String, G4double >::const_iterator	ItCompoMapData

Protected Member Functions
TableMapData *	GetTableData ()
	GetTableData.

std::vector< G4String >	BuildApplyToMatVect (const G4String &materials)
	BuildApplyToMatVect Build the material name vector which is used to know the materials the user want to include in the model.

void	ReadAndSaveCSFile (const G4String &materialName, const G4String &particleName, const G4String &file, G4double scaleFactor)
	ReadAndSaveCSFile Read and save a "simple" cross section file : use of G4DNACrossSectionDataSet->loadData()

G4int	RandomSelectShell (G4double k, const G4String &particle, const G4String &materialName)
	RandomSelectShell Method to randomely select a shell from the data table uploaded. The size of the table (number of columns) is used to determine the total number of possible shells.

void	AddCrossSectionData (G4String materialName, G4String particleName, G4String fileCS, G4String fileDiffCS, G4double scaleFactor)
	AddCrossSectionData Method used during the initialization of the model class to add a new material. It adds a material to the model and fills vectors with informations.

void	AddCrossSectionData (G4String materialName, G4String particleName, G4String fileCS, G4double scaleFactor)
	AddCrossSectionData Method used during the initialization of the model class to add a new material. It adds a material to the model and fills vectors with informations. Not every model needs differential cross sections.

void	LoadCrossSectionData (const G4String &particleName)
	LoadCrossSectionData Method to loop on all the registered materials in the model and load the corresponding data.

virtual void	ReadDiffCSFile (const G4String &materialName, const G4String &particleName, const G4String &path, const G4double scaleFactor)
	ReadDiffCSFile Virtual method that need to be implemented if one wish to use the differential cross sections. The read method for that kind of information is not standardized yet.

void	EnableForMaterialAndParticle (const G4String &materialName, const G4String &particleName)
	EnableMaterialAndParticle.

Detailed Description

The 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 49 of file G4VDNAModel.hh.

Member Typedef Documentation

◆ ItCompoMapData

typedef std::map<G4String,G4double>::const_iterator G4VDNAModel::ItCompoMapData

protected

Definition at line 185 of file G4VDNAModel.hh.

◆ RatioMapData

typedef std::map<G4String,std::map<G4String, G4double> > G4VDNAModel::RatioMapData

protected

Definition at line 184 of file G4VDNAModel.hh.

◆ TableMapData

typedef std::map<G4String, std::map<G4String,G4DNACrossSectionDataSet*,std::less<G4String> > > G4VDNAModel::TableMapData

protected

Definition at line 183 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 35 of file G4VDNAModel.cc.

    : fStringOfMaterials(applyToMaterial), fName(nam)
{
 
}

◆ ~G4VDNAModel()

G4VDNAModel::~G4VDNAModel ( )

virtual

~G4VDNAModel

Definition at line 41 of file G4VDNAModel.cc.

{
    // Clean fTableData
    std::map<G4String, std::map<G4String,G4DNACrossSectionDataSet*,std::less<G4String> > >::iterator posOuter;
    std::map<G4String,G4DNACrossSectionDataSet*,std::less<G4String> >::iterator posInner;
    // iterate on each material
    for (posOuter = fTableData.begin(); posOuter != fTableData.end(); ++posOuter)
    {
        // iterate on each particle
        for(posInner = posOuter->second.begin(); posInner != posOuter->second.end(); ++posInner)
        {
            G4DNACrossSectionDataSet* table = posInner->second;
            if(table != 0) delete table;
        }
    }
}

Member Function Documentation

◆ AddCrossSectionData() [1/2]

void G4VDNAModel::AddCrossSectionData	(	G4String	materialName,
		G4String	particleName,
		G4String	fileCS,
		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
particleName
fileCS
scaleFactor

Definition at line 67 of file G4VDNAModel.cc.

{
    fModelMaterials.push_back(materialName);
    fModelParticles.push_back(particleName);
    fModelCSFiles.push_back(fileCS);
    fModelScaleFactors.push_back(scaleFactor);
}

◆ AddCrossSectionData() [2/2]

void G4VDNAModel::AddCrossSectionData	(	G4String	materialName,
		G4String	particleName,
		G4String	fileCS,
		G4String	fileDiffCS,
		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
particleName
fileCS
fileDiffCS
scaleFactor

Definition at line 58 of file G4VDNAModel.cc.

{
    fModelMaterials.push_back(materialName);
    fModelParticles.push_back(particleName);
    fModelCSFiles.push_back(fileCS);
    fModelDiffCSFiles.push_back(fileDiffCS);
    fModelScaleFactors.push_back(scaleFactor);
}

Referenced by 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 139 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()

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

pure 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
materialName
p
ekin
emin
emax

Returns: crossSection*numberOfMoleculesPerVolumeUnit

Implemented in G4DNADummyModel, G4DNAPTBElasticModel, G4DNAPTBExcitationModel, G4DNAPTBIonisationModel, and G4DNAVacuumModel.

Referenced by G4DNAModelInterface::CrossSectionPerVolume().

◆ EnableForMaterialAndParticle()

void G4VDNAModel::EnableForMaterialAndParticle	(	const G4String &	materialName,
		const G4String &	particleName
	)

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 134 of file G4VDNAModel.cc.

{
    fTableData[materialName][particleName] = 0;
}

Referenced by G4DNAVacuumModel::Initialise(), and G4DNADummyModel::Initialise().

◆ GetHighELimit()

G4double G4VDNAModel::GetHighELimit	(	const G4String &	material,
		const G4String &	particle
	)

inline

GetHighEnergyLimit.

Parameters

material
particle

Returns: fHighEnergyLimits[material][particle]

Definition at line 153 of file G4VDNAModel.hh.

153{return fHighEnergyLimits[material][particle];}

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

◆ GetLowELimit()

G4double G4VDNAModel::GetLowELimit	(	const G4String &	material,
		const G4String &	particle
	)

inline

GetLowEnergyLimit.

Parameters

material
particle

Returns: fLowEnergyLimits[material][particle]

Definition at line 161 of file G4VDNAModel.hh.

161{return fLowEnergyLimits[material][particle];}

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

◆ GetName()

G4String G4VDNAModel::GetName ( )

inline

GetName.

Returns: the name of the model

Definition at line 145 of file G4VDNAModel.hh.

145{return fName;}

Referenced by IsMaterialDefine().

◆ GetTableData()

TableMapData * G4VDNAModel::GetTableData ( )

inlineprotected

GetTableData.

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

Definition at line 193 of file G4VDNAModel.hh.

193{return &fTableData;}

Referenced by G4DNAPTBElasticModel::CrossSectionPerVolume(), G4DNAPTBExcitationModel::CrossSectionPerVolume(), G4DNAPTBIonisationModel::CrossSectionPerVolume(), and RandomSelectShell().

◆ Initialise()

virtual void G4VDNAModel::Initialise	(	const G4ParticleDefinition *	particle,
		const G4DataVector &	cuts,
		G4ParticleChangeForGamma *	fpChangeForGamme = `nullptr`
	)

pure virtual

Initialise Each model must implement an Initialize method.

Parameters

particle
cuts

Implemented in G4DNAVacuumModel, G4DNAPTBElasticModel, G4DNADummyModel, G4DNAPTBExcitationModel, and G4DNAPTBIonisationModel.

◆ IsMaterialDefine()

G4bool G4VDNAModel::IsMaterialDefine ( const G4String & materialName )

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 237 of file G4VDNAModel.cc.

{
    // Check if the given material is defined in the simulation
 
    G4bool exist (false);
 
    double matTableSize = G4Material::GetMaterialTable()->size();
 
    for(int i=0;i<matTableSize;i++)
    {
        if(materialName == G4Material::GetMaterialTable()->at(i)->GetName())
        {
            exist = true;
            return exist;
        }
    }
 
    return exist;
}

◆ IsMaterialExistingInModel()

G4bool G4VDNAModel::IsMaterialExistingInModel ( const G4String & materialName )

IsMaterialExistingInModel Check if the given material is defined in the current model class.

Parameters

materialName

Returns: true if the material is defined in the model

Definition at line 257 of file G4VDNAModel.cc.

{
    // Check if the given material is defined in the current model class
 
    if (fTableData.find(materialName) == fTableData.end())
    {
        return false;
    }
    else
    {
        return true;
    }
}

Referenced by IsParticleExistingInModelForMaterial().

◆ IsParticleExistingInModelForMaterial()

G4bool G4VDNAModel::IsParticleExistingInModelForMaterial	(	const G4String &	particleName,
		const G4String &	materialName
	)

IsParticleExistingInModelForMaterial To check two things: 1- is the material existing in model ? 2- if yes, is the particle defined for that material ?

Parameters

particleName
materialName

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

Definition at line 271 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(materialName))
    {
        if (fTableData[materialName].find(particleName) == fTableData[materialName].end())
        {
            return false;
        }
        else return true;
    }
    else return false;
}

◆ LoadCrossSectionData()

void G4VDNAModel::LoadCrossSectionData ( const G4String & particleName )

protected

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

Definition at line 75 of file G4VDNAModel.cc.

{
    G4String fileElectron, fileDiffElectron;
    G4String materialName, modelParticleName;
    G4double scaleFactor;
 
    // 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(unsigned int i=0;i<applyToMatVect.size();++i)
    {
        // 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(unsigned int j=0;j<fModelMaterials.size();++j)
        {
            if(applyToMatVect[i] == fModelMaterials[j] || applyToMatVect[i] == "all")
            {
                isMatFound = true;
                materialName = fModelMaterials[j];
                modelParticleName = fModelParticles[j];
                fileElectron = fModelCSFiles[j];
                if(!fModelDiffCSFiles.empty()) fileDiffElectron = fModelDiffCSFiles[j];
                scaleFactor = fModelScaleFactors[j];
 
                ReadAndSaveCSFile(materialName, modelParticleName, fileElectron, scaleFactor);
 
                if(!fModelDiffCSFiles.empty()) ReadDiffCSFile(materialName, modelParticleName, fileDiffElectron, scaleFactor);
 
            }
        }
 
        // check if we found a correspondance, if not: fatal error
        if(!isMatFound)
        {
            std::ostringstream oss;
            oss << applyToMatVect[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 G4DNAPTBElasticModel::Initialise(), G4DNAPTBExcitationModel::Initialise(), and G4DNAPTBIonisationModel::Initialise().

◆ RandomSelectShell()

G4int G4VDNAModel::RandomSelectShell	(	G4double	k,
		const G4String &	particle,
		const G4String &	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
particle
materialName

Returns: the selected shell

Definition at line 182 of file G4VDNAModel.cc.

{
    G4int level = 0;
 
    TableMapData* tableData = GetTableData();
 
    std::map< G4String,G4DNACrossSectionDataSet*,std::less<G4String> >::iterator pos;
    pos = (*tableData)[materialName].find(particle);
 
    if (pos != (*tableData)[materialName].end())
    {
        G4DNACrossSectionDataSet* table = pos->second;
 
        if (table != 0)
        {
            G4double* valuesBuffer = new G4double[table->NumberOfComponents()];
            const size_t n(table->NumberOfComponents());
            size_t 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];
            }
 
            if (valuesBuffer) delete[] valuesBuffer;
 
        }
    }
    else
    {
        G4Exception("G4VDNAModel::RandomSelectShell","em0002",
                    FatalException,"Model not applicable to particle type.");
    }
    return level;
}

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

◆ ReadAndSaveCSFile()

void G4VDNAModel::ReadAndSaveCSFile	(	const G4String &	materialName,
		const G4String &	particleName,
		const G4String &	file,
		G4double	scaleFactor
	)

protected

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

Parameters

materialName
particleName
file
scaleFactor

Definition at line 174 of file G4VDNAModel.cc.

{
    fTableData[materialName][particleName] = new G4DNACrossSectionDataSet(new G4LogLogInterpolation, eV, scaleFactor);
    fTableData[materialName][particleName]->LoadData(file);
}

Referenced by LoadCrossSectionData().

◆ ReadDiffCSFile()

void G4VDNAModel::ReadDiffCSFile	(	const G4String &	materialName,
		const G4String &	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 126 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()

virtual void G4VDNAModel::SampleSecondaries	(	std::vector< G4DynamicParticle * > *	,
		const G4MaterialCutsCouple *	,
		const G4String &	materialName,
		const G4DynamicParticle *	,
		G4ParticleChangeForGamma *	particleChangeForGamma,
		G4double	tmin = `0`,
		G4double	tmax = `DBL_MAX`
	)

pure 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
particleChangeForGamma
tmin
tmax

Implemented in G4DNADummyModel, G4DNAPTBElasticModel, G4DNAPTBExcitationModel, G4DNAPTBIonisationModel, and G4DNAVacuumModel.

Referenced by G4DNAModelInterface::SampleSecondaries().

◆ SetHighELimit()

void G4VDNAModel::SetHighELimit	(	const G4String &	material,
		const G4String &	particle,
		G4double	lim
	)

inline

SetHighEnergyLimit.

Parameters

material
particle
lim

Definition at line 169 of file G4VDNAModel.hh.

169{fHighEnergyLimits[material][particle]=lim;}

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

◆ SetLowELimit()

void G4VDNAModel::SetLowELimit	(	const G4String &	material,
		const G4String &	particle,
		G4double	lim
	)

inline

SetLowEnergyLimit.

Parameters

material
particle
lim

Definition at line 177 of file G4VDNAModel.hh.

177{fLowEnergyLimits[material][particle]=lim;}

Referenced by G4DNAPTBElasticModel::Initialise(), G4DNADummyModel::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

Detailed Description

Member Typedef Documentation

◆ ItCompoMapData

◆ RatioMapData

◆ TableMapData

Constructor & Destructor Documentation

◆ G4VDNAModel()

◆ ~G4VDNAModel()

Member Function Documentation

◆ AddCrossSectionData() [1/2]

◆ AddCrossSectionData() [2/2]

◆ BuildApplyToMatVect()

◆ CrossSectionPerVolume()

◆ EnableForMaterialAndParticle()

◆ GetHighELimit()

◆ GetLowELimit()

◆ GetName()

◆ GetTableData()

◆ Initialise()

◆ IsMaterialDefine()

◆ IsMaterialExistingInModel()

◆ IsParticleExistingInModelForMaterial()

◆ LoadCrossSectionData()

◆ RandomSelectShell()

◆ ReadAndSaveCSFile()

◆ ReadDiffCSFile()

◆ SampleSecondaries()

◆ SetHighELimit()

◆ SetLowELimit()