#include <G4DNASancheExcitationModel.hh>

Inheritance diagram for G4DNASancheExcitationModel:

Collaboration diagram for G4DNASancheExcitationModel:

Public Member Functions
	G4DNASancheExcitationModel (const G4ParticleDefinition *p=0, const G4String &nam="DNASancheExcitationModel")

virtual	~G4DNASancheExcitationModel ()

virtual void	Initialise (const G4ParticleDefinition *, const G4DataVector &)

virtual G4double	CrossSectionPerVolume (const G4Material material, const G4ParticleDefinition p, G4double ekin, G4double emin, G4double emax)

virtual void	SampleSecondaries (std::vector< G4DynamicParticle > , const G4MaterialCutsCouple , const G4DynamicParticle , G4double tmin, G4double maxEnergy)

G4double	PartialCrossSection (G4double energy, G4int level)

G4double	TotalCrossSection (G4double t)

void	ExtendLowEnergyLimit (G4double)

void	SetVerboseLevel (int verbose)

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, const G4ParticleDefinition , G4double)

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

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

G4int	SelectIsotopeNumber (const G4Element *)

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

G4int	SelectRandomAtomNumber (const G4Material *)

void	SetParticleChange (G4VParticleChange , G4VEmFluctuationModel f=0)

void	SetCrossSectionTable (G4PhysicsTable *, G4bool isLocal)

G4ElementData *	GetElementData ()

G4PhysicsTable *	GetCrossSectionTable ()

G4VEmFluctuationModel *	GetModelOfFluctuations ()

G4VEmAngularDistribution *	GetAngularDistribution ()

void	SetAngularDistribution (G4VEmAngularDistribution *)

G4double	HighEnergyLimit () const

G4double	LowEnergyLimit () const

G4double	HighEnergyActivationLimit () const

G4double	LowEnergyActivationLimit () const

G4double	PolarAngleLimit () const

G4double	SecondaryThreshold () const

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

void	SetPolarAngleLimit (G4double)

void	SetSecondaryThreshold (G4double)

void	SetLPMFlag (G4bool val)

void	SetDeexcitationFlag (G4bool val)

void	SetForceBuildTable (G4bool val)

void	SetMasterThread (G4bool val)

G4bool	IsMaster () const

G4double	MaxSecondaryKinEnergy (const G4DynamicParticle *dynParticle)

const G4String &	GetName () const

void	SetCurrentCouple (const G4MaterialCutsCouple *)

const G4Element *	GetCurrentElement () const

const G4Isotope *	GetCurrentIsotope () const

G4bool	IsLocked () const

void	SetLocked (G4bool)

Protected Attributes
G4ParticleChangeForGamma *	fParticleChangeForGamma

Protected Attributes inherited from G4VEmModel
G4ElementData *	fElementData

G4VParticleChange *	pParticleChange

G4PhysicsTable *	xSectionTable

const std::vector< G4double > *	theDensityFactor

const std::vector< G4int > *	theDensityIdx

size_t	idxTable

Private Member Functions
G4int	RandomSelect (G4double energy)

G4double	VibrationEnergy (G4int level)

G4double	Sum (G4double k)

G4double	LinInterpolate (G4double e1, G4double e2, G4double e, G4double xs1, G4double xs2)

G4DNASancheExcitationModel &	operator= (const G4DNASancheExcitationModel &right)

	G4DNASancheExcitationModel (const G4DNASancheExcitationModel &)

Private Attributes
const std::vector< G4double > *	fpWaterDensity

G4double	lowEnergyLimit

G4double	highEnergyLimit

G4bool	isInitialised

G4int	verboseLevel

G4int	nLevels

std::vector< double >	tdummyVec

std::vector< std::vector< double > >	fEnergyLevelXS

std::vector< double >	fEnergyTotalXS

Additional Inherited Members
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 *)

Static Protected Attributes inherited from G4VEmModel
static const G4double	inveplus = 1.0/CLHEP::eplus

Detailed Description

Definition at line 45 of file G4DNASancheExcitationModel.hh.

Constructor & Destructor Documentation

◆ G4DNASancheExcitationModel() [1/2]

G4DNASancheExcitationModel::G4DNASancheExcitationModel	(	const G4ParticleDefinition *	p = `0`,
		const G4String &	nam = `"DNASancheExcitationModel"`
	)

Definition at line 41 of file G4DNASancheExcitationModel.cc.

                                                                             :
     G4VEmModel(nam), isInitialised(false)
 {
   fpWaterDensity = 0;
 
   lowEnergyLimit = 2 * eV;
   highEnergyLimit = 100 * eV;
   SetLowEnergyLimit(lowEnergyLimit);
   SetHighEnergyLimit(highEnergyLimit);
   nLevels = 9;
 
   verboseLevel = 0;
   // Verbosity scale:
   // 0 = nothing
   // 1 = warning for energy non-conservation
   // 2 = details of energy budget
   // 3 = calculation of cross sections, file openings, sampling of atoms
   // 4 = entering in methods
 
   if (verboseLevel > 0)
   {
     G4cout << "Sanche Excitation model is constructed " << G4endl<< "Energy range: "
     << lowEnergyLimit / eV << " eV - "
     << highEnergyLimit / eV << " eV"
     << G4endl;
   }
   fParticleChangeForGamma = 0;
   fpWaterDensity = 0;
 }

Here is the call graph for this function:

◆ ~G4DNASancheExcitationModel()

G4DNASancheExcitationModel::~G4DNASancheExcitationModel ( )

virtual

Definition at line 74 of file G4DNASancheExcitationModel.cc.

75 {

76 }

◆ G4DNASancheExcitationModel() [2/2]

G4DNASancheExcitationModel::G4DNASancheExcitationModel ( const G4DNASancheExcitationModel & )

private

Member Function Documentation

◆ CrossSectionPerVolume()

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

virtual

Reimplemented from G4VEmModel.

Definition at line 168 of file G4DNASancheExcitationModel.cc.

 {
   if (verboseLevel > 3)
   G4cout << "Calling CrossSectionPerVolume() of G4DNASancheExcitationModel"
   << G4endl;
 
   // Calculate total cross section for model
 
   G4double sigma=0;
 
   G4double waterDensity = (*fpWaterDensity)[material->GetIndex()];
 
   if(waterDensity!= 0.0)
   {
 
 //    if (particleDefinition == G4Electron::ElectronDefinition()) // pas besoin
     {
       if (ekin >= lowEnergyLimit && ekin < highEnergyLimit)
         // for now this is necessary 
       {
         //sigma = Sum(ekin);
         sigma =  TotalCrossSection(ekin);
       }
     }
 
     if (verboseLevel > 2)
     {
       G4cout << "__________________________________" << G4endl;
       G4cout << "=== G4DNASancheExcitationModel - XS INFO START" << G4endl;
       G4cout << "=== Kinetic energy(eV)=" << ekin/eV << " particle : " << particleDefinition->GetParticleName() << G4endl;
       G4cout << "=== Cross section per water molecule (cm^2)=" << sigma/cm/cm << G4endl;
       G4cout << "=== Cross section per water molecule (cm^-1)=" << sigma*waterDensity/(1./cm) << G4endl;
       G4cout << "=== G4DNASancheExcitationModel - XS INFO END" << G4endl;
     }
 
   } // if water
 
   return sigma*2*waterDensity;
   // see papers for factor 2 description
 
 }

Here is the call graph for this function:

◆ ExtendLowEnergyLimit()

void G4DNASancheExcitationModel::ExtendLowEnergyLimit ( G4double threshold )

inline

Definition at line 121 of file G4DNASancheExcitationModel.hh.

 {
   lowEnergyLimit = threshold;
   if(lowEnergyLimit < 2 * CLHEP::eV)
     G4Exception("*** WARNING : the G4DNASancheExcitationModel class is not "
                 "validated below 2 eV !",
                 "", JustWarning, "");
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Initialise()

void G4DNASancheExcitationModel::Initialise	(	const G4ParticleDefinition *	,
		const G4DataVector &
	)

virtual

Implements G4VEmModel.

Definition at line 80 of file G4DNASancheExcitationModel.cc.

 {
 
   if (verboseLevel > 3)
   G4cout << "Calling G4DNASancheExcitationModel::Initialise()" << G4endl;
 
   // Energy limits
 
   if (LowEnergyLimit() < lowEnergyLimit)
   {
     G4cout << "G4DNASancheExcitationModel: low energy limit increased from " <<
     LowEnergyLimit()/eV << " eV to " << lowEnergyLimit/eV << " eV" << G4endl;
     SetLowEnergyLimit(lowEnergyLimit);
   }
 
   if (HighEnergyLimit() > highEnergyLimit)
   {
     G4cout << "G4DNASancheExcitationModel: high energy limit decreased from " <<
     HighEnergyLimit()/eV << " eV to " << highEnergyLimit/eV << " eV" << G4endl;
     SetHighEnergyLimit(highEnergyLimit);
   }
 
   //
 
   if (verboseLevel > 0)
   {
     G4cout << "Sanche Excitation model is initialized " << G4endl
     << "Energy range: "
     << LowEnergyLimit() / eV << " eV - "
     << HighEnergyLimit() / eV << " eV"
     << G4endl;
   }
 
   // Initialize water density pointer
   fpWaterDensity = G4DNAMolecularMaterial::Instance()->
       GetNumMolPerVolTableFor(G4Material::GetMaterial("G4_WATER"));
 
   if (isInitialised) {return;} // RETURNS HERE
 
   fParticleChangeForGamma = GetParticleChangeForGamma();
   isInitialised = true;
 
   char *path = getenv("G4LEDATA");
   std::ostringstream eFullFileName;
   eFullFileName << path << "/dna/sigma_excitationvib_e_sanche.dat";
   std::ifstream input(eFullFileName.str().c_str());
 
   if (!input)
   {
     G4Exception("G4DNASancheExcitationModel::Initialise","em0003",
         FatalException,"Missing data file:/dna/sigma_excitationvib_e_sanche.dat");
   }
 
   // March 25th, 2014 - Vaclav Stepan, Sebastien Incerti
   // Added clear for MT
   tdummyVec.clear();
   //
 
   double t;
   double xs;
 
   while(!input.eof())
   {
     input>>t;
     tdummyVec.push_back(t);
 
     fEnergyLevelXS.push_back(std::vector<double>());
     fEnergyTotalXS.push_back(0);
     std::vector<double>& levelXS = fEnergyLevelXS.back();
     levelXS.reserve(9);
 
 //    G4cout<<t;
 
     for(size_t i = 0 ; i < 9 ;++i)
     {
       input>>xs;
       levelXS.push_back(xs);
       fEnergyTotalXS.back() += xs;
 //      G4cout <<"  " << levelXS[i];
     }
 
 //    G4cout << G4endl;
   }
 }

Here is the call graph for this function:

◆ LinInterpolate()

G4double G4DNASancheExcitationModel::LinInterpolate	(	G4double	e1,
		G4double	e2,
		G4double	e,
		G4double	xs1,
		G4double	xs2
	)

private

Definition at line 372 of file G4DNASancheExcitationModel.cc.

 {
   G4double a = (xs2 - xs1) / (e2 - e1);
   G4double b = xs2 - a * e2;
   G4double value = a * e + b;
   // G4cout<<"interP >>  "<<e1<<"  "<<e2<<"  "<<e<<"  "<<xs1<<"  "<<xs2<<"  "<<a<<"  "<<b<<"  "<<value<<G4endl;
 
   return value;
 }

Here is the caller graph for this function:

◆ operator=()

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

private

◆ PartialCrossSection()

G4double G4DNASancheExcitationModel::PartialCrossSection	(	G4double	energy,
		G4int	level
	)

Definition at line 263 of file G4DNASancheExcitationModel.cc.

 {
   std::vector<double>::iterator t2 = std::upper_bound(tdummyVec.begin(),
                                                       tdummyVec.end(), t / eV);
   std::vector<double>::iterator t1 = t2 - 1;
 
   size_t i1 = t1 - tdummyVec.begin();
   size_t i2 = t2 - tdummyVec.begin();
 
   double sigma = LinInterpolate((*t1), (*t2),
                                 t / eV,
                                 fEnergyLevelXS[i1][level],
                                 fEnergyLevelXS[i2][level]);
 
   static const double conv_factor =  1e-16 * cm * cm;
 
   sigma *= conv_factor;
   if (sigma == 0.) sigma = 1e-30;
   return (sigma);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RandomSelect()

G4int G4DNASancheExcitationModel::RandomSelect ( G4double energy )

private

Definition at line 319 of file G4DNASancheExcitationModel.cc.

 {
 
   // Level Selection Counting can be done here !
 
   G4int i = nLevels;
   G4double value = 0.;
   std::deque<double> values;
 
   while (i > 0)
   {
     i--;
     G4double partial = PartialCrossSection(k, i);
     values.push_front(partial);
     value += partial;
   }
 
   value *= G4UniformRand();
 
   i = nLevels;
 
   while (i > 0)
   {
     i--;
     if (values[i] > value)
     {
       //outcount<<i<<"  "<<VibrationEnergy(i)<<G4endl;
       return i;
     }
     value -= values[i];
   }
 
   //outcount<<0<<"  "<<VibrationEnergy(0)<<G4endl;
 
   return 0;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SampleSecondaries()

void G4DNASancheExcitationModel::SampleSecondaries	(	std::vector< G4DynamicParticle >	,
		const G4MaterialCutsCouple *	,
		const G4DynamicParticle *	aDynamicElectron,
		G4double	tmin,
		G4double	maxEnergy
	)

virtual

Implements G4VEmModel.

Definition at line 216 of file G4DNASancheExcitationModel.cc.

 {
 
   if (verboseLevel > 3)
   G4cout << "Calling SampleSecondaries() of G4DNASancheExcitationModel"
   << G4endl;
 
   G4double electronEnergy0 = aDynamicElectron->GetKineticEnergy();
   G4int level = RandomSelect(electronEnergy0);
   G4double excitationEnergy = VibrationEnergy(level); // levels go from 0 to 8
   G4double newEnergy = electronEnergy0 - excitationEnergy;
 
   /*
    if (electronEnergy0 < highEnergyLimit)
    {
      if (newEnergy >= lowEnergyLimit)
      {
        fParticleChangeForGamma->ProposeMomentumDirection(aDynamicElectron->GetMomentumDirection());
        fParticleChangeForGamma->SetProposedKineticEnergy(newEnergy);
        fParticleChangeForGamma->ProposeLocalEnergyDeposit(excitationEnergy);
      }
 
      else
      {
        fParticleChangeForGamma->ProposeTrackStatus(fStopAndKill);
        fParticleChangeForGamma->ProposeLocalEnergyDeposit(electronEnergy0);
      }
    }
    */
 
   if (electronEnergy0 < highEnergyLimit && newEnergy>0.)
   {
     fParticleChangeForGamma->ProposeMomentumDirection(aDynamicElectron->GetMomentumDirection());
     fParticleChangeForGamma->SetProposedKineticEnergy(newEnergy);
     fParticleChangeForGamma->ProposeLocalEnergyDeposit(excitationEnergy);
   }
 
   //
 }

Here is the call graph for this function:

◆ SetVerboseLevel()

void G4DNASancheExcitationModel::SetVerboseLevel ( int verbose )

inline

Definition at line 76 of file G4DNASancheExcitationModel.hh.

   {
     verboseLevel = verbose;
   }

◆ Sum()

G4double G4DNASancheExcitationModel::Sum ( G4double k )

private

Definition at line 358 of file G4DNASancheExcitationModel.cc.

 {
   G4double totalCrossSection = 0.;
 
   for (G4int i = 0; i < nLevels; i++)
   {
     totalCrossSection += PartialCrossSection(k, i);
   }
 
   return totalCrossSection;
 }

Here is the call graph for this function:

◆ TotalCrossSection()

G4double G4DNASancheExcitationModel::TotalCrossSection ( G4double t )

Definition at line 287 of file G4DNASancheExcitationModel.cc.

 {
   std::vector<double>::iterator t2 = std::upper_bound(tdummyVec.begin(),
                                                       tdummyVec.end(), t / eV);
   std::vector<double>::iterator t1 = t2 - 1;
 
   size_t i1 = t1 - tdummyVec.begin();
   size_t i2 = t2 - tdummyVec.begin();
 
   double sigma = LinInterpolate((*t1), (*t2),
                                 t / eV,
                                 fEnergyTotalXS[i1],
                                 fEnergyTotalXS[i2]);
 
   static const double conv_factor =  1e-16 * cm * cm;
 
   sigma *= conv_factor;
   if (sigma == 0.) sigma = 1e-30;
   return (sigma);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VibrationEnergy()

G4double G4DNASancheExcitationModel::VibrationEnergy ( G4int level )

private

Definition at line 310 of file G4DNASancheExcitationModel.cc.

 {
   static G4double energies[9] = { 0.01, 0.024, 0.061, 0.092, 0.204, 0.417, 0.460,
                            0.500, 0.835 };
   return (energies[level] * eV);
 }

Here is the caller graph for this function:

Member Data Documentation

◆ fEnergyLevelXS

std::vector<std::vector<double> > G4DNASancheExcitationModel::fEnergyLevelXS

private

Definition at line 110 of file G4DNASancheExcitationModel.hh.

◆ fEnergyTotalXS

std::vector<double> G4DNASancheExcitationModel::fEnergyTotalXS

private

Definition at line 111 of file G4DNASancheExcitationModel.hh.

◆ fParticleChangeForGamma

G4ParticleChangeForGamma* G4DNASancheExcitationModel::fParticleChangeForGamma

protected

Definition at line 83 of file G4DNASancheExcitationModel.hh.

◆ fpWaterDensity

const std::vector<G4double>* G4DNASancheExcitationModel::fpWaterDensity

private

Definition at line 87 of file G4DNASancheExcitationModel.hh.

◆ highEnergyLimit

G4double G4DNASancheExcitationModel::highEnergyLimit

private

Definition at line 90 of file G4DNASancheExcitationModel.hh.

◆ isInitialised

G4bool G4DNASancheExcitationModel::isInitialised

private

Definition at line 91 of file G4DNASancheExcitationModel.hh.

◆ lowEnergyLimit

G4double G4DNASancheExcitationModel::lowEnergyLimit

private

Definition at line 89 of file G4DNASancheExcitationModel.hh.

◆ nLevels

G4int G4DNASancheExcitationModel::nLevels

private

Definition at line 97 of file G4DNASancheExcitationModel.hh.

◆ tdummyVec

std::vector<double> G4DNASancheExcitationModel::tdummyVec

private

Definition at line 109 of file G4DNASancheExcitationModel.hh.

◆ verboseLevel

G4int G4DNASancheExcitationModel::verboseLevel

private

Definition at line 92 of file G4DNASancheExcitationModel.hh.

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

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ G4DNASancheExcitationModel() [1/2]

◆ ~G4DNASancheExcitationModel()

◆ G4DNASancheExcitationModel() [2/2]

Member Function Documentation

◆ CrossSectionPerVolume()

◆ ExtendLowEnergyLimit()

◆ Initialise()

◆ LinInterpolate()

◆ operator=()

◆ PartialCrossSection()

◆ RandomSelect()

◆ SampleSecondaries()

◆ SetVerboseLevel()

◆ Sum()

◆ TotalCrossSection()

◆ VibrationEnergy()

Member Data Documentation

◆ fEnergyLevelXS

◆ fEnergyTotalXS

◆ fParticleChangeForGamma

◆ fpWaterDensity

◆ highEnergyLimit

◆ isInitialised

◆ lowEnergyLimit

◆ nLevels

◆ tdummyVec

◆ verboseLevel