G4VDNAModel 클래스 참조

The G4VDNAModel class. 더 자세히 ...

#include <G4VDNAModel.hh>

G4VDNAModel에 대한 상속 다이어그램 :

Public 멤버 함수
	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 타입
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 멤버 함수
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. 더 자세히 ...

Private 속성
const G4String	fStringOfMaterials
	fStringOfMaterials The user can decide to specify by hand which are the materials the be activated among those implemented in the model. If the user does then only the specified materials contained in this string variable will be activated. The string is like: mat1/mat2/mat3/mat4 더 자세히 ...
TableMapData	fTableData
	fTableData It contains the cross section data and can be used like: dataTable=fTableData[material][particle] 더 자세히 ...
std::vector< G4String >	fModelMaterials
	List the materials that can be activated (and will be by default) within the model. 더 자세히 ...
std::vector< G4String >	fModelParticles
	List the particles that can be activated within the model. 더 자세히 ...
std::vector< G4String >	fModelCSFiles
	List the cross section data files. 더 자세히 ...
std::vector< G4String >	fModelDiffCSFiles
	List the differential corss section data files. 더 자세히 ...
std::vector< G4double >	fModelScaleFactors
	List the model scale factors (they could change with material) 더 자세히 ...
std::map< G4String, std::map < G4String, G4double > >	fLowEnergyLimits
	List the low energy limits. 더 자세히 ...
std::map< G4String, std::map < G4String, G4double > >	fHighEnergyLimits
	List the high energy limits. 더 자세히 ...
G4String	fName
	model name 더 자세히 ...

상세한 설명

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.

G4VDNAModel.hh 파일의 49 번째 라인에서 정의되었습니다.

멤버 타입정의 문서화

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

protected

G4VDNAModel.hh 파일의 185 번째 라인에서 정의되었습니다.

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

protected

G4VDNAModel.hh 파일의 184 번째 라인에서 정의되었습니다.

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

protected

G4VDNAModel.hh 파일의 183 번째 라인에서 정의되었습니다.

생성자 & 소멸자 문서화

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

G4VDNAModel Constructeur of the G4VDNAModel class.

매개변수

nam
applyToMaterial

G4VDNAModel.cc 파일의 35 번째 라인에서 정의되었습니다.

G4VDNAModel::~G4VDNAModel ( )

virtual

~G4VDNAModel

G4VDNAModel.cc 파일의 41 번째 라인에서 정의되었습니다.

다음을 참조함 : fTableData.

멤버 함수 문서화

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.

매개변수

materialName
particleName
fileCS
fileDiffCS
scaleFactor

G4VDNAModel.cc 파일의 58 번째 라인에서 정의되었습니다.

다음을 참조함 : fModelCSFiles, fModelDiffCSFiles, fModelMaterials, fModelParticles, fModelScaleFactors.

다음에 의해서 참조됨 : G4DNAPTBExcitationModel::Initialise(), G4DNAPTBElasticModel::Initialise(), G4DNAPTBIonisationModel::Initialise().

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.

매개변수

materialName
particleName
fileCS
scaleFactor

G4VDNAModel.cc 파일의 67 번째 라인에서 정의되었습니다.

다음을 참조함 : fModelCSFiles, fModelMaterials, fModelParticles, fModelScaleFactors.

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.

매개변수

materials

반환값

a vector with all the material names

G4VDNAModel.cc 파일의 139 번째 라인에서 정의되었습니다.

다음을 참조함 : mat.

다음에 의해서 참조됨 : LoadCrossSectionData().

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.

매개변수

material
materialName
p
ekin
emin
emax

반환값

crossSection*numberOfMoleculesPerVolumeUnit

G4DNAPTBIonisationModel, G4DNAPTBElasticModel, G4DNAPTBExcitationModel, G4DNAVacuumModel, G4DNADummyModel에서 구현되었습니다.

다음에 의해서 참조됨 : G4DNAModelInterface::CrossSectionPerVolume().

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

protected

EnableMaterialAndParticle.

매개변수

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.

G4VDNAModel.cc 파일의 134 번째 라인에서 정의되었습니다.

다음을 참조함 : fTableData.

다음에 의해서 참조됨 : G4DNADummyModel::Initialise(), G4DNAVacuumModel::Initialise().

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

inline

GetHighEnergyLimit.

매개변수

material
particle

반환값

fHighEnergyLimits[material][particle]

G4VDNAModel.hh 파일의 153 번째 라인에서 정의되었습니다.

다음을 참조함 : fHighEnergyLimits.

다음에 의해서 참조됨 : G4DNAPTBExcitationModel::CrossSectionPerVolume(), G4DNAPTBElasticModel::CrossSectionPerVolume(), G4DNAPTBIonisationModel::CrossSectionPerVolume(), G4DNAPTBElasticModel::SampleSecondaries(), G4DNAPTBIonisationModel::SampleSecondaries().

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

inline

GetLowEnergyLimit.

매개변수

material
particle

반환값

fLowEnergyLimits[material][particle]

G4VDNAModel.hh 파일의 161 번째 라인에서 정의되었습니다.

다음을 참조함 : fLowEnergyLimits.

다음에 의해서 참조됨 : G4DNAPTBExcitationModel::CrossSectionPerVolume(), G4DNAPTBElasticModel::CrossSectionPerVolume(), G4DNAPTBIonisationModel::CrossSectionPerVolume(), G4DNAPTBElasticModel::SampleSecondaries(), G4DNAPTBIonisationModel::SampleSecondaries().

G4String G4VDNAModel::GetName ( void  )

inline

GetName.

반환값

the name of the model

G4VDNAModel.hh 파일의 145 번째 라인에서 정의되었습니다.

다음을 참조함 : fName.

다음에 의해서 참조됨 : IsMaterialDefine().

TableMapData* G4VDNAModel::GetTableData ( )

inlineprotected

GetTableData.

반환값

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

G4VDNAModel.hh 파일의 193 번째 라인에서 정의되었습니다.

다음을 참조함 : fTableData.

다음에 의해서 참조됨 : G4DNAPTBExcitationModel::CrossSectionPerVolume(), G4DNAPTBElasticModel::CrossSectionPerVolume(), G4DNAPTBIonisationModel::CrossSectionPerVolume(), RandomSelectShell().

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

pure virtual

Initialise Each model must implement an Initialize method.

매개변수

particle
cuts

G4DNAPTBIonisationModel, G4DNAPTBElasticModel, G4DNAPTBExcitationModel, G4DNAVacuumModel, G4DNADummyModel에서 구현되었습니다.

G4bool G4VDNAModel::IsMaterialDefine

(

const G4String &

materialName

)

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

매개변수

materialName

반환값

true if the material is defined in the simulation

G4VDNAModel.cc 파일의 237 번째 라인에서 정의되었습니다.

다음을 참조함 : G4Material::GetMaterialTable(), GetName().

G4bool G4VDNAModel::IsMaterialExistingInModel

(

const G4String &

materialName

)

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

매개변수

materialName

반환값

true if the material is defined in the model

G4VDNAModel.cc 파일의 257 번째 라인에서 정의되었습니다.

다음을 참조함 : fTableData.

다음에 의해서 참조됨 : 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 ?

매개변수

particleName
materialName

반환값

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

G4VDNAModel.cc 파일의 271 번째 라인에서 정의되었습니다.

다음을 참조함 : fTableData, IsMaterialExistingInModel().

void G4VDNAModel::LoadCrossSectionData ( const G4String &  particleName )

protected

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

G4VDNAModel.cc 파일의 75 번째 라인에서 정의되었습니다.

다음을 참조함 : BuildApplyToMatVect(), FatalException, fModelCSFiles, fModelDiffCSFiles, fModelMaterials, fModelParticles, fModelScaleFactors, fStringOfMaterials, G4Exception(), ReadAndSaveCSFile(), ReadDiffCSFile().

다음에 의해서 참조됨 : G4DNAPTBExcitationModel::Initialise(), G4DNAPTBElasticModel::Initialise(), G4DNAPTBIonisationModel::Initialise().

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.

매개변수

k
particle
materialName

반환값

the selected shell

G4VDNAModel.cc 파일의 182 번째 라인에서 정의되었습니다.

다음을 참조함 : FatalException, G4VEMDataSet::FindValue(), G4Exception(), G4UniformRand, G4DNACrossSectionDataSet::GetComponent(), GetTableData(), n, G4DNACrossSectionDataSet::NumberOfComponents(), pos.

다음에 의해서 참조됨 : G4DNAPTBExcitationModel::SampleSecondaries(), G4DNAPTBIonisationModel::SampleSecondaries().

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

매개변수

materialName
particleName
file
scaleFactor

G4VDNAModel.cc 파일의 174 번째 라인에서 정의되었습니다.

다음을 참조함 : eV, fTableData.

다음에 의해서 참조됨 : LoadCrossSectionData().

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.

매개변수

materialName
particleName
path
scaleFactor

G4DNAPTBIonisationModel, G4DNAPTBElasticModel에서 재구현되었습니다.

G4VDNAModel.cc 파일의 126 번째 라인에서 정의되었습니다.

다음을 참조함 : FatalException, G4Exception().

다음에 의해서 참조됨 : LoadCrossSectionData().

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.

매개변수

materialName
particleChangeForGamma
tmin
tmax

G4DNAPTBIonisationModel, G4DNAPTBElasticModel, G4DNAPTBExcitationModel, G4DNAVacuumModel, G4DNADummyModel에서 구현되었습니다.

다음에 의해서 참조됨 : G4DNAModelInterface::SampleSecondaries().

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

inline

SetHighEnergyLimit.

매개변수

material
particle
lim

G4VDNAModel.hh 파일의 169 번째 라인에서 정의되었습니다.

다음을 참조함 : fHighEnergyLimits.

다음에 의해서 참조됨 : G4DNADummyModel::Initialise(), G4DNAPTBExcitationModel::Initialise(), G4DNAPTBElasticModel::Initialise(), G4DNAPTBIonisationModel::Initialise().

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

inline

SetLowEnergyLimit.

매개변수

material
particle
lim

G4VDNAModel.hh 파일의 177 번째 라인에서 정의되었습니다.

다음을 참조함 : fLowEnergyLimits.

다음에 의해서 참조됨 : G4DNADummyModel::Initialise(), G4DNAPTBExcitationModel::Initialise(), G4DNAPTBElasticModel::Initialise(), G4DNAPTBIonisationModel::Initialise().

멤버 데이타 문서화

std::map<G4String, std::map<G4String, G4double> > G4VDNAModel::fHighEnergyLimits

private

List the high energy limits.

G4VDNAModel.hh 파일의 301 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : GetHighELimit(), SetHighELimit().

std::map<G4String, std::map<G4String, G4double> > G4VDNAModel::fLowEnergyLimits

private

List the low energy limits.

G4VDNAModel.hh 파일의 300 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : GetLowELimit(), SetLowELimit().

std::vector<G4String> G4VDNAModel::fModelCSFiles

private

List the cross section data files.

G4VDNAModel.hh 파일의 296 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : AddCrossSectionData(), LoadCrossSectionData().

std::vector<G4String> G4VDNAModel::fModelDiffCSFiles

private

List the differential corss section data files.

G4VDNAModel.hh 파일의 297 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : AddCrossSectionData(), LoadCrossSectionData().

std::vector<G4String> G4VDNAModel::fModelMaterials

private

List the materials that can be activated (and will be by default) within the model.

G4VDNAModel.hh 파일의 294 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : AddCrossSectionData(), LoadCrossSectionData().

std::vector<G4String> G4VDNAModel::fModelParticles

private

List the particles that can be activated within the model.

G4VDNAModel.hh 파일의 295 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : AddCrossSectionData(), LoadCrossSectionData().

std::vector<G4double> G4VDNAModel::fModelScaleFactors

private

List the model scale factors (they could change with material)

G4VDNAModel.hh 파일의 298 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : AddCrossSectionData(), LoadCrossSectionData().

G4String G4VDNAModel::fName

private

model name

G4VDNAModel.hh 파일의 303 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : GetName().

const G4String G4VDNAModel::fStringOfMaterials

private

fStringOfMaterials The user can decide to specify by hand which are the materials the be activated among those implemented in the model. If the user does then only the specified materials contained in this string variable will be activated. The string is like: mat1/mat2/mat3/mat4

G4VDNAModel.hh 파일의 286 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : LoadCrossSectionData().

TableMapData G4VDNAModel::fTableData

private

fTableData It contains the cross section data and can be used like: dataTable=fTableData[material][particle]

G4VDNAModel.hh 파일의 292 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : EnableForMaterialAndParticle(), GetTableData(), IsMaterialExistingInModel(), IsParticleExistingInModelForMaterial(), ReadAndSaveCSFile(), ~G4VDNAModel().

---

이 클래스에 대한 문서화 페이지는 다음의 파일들로부터 생성되었습니다.:

• G4VDNAModel.hh
• G4VDNAModel.cc