#include <G4DiscreteScatteringModel.hh>

Inheritance diagram for G4DiscreteScatteringModel:

Collaboration diagram for G4DiscreteScatteringModel:

Public Member Functions
	G4DiscreteScatteringModel (G4int iNumAngles=1)

virtual	~G4DiscreteScatteringModel ()

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

void	ReadData (G4int, const G4String &argFileName)

virtual G4double	ComputeCrossSectionPerAtom (const G4ParticleDefinition *, G4double E, G4double Z, G4double A=0., G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)

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

void	SetNumberOfAngles (G4int N)

void	SetAnalog (const G4String &model)

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	CrossSectionPerVolume (const G4Material , const G4ParticleDefinition , G4double kineticEnergy, G4double cutEnergy=0.0, G4double maxEnergy=DBL_MAX)

virtual G4double	GetPartialCrossSection (const G4Material , G4int, const G4ParticleDefinition , G4double)

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)

Private Member Functions
G4ThreeVector	GetNewDirection (G4double z1)

Private Attributes
G4PVDataVector	fGrid

G4ParticleChangeForGamma *	fParticleChange

G4String	fAnalogModel

G4int	fNumAngles

G4double	fLowEnergyLimit

Static Private Attributes
static G4ElementData *	fCdf = nullptr

static G4ElementData *	fTcs = nullptr

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

Protected Attributes inherited from G4VEmModel
G4ElementData *	fElementData

G4VParticleChange *	pParticleChange

G4PhysicsTable *	xSectionTable

const std::vector< G4double > *	theDensityFactor

const std::vector< G4int > *	theDensityIdx

size_t	idxTable

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

Detailed Description

Definition at line 18 of file G4DiscreteScatteringModel.hh.

Constructor & Destructor Documentation

◆ G4DiscreteScatteringModel()

G4DiscreteScatteringModel::G4DiscreteScatteringModel ( G4int iNumAngles = 1 )

Definition at line 26 of file G4DiscreteScatteringModel.cc.

   : G4VEmModel("DiscrScat"), fParticleChange(nullptr),fAnalogModel("pwe"), 
     fNumAngles(iNumAngles), fLowEnergyLimit(2*keV)
 {        
   SetHighEnergyLimit(100.*MeV); 
   SetLowEnergyLimit(fLowEnergyLimit); 
   if(IsMaster() && fCdf == nullptr) {
     fCdf = new G4ElementData();
     fTcs = new G4ElementData();
   }
 }

Here is the call graph for this function:

◆ ~G4DiscreteScatteringModel()

G4DiscreteScatteringModel::~G4DiscreteScatteringModel ( )

virtual

Definition at line 40 of file G4DiscreteScatteringModel.cc.

 {
   if(IsMaster()) {
     delete fCdf;
     delete fTcs;
     fCdf = nullptr;
     fTcs = nullptr;     
   }
 }

Here is the call graph for this function:

Member Function Documentation

◆ ComputeCrossSectionPerAtom()

G4double G4DiscreteScatteringModel::ComputeCrossSectionPerAtom	(	const G4ParticleDefinition *	,
		G4double	E,
		G4double	Z,
		G4double	A = `0.`,
		G4double	cutEnergy = `0.0`,
		G4double	maxEnergy = `DBL_MAX`
	)

virtual

Reimplemented from G4VEmModel.

Definition at line 330 of file G4DiscreteScatteringModel.cc.

 {
   // super simple, very compact look-up for total cross section 
   if (E==0.) {return 1e30;}
   //G4cout<<"------------------"<<G4endl;
   //G4cout<<"ComputeCrossSectionPerAtom"<<G4endl;
   //G4cout<< E<<" "<<G4Log(E)<<" "<< G4Exp(fTcs->GetValueForElement(Z,log(E)))
   //<<" "<<fTcs->GetValueForElement(Z,log(E))<<G4endl;
   //G4cout<<"------------------"<<G4endl;
   //G4cout<<" "<<G4endl;  
   
   //G4cout<< E<<" "<<G4Exp(fTcs->GetValueForElement(Z,log(E)))<<G4endl;
   
   return G4Exp(fTcs->GetValueForElement(Z,G4Log(E))); 
 }  

Here is the call graph for this function:

◆ GetNewDirection()

G4ThreeVector G4DiscreteScatteringModel::GetNewDirection ( G4double z1 )

private

Definition at line 350 of file G4DiscreteScatteringModel.cc.

 {
   G4ThreeVector dir(0.0,0.0,1.0);
 
   G4double sint = sin(acos(z1));
   G4double cost = sqrt(1.0 - sint*sint);
   G4double phi  = twopi* G4UniformRand();
   G4double dirx = sint*cos(phi);
   G4double diry = sint*sin(phi);
   G4double dirz = cost;
 
   dir.set(dirx,diry,dirz);
   return dir;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Initialise()

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

virtual

Implements G4VEmModel.

Definition at line 52 of file G4DiscreteScatteringModel.cc.

 {
   if(nullptr == fParticleChange) {
     fParticleChange = GetParticleChangeForGamma();
   }
   if(!IsMaster()) { return; }
 
   G4cout << "G4DiscreteScatteringModel::Initialise start"<<G4endl;
 
   const G4int maxZ = 100;
     
   char *path = getenv("G4GBFPDATA");
   if (!path)
     {
       G4Exception("G4DiscreteScatteringModel::Initialise","em0006",
                   FatalException,"G4GBFPDATA environment variable not set.");
       return;
     }
        
   std::ostringstream eFullFileName;
   eFullFileName << path;
   
   G4ProductionCutsTable* theCoupleTable =
     G4ProductionCutsTable::GetProductionCutsTable();
 
   G4int numOfCouples = theCoupleTable->GetTableSize();
 
   for(G4int i=0; i<numOfCouples; ++i)
     { 
       const G4Material* material = 
         theCoupleTable->GetMaterialCutsCouple(i)->GetMaterial();
       const G4ElementVector* theElementVector = material->GetElementVector();
       G4int nelm = material->GetNumberOfElements();
 
       for (G4int j=0; j<nelm; ++j)
         {   
           G4int Z = G4lrint((*theElementVector)[j]->GetZ());
           if(Z < 1)          { Z = 1; }
           else if(Z > maxZ)  { Z = maxZ; }
           if(!fTcs->GetElementData(Z)) { ReadData(Z, path); }
         }
     }
   G4cout << "G4DiscreteScatteringModel::Initialise completed"<<G4endl;        
 }

Here is the call graph for this function:

◆ ReadData()

void G4DiscreteScatteringModel::ReadData	(	G4int	Z,
		const G4String &	argFileName
	)

Definition at line 100 of file G4DiscreteScatteringModel.cc.

 {
 
   // Set strings with paths to tcs data file. Currently not a variable but this
   // this will change
   G4String fullFileName(argFileName);
 
   stringstream ss1;//create a stringstream
   ss1 << Z;//add number to the stream
   stringstream ss2;//create a stringstream
   ss2 << fNumAngles;
   G4String tcsPath = fullFileName+"/log_gbfp_"+fAnalogModel
     +"_tcs_"+ss1.str()+"_"+ss2.str()+".dat";
 
   // Do some error checking and exiting if data does not exist
   std::ifstream in(tcsPath, std::ifstream::binary|std::ifstream::in);
   if (!in.is_open())
     {
       G4String message("Data file \"");
       message+=tcsPath;
       message+="\" not found";
       G4Exception("G4DiscreteScatteringModel::LoadData","em0003",
                       FatalException,message);
       return;
     }
   //G4cout<<"Reading in data file "<< tcsPath<<G4endl;
 
   // Create a temporary G4PhysicsVector object pointer 
   G4PhysicsVector* tempData = new G4PhysicsVector(false);
   
   // Use retrieve to read in the total cross section (tcs) data
   tempData->Retrieve(in,true);
   
   // Convert tcs from cm^2 to mm^2
   //tempData->ScaleVector(1.0, 100.0);
   
   // store pass this data to the tcs object and initialise for current element 
   fTcs->InitialiseForElement(Z,tempData);  
   in.close();
                         
   // Set strings with paths to cdf data files. Currently not a variable 
   // but this this will change
   G4String cdfPath = fullFileName+"/gbfp_"+fAnalogModel+"_cdf_"
     +ss1.str()+"_"+ss2.str()+".dat";
 
   // Do some error checking and exiting if data does not exist
   std::ifstream in2(cdfPath, std::ifstream::binary|std::ifstream::in);
   if (!in2.is_open())
     {
       G4String message("Data file \"");
       message+=cdfPath;
       message+="\" not found";
       G4Exception("G4DiscreteScatteringModel::LoadData","em0003",
                       FatalException,message);
       return;
     }
     
   //G4cout<<"Reading in data file "<< cdfPath<<G4endl;
 
   // The cumulative distribution functions (CDF) for energy E_j and X_i 
   // on (0,1) is C(E_j,X_i) and read-in/stored at this time. 
   // For the purposes of this model, each energy grid point where the CDF 
   // is evaluated is considered a component. The number of energy grid 
   // points is consistent with the fTcs data, so the following int is set 
   // by calling G4PhysicsVector::GetVectorLength().
   G4int numEnergies = fTcs->GetElementData(Z)->GetVectorLength();
   
   // The ElementData object pointer is then initialized by
   fCdf->InitialiseForComponent(Z, numEnergies);
   
   // Now the data files are read in for all energies. At each energy, 
   // there are fNumAngles angles and fNumAngles CDF values.
 
   std::vector<G4PhysicsVector*> tempDataCDF;
   // Loop through each energy
   for (int j=0; j<numEnergies; j++)
     {
       // Push back a new G4PhysicsVector for the jth energy
       tempDataCDF.push_back(new G4PhysicsVector(false));
           
       // For use with David's PhysicsVector class
       //tempDataCDF.push_back(new G4PhysicsVector(false,false,true));
           
       //tempDataCDF.push_back(new G4PhysicsVector(false,false,false));
       //tempDataCDF.push_back(new G4PhysicsVector());
     } 
           
   // Open a temporary stream. The data for the jth energy group is copied 
   // to the temp file and then the temp file is sent to 
   // G4PhysicsVector::Retrieve(). Once the data is stored in the 
   // G4PhysicsVector, tempDataCDF, it is then passed to the ElementData, cdf, 
   // which is the container for all of the data for each element and energy.
   
   //static G4Mutex m = G4MUTEX_INITIALIZER;
   //G4AutoLock l(&m);
   
   // Open the stream and call file "tempDataFile.dat"
   std::ofstream file("tempDataFile.dat",
                      std::fstream::out | std::fstream::trunc);
   
   // Write to file the lower/upper bounds and the number of grid points 
   // for each column of data. The data in tempfile is 2xfNumAngles, 
   // hence fNumAngles fNumAngles. 
   // file<<lowerBound<<" "<<upperBound<<" "<<fNumAngles<<" "
   // <<fNumAngles<<G4endl;
   file<<"-1. 1. "<<fNumAngles<<" "<<fNumAngles<<G4endl;
 
   // Start while loop over the entire data file opened above 
   // e.g. pwe_cdf_79.dat. This data contains all of the data for each energy 
   G4int cntr = 0;
   G4int j = 0;
   G4double temp1, temp2;
   while(in2>>temp1>>temp2)
   {        
           // Write data to temporary file
     file<<setprecision(16)<<temp1<<"  "<<temp2<<G4endl;  
     cntr++;
     
     // When the first fNumAngles data points are copied to tempDataFile.dat, 
     // store data in tempDataCDF[j]. Then increment the energy index, j, 
     // close and clear the streams, and then reopen the streams such that 
     // the next fNumAngles data points are copied to tempDataFile.dat.
     if (cntr==fNumAngles) 
     {
       cntr=0;
       std::ifstream inTemp("tempDataFile.dat", 
                            std::ifstream::binary|std::ifstream::in);
       tempDataCDF[j]->Retrieve(inTemp,true);
       fCdf->AddComponent(Z,j,tempDataCDF[j]); 
       j++;
       inTemp.close(), inTemp.clear(), file.close(), file.clear();
       file.open("tempDataFile.dat",std::fstream::out | std::fstream::trunc);
       file<<"-1. 1. "<<fNumAngles<<" "<<fNumAngles<<G4endl;
     }
   }
     
   in2.close();
   
   return;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SampleSecondaries()

void G4DiscreteScatteringModel::SampleSecondaries	(	std::vector< G4DynamicParticle >	,
		const G4MaterialCutsCouple *	couple,
		const G4DynamicParticle *	p,
		G4double	tmin = `0.0`,
		G4double	maxEnergy = `DBL_MAX`
	)

virtual

Implements G4VEmModel.

Definition at line 243 of file G4DiscreteScatteringModel.cc.

 {
   G4double E = p->GetKineticEnergy();
 
   if(E < fLowEnergyLimit) return;
         
   // Select random atom
   G4int Z = G4lrint(SelectRandomAtom(couple,p->GetDefinition(),
                                      E,cutEnergy,E)->GetZ());
 
   // Determine the energy bin
   G4double logE = G4Log(E);
   G4ThreeVector dir = p->GetMomentumDirection(); //old direction
   G4int         j   = fTcs->GetElementData(Z)->FindBin(logE,0); 
 
   //-------------------------------------------------------------------------
   // it would be nice to have the following block of code in G4PhysicsVector.
   // it could be a simple function. 
   
   //    v.GetVectorLength()  - number of points
   //    v.Energy(size_t idx) - value x(i)
   //    v[i]                 - value y(i)
   
   // This is a monte carlo interpolation scheme
   G4double e1 = fTcs->GetElementData(Z)->Energy(j);
   G4double e2 = fTcs->GetElementData(Z)->Energy(j+1);
   
   // This is a monte carlo interpolation scheme
   G4double pie1 = (logE-e1)/(e2-e1);
   G4double    r = G4UniformRand();
   if (r<pie1){ ++j; } 
   
   //-------------------------------------------------------------------------
   // it would be nice to have the following block of code in G4PhysicsVector.
   //---------------
   // Given the energy grid value associated with the DCS, 
   // sample a deflection cosine       
   r       = G4UniformRand();
   G4int k = -1;
   // First test if the angle is the most probable angle
   if (r>(*fCdf->GetComponentDataByIndex(Z,j)).Energy(fNumAngles-2)) 
     { k = fNumAngles-1; }
   // or the least probable... not sure why I do this (maybe because 
   // it is a simple check)
   else if (r<=(*fCdf->GetComponentDataByIndex(Z,j)).Energy(0)) { k = 0; }
   // if neither then loop through remaining angles, break when locating angle
   else {
     for (G4int i=fNumAngles-2; i>0; --i) { 
       if ( (r>(*fCdf->GetComponentDataByIndex(Z,j)).Energy(i-1)) 
            && (r<= (*fCdf->GetComponentDataByIndex(Z,j)).Energy(i)) )
         { k=i; break;}
     }
   }
   // Throw an error if an angle was not sampled, data is probably no good  
   if(k<0)
   {
     G4cout << "G4DiscreteScatteringModel::SampleSecondaries():"
            << " CDF was not inverted properly "<<k<<G4endl;
     for (G4int i=0;i<fNumAngles;++i) { 
       G4cout<<i<<" "<<(*fCdf->GetComponentDataByIndex(Z,j)).Energy(i)<<" "<<r<<G4endl;
     }
   }
   //-------------------------------------------------------------------------
 
   // Otherwise, go get the angle and pass it too local method GetNewDirection.
   // Then do transformation and update fParticleChange.
   
   //G4cout<<"------------------"<<G4endl;
   //G4cout<<"Sample Secondaries"<<G4endl;
   //G4cout<<G4Exp(e1)<<" "<<E<<" "<<G4Exp(e2)<<" "<<pie1<<" "
   // <<(*fCdf->GetComponentDataByIndex(Z,j)).Energy(k)<<G4endl;
   //G4cout<<"------------------"<<G4endl;
   //G4cout<<" "<<G4endl;    
   
   G4ThreeVector newDirection = 
     GetNewDirection((*fCdf->GetComponentDataByIndex(Z,j))[k]);
   newDirection.rotateUz(dir);   
   fParticleChange->ProposeMomentumDirection(newDirection);  
 }