#include <G4eCoulombScatteringModel.hh>

Inheritance diagram for G4eCoulombScatteringModel:

Public Member Functions
	G4eCoulombScatteringModel (const G4String &nam="eCoulombScattering")

virtual	~G4eCoulombScatteringModel ()

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

virtual void	InitialiseLocal (const G4ParticleDefinition , G4VEmModel masterModel)

virtual G4double	ComputeCrossSectionPerAtom (const G4ParticleDefinition *, G4double kinEnergy, G4double Z, G4double A, G4double cut, G4double emax)

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

virtual G4double	MinPrimaryEnergy (const G4Material , const G4ParticleDefinition , G4double)

void	SetLowEnergyThreshold (G4double val)

void	SetRecoilThreshold (G4double eth)

void	SetFixedCut (G4double)

G4double	GetFixedCut () const

Public Member Functions inherited from G4VEmModel
	G4VEmModel (const G4String &nam)

virtual	~G4VEmModel ()

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	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	MinEnergyCut (const G4ParticleDefinition , const G4MaterialCutsCouple )

virtual void	SetupForMaterial (const G4ParticleDefinition , const G4Material , G4double kineticEnergy)

virtual void	DefineForRegion (const G4Region *)

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

Protected Member Functions
void	DefineMaterial (const G4MaterialCutsCouple *)

void	SetupParticle (const G4ParticleDefinition *)

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
G4IonTable *	theIonTable

G4ParticleChangeForGamma *	fParticleChange

G4WentzelOKandVIxSection *	wokvi

G4NistManager *	fNistManager

const std::vector< G4double > *	pCuts

const G4MaterialCutsCouple *	currentCouple

const G4Material *	currentMaterial

G4int	currentMaterialIndex

G4double	cosThetaMin

G4double	cosThetaMax

G4double	cosTetMinNuc

G4double	cosTetMaxNuc

G4double	recoilThreshold

G4double	elecRatio

G4double	mass

G4double	fixedCut

const G4ParticleDefinition *	particle

const G4ParticleDefinition *	theProton

G4double	lowEnergyThreshold

Protected Attributes inherited from G4VEmModel
G4ElementData *	fElementData

G4VParticleChange *	pParticleChange

G4PhysicsTable *	xSectionTable

const std::vector< G4double > *	theDensityFactor

const std::vector< G4int > *	theDensityIdx

size_t	idxTable

Detailed Description

Definition at line 78 of file G4eCoulombScatteringModel.hh.

Constructor & Destructor Documentation

G4eCoulombScatteringModel::G4eCoulombScatteringModel ( const G4String & nam = "eCoulombScattering" )

Definition at line 80 of file G4eCoulombScatteringModel.cc.

References cosTetMaxNuc, cosTetMinNuc, currentCouple, currentMaterial, currentMaterialIndex, elecRatio, fixedCut, fNistManager, fParticleChange, G4ParticleTable::GetIonTable(), G4ParticleTable::GetParticleTable(), G4NistManager::Instance(), python.hepunit::keV, lowEnergyThreshold, mass, particle, pCuts, G4Proton::Proton(), python.hepunit::proton_mass_c2, recoilThreshold, theIonTable, theProton, and wokvi.

   : G4VEmModel(nam),
     cosThetaMin(1.0),
     cosThetaMax(-1.0),
     isInitialised(false)
 {
   fParticleChange = 0;
   fNistManager = G4NistManager::Instance();
   theIonTable  = G4ParticleTable::GetParticleTable()->GetIonTable();
   theProton    = G4Proton::Proton();
   currentMaterial = 0; 
   fixedCut = -1.0;
 
   pCuts = 0;
 
   lowEnergyThreshold = 1*keV;  // particle will be killed for lower energy
   recoilThreshold = 0.*keV; // by default does not work
 
   particle = 0;
   currentCouple = 0;
   wokvi = new G4WentzelOKandVIxSection();
 
   currentMaterialIndex = 0;
 
   cosTetMinNuc = 1.0;
   cosTetMaxNuc = -1.0;
   elecRatio = 0.0;
   mass = proton_mass_c2;
 }

G4eCoulombScatteringModel::~G4eCoulombScatteringModel ( )

virtual

Definition at line 112 of file G4eCoulombScatteringModel.cc.

References wokvi.

 {
   delete wokvi;
 }

Member Function Documentation

G4double G4eCoulombScatteringModel::ComputeCrossSectionPerAtom	(	const G4ParticleDefinition *	p,
		G4double	kinEnergy,
		G4double	Z,
		G4double	A,
		G4double	cut,
		G4double	emax
	)

virtual

Reimplemented from G4VEmModel.

Definition at line 187 of file G4eCoulombScatteringModel.cc.

References G4WentzelOKandVIxSection::ComputeElectronCrossSection(), G4WentzelOKandVIxSection::ComputeNuclearCrossSection(), cosTetMaxNuc, cosTetMinNuc, cosThetaMax, G4VEmModel::CurrentCouple(), currentMaterial, DefineMaterial(), elecRatio, fixedCut, iz, particle, G4WentzelOKandVIxSection::SetupKinematic(), SetupParticle(), G4WentzelOKandVIxSection::SetupTarget(), theProton, and wokvi.

Referenced by SampleSecondaries().

 {
   //G4cout << "### G4eCoulombScatteringModel::ComputeCrossSectionPerAtom  for " 
   //<< p->GetParticleName()<<" Z= "<<Z<<" e(MeV)= "<< kinEnergy/MeV << G4endl; 
   G4double cross = 0.0;
   if(p != particle) { SetupParticle(p); }
 
   // cross section is set to zero to avoid problems in sample secondary
   if(kinEnergy <= 0.0) { return cross; }
   DefineMaterial(CurrentCouple());
   cosTetMinNuc = wokvi->SetupKinematic(kinEnergy, currentMaterial);
   if(cosThetaMax < cosTetMinNuc) {
     G4int iz = G4int(Z);
     G4double cut = cutEnergy;
     if(fixedCut > 0.0) { cut = fixedCut; }
     cosTetMinNuc = wokvi->SetupTarget(iz, cut);
     cosTetMaxNuc = cosThetaMax; 
     if(iz == 1 && cosTetMaxNuc < 0.0 && particle == theProton) { 
       cosTetMaxNuc = 0.0; 
     }
     cross =  wokvi->ComputeNuclearCrossSection(cosTetMinNuc, cosTetMaxNuc);
     elecRatio = wokvi->ComputeElectronCrossSection(cosTetMinNuc, cosThetaMax);
     cross += elecRatio;
     if(cross > 0.0) { elecRatio /= cross; }  
   }
   /*
   if(p->GetParticleName() == "e-") 
   G4cout << "e(MeV)= " << kinEnergy/MeV << " cross(b)= " << cross/barn  
      << " 1-cosTetMinNuc= " << 1-cosTetMinNuc
      << " 1-cosTetMaxNuc= " << 1-cosTetMaxNuc
      << G4endl;
   */
   return cross;  
 }

void G4eCoulombScatteringModel::DefineMaterial ( const G4MaterialCutsCouple * cup )

inlineprotected

Definition at line 171 of file G4eCoulombScatteringModel.hh.

References currentCouple, currentMaterial, currentMaterialIndex, G4MaterialCutsCouple::GetIndex(), and G4MaterialCutsCouple::GetMaterial().

Referenced by ComputeCrossSectionPerAtom(), and SampleSecondaries().

 { 
   if(cup != currentCouple) {
     currentCouple = cup;
     currentMaterial = cup->GetMaterial();
     currentMaterialIndex = currentCouple->GetIndex(); 
   }
 }

G4double G4eCoulombScatteringModel::GetFixedCut ( ) const

inline

Definition at line 216 of file G4eCoulombScatteringModel.hh.

References fixedCut.

 {
   return fixedCut;
 }

void G4eCoulombScatteringModel::Initialise	(	const G4ParticleDefinition *	part,
		const G4DataVector &	cuts
	)

virtual

Implements G4VEmModel.

Definition at line 119 of file G4eCoulombScatteringModel.cc.

References cosThetaMin, currentCouple, fParticleChange, G4VEmModel::GetParticleChangeForGamma(), G4WentzelOKandVIxSection::Initialise(), G4VEmModel::InitialiseElementSelectors(), G4VEmModel::IsMaster(), pCuts, G4VEmModel::PolarAngleLimit(), SetupParticle(), and wokvi.

 {
   SetupParticle(part);
   currentCouple = 0;
   cosThetaMin = cos(PolarAngleLimit());
   wokvi->Initialise(part, cosThetaMin);
   /*      
   G4cout << "G4eCoulombScatteringModel: " << particle->GetParticleName()
          << "  1-cos(ThetaLimit)= " << 1 - cosThetaMin
      << "  cos(thetaMax)= " <<  cosThetaMax
      << G4endl;
   */
   pCuts = &cuts;
   //  G4ProductionCutsTable::GetProductionCutsTable()->GetEnergyCutsVector(3);
   /*
   G4cout << "!!! G4eCoulombScatteringModel::Initialise for " 
      << part->GetParticleName() << "  cos(TetMin)= " << cosThetaMin 
      << "  cos(TetMax)= " << cosThetaMax <<G4endl;
   G4cout << "cut= " << pCuts[0] << "  cut1= " << pCuts[1] << G4endl;
   */
   if(!isInitialised) {
     isInitialised = true;
     fParticleChange = GetParticleChangeForGamma();
   }
   if(IsMaster() && mass < GeV && part->GetParticleName() != "GenericIon") {
     InitialiseElementSelectors(part,cuts);
   }
 }

void G4eCoulombScatteringModel::InitialiseLocal	(	const G4ParticleDefinition *	,
		G4VEmModel *	masterModel
	)

virtual

Reimplemented from G4VEmModel.

Definition at line 151 of file G4eCoulombScatteringModel.cc.

References G4VEmModel::GetElementSelectors(), and G4VEmModel::SetElementSelectors().

 {
   SetElementSelectors(masterModel->GetElementSelectors());
 }

G4double G4eCoulombScatteringModel::MinPrimaryEnergy	(	const G4Material *	material,
		const G4ParticleDefinition *	part,
		G4double
	)

virtual

Reimplemented from G4VEmModel.

Definition at line 160 of file G4eCoulombScatteringModel.cc.

References G4VEmModel::CurrentCouple(), fNistManager, G4lrint(), G4NistManager::GetAtomicMassAmu(), G4Material::GetElementVector(), G4NucleiProperties::GetNuclearMass(), G4Material::GetNumberOfElements(), iz, lowEnergyThreshold, G4INCL::Math::max(), pCuts, recoilThreshold, and SetupParticle().

 {
   SetupParticle(part);
 
   // define cut using cuts for proton
   G4double cut = 
     std::max(recoilThreshold, (*pCuts)[CurrentCouple()->GetIndex()]);
 
   // find out lightest element
   const G4ElementVector* theElementVector = material->GetElementVector();
   G4int nelm = material->GetNumberOfElements();
   G4int Z = 300;
   for (G4int j=0; j<nelm; ++j) {        
     G4int iz = (G4int)(*theElementVector)[j]->GetZ();
     if(iz < Z) { Z = iz; }
   }
   G4int A = G4lrint(fNistManager->GetAtomicMassAmu(Z));
   G4double targetMass = G4NucleiProperties::GetNuclearMass(A, Z);
   G4double t = std::max(cut, 0.5*(cut + sqrt(2*cut*targetMass)));
 
   return std::max(lowEnergyThreshold, t);
 }

void G4eCoulombScatteringModel::SampleSecondaries	(	std::vector< G4DynamicParticle * > *	fvect,
		const G4MaterialCutsCouple *	couple,
		const G4DynamicParticle *	dp,
		G4double	tmin,
		G4double	maxEnergy
	)

virtual

Implements G4VEmModel.

Definition at line 228 of file G4eCoulombScatteringModel.cc.

References ComputeCrossSectionPerAtom(), cosTetMinNuc, cosThetaMax, currentMaterialIndex, DefineMaterial(), elecRatio, fixedCut, fParticleChange, G4DynamicParticle::GetDefinition(), G4IonTable::GetIon(), G4DynamicParticle::GetKineticEnergy(), G4DynamicParticle::GetMomentumDirection(), G4WentzelOKandVIxSection::GetMomentumSquare(), G4NucleiProperties::GetNuclearMass(), G4Element::GetZ(), iz, lowEnergyThreshold, mass, G4INCL::Math::max(), particle, pCuts, G4VParticleChange::ProposeLocalEnergyDeposit(), G4ParticleChangeForGamma::ProposeMomentumDirection(), G4VParticleChange::ProposeNonIonizingEnergyDeposit(), recoilThreshold, CLHEP::Hep3Vector::rotateUz(), G4WentzelOKandVIxSection::SampleSingleScattering(), G4VEmModel::SelectIsotopeNumber(), G4VEmModel::SelectRandomAtom(), G4ParticleChangeForGamma::SetProposedKineticEnergy(), G4WentzelOKandVIxSection::SetTargetMass(), SetupParticle(), theIonTable, wokvi, and CLHEP::Hep3Vector::z().

 {
   G4double kinEnergy = dp->GetKineticEnergy();
 
   // absorb particle below low-energy limit to avoid situation
   // when a particle has no energy loss
   if(kinEnergy < lowEnergyThreshold) { 
     fParticleChange->SetProposedKineticEnergy(0.0);
     fParticleChange->ProposeLocalEnergyDeposit(kinEnergy);
     fParticleChange->ProposeNonIonizingEnergyDeposit(kinEnergy);
     return; 
   }
   SetupParticle(dp->GetDefinition());
   DefineMaterial(couple);
   /*
   G4cout << "G4eCoulombScatteringModel::SampleSecondaries e(MeV)= " 
      << kinEnergy << "  " << particle->GetParticleName() 
      << " cut= " << cutEnergy<< G4endl;
   */
   // Choose nucleus
   G4double cut = cutEnergy;
   if(fixedCut > 0.0) { cut = fixedCut; }
 
   const G4Element* currentElement = 
     SelectRandomAtom(couple,particle,kinEnergy,cut,kinEnergy);
 
   G4double Z = currentElement->GetZ();
 
   if(ComputeCrossSectionPerAtom(particle,kinEnergy, Z,
                 kinEnergy, cut, kinEnergy) == 0.0) 
     { return; }
 
   G4int iz = G4int(Z);
   G4int ia = SelectIsotopeNumber(currentElement);
   G4double targetMass = G4NucleiProperties::GetNuclearMass(ia, iz);
   wokvi->SetTargetMass(targetMass);
 
   G4ThreeVector newDirection = 
     wokvi->SampleSingleScattering(cosTetMinNuc, cosThetaMax, elecRatio);
   G4double cost = newDirection.z();
 
   G4ThreeVector direction = dp->GetMomentumDirection(); 
   newDirection.rotateUz(direction);   
 
   fParticleChange->ProposeMomentumDirection(newDirection);   
 
   // recoil sampling assuming a small recoil
   // and first order correction to primary 4-momentum
   G4double mom2 = wokvi->GetMomentumSquare();
   G4double trec = mom2*(1.0 - cost)
     /(targetMass + (mass + kinEnergy)*(1.0 - cost));
 
   // the check likely not needed
   if(trec > kinEnergy) { trec = kinEnergy; }
   G4double finalT = kinEnergy - trec; 
   G4double edep = 0.0;
   //G4cout<<"G4eCoulombScatteringModel: finalT= "<<finalT<<" Trec= "
   //    <<trec << " Z= " << iz << " A= " << ia<<G4endl;
 
   G4double tcut = recoilThreshold;
   if(pCuts) { tcut= std::max(tcut,(*pCuts)[currentMaterialIndex]); }
 
   if(trec > tcut) {
     G4ParticleDefinition* ion = theIonTable->GetIon(iz, ia, 0);
     G4ThreeVector dir = (direction*sqrt(mom2) - 
              newDirection*sqrt(finalT*(2*mass + finalT))).unit();
     G4DynamicParticle* newdp = new G4DynamicParticle(ion, dir, trec);
     fvect->push_back(newdp);
   } else {
     edep = trec;
     fParticleChange->ProposeNonIonizingEnergyDeposit(edep);
   }
 
   // finelize primary energy and energy balance
   // this threshold may be applied only because for low-enegry
   // e+e- msc model is applied
   if(finalT <= lowEnergyThreshold) { 
     edep += finalT;  
     finalT = 0.0;
   } 
   fParticleChange->SetProposedKineticEnergy(finalT);
   fParticleChange->ProposeLocalEnergyDeposit(edep);
 }

void G4eCoulombScatteringModel::SetFixedCut ( G4double val )

inline

Definition at line 209 of file G4eCoulombScatteringModel.hh.

References fixedCut.

 {
   fixedCut = val;
 }

void G4eCoulombScatteringModel::SetLowEnergyThreshold ( G4double val )

inline

Definition at line 195 of file G4eCoulombScatteringModel.hh.

References lowEnergyThreshold.

Referenced by PhysListEmStandardWVI::ConstructProcess().

 {
   lowEnergyThreshold = val;
 }

void G4eCoulombScatteringModel::SetRecoilThreshold ( G4double eth )

inline

Definition at line 202 of file G4eCoulombScatteringModel.hh.

References recoilThreshold.

 {
   recoilThreshold = eth;
 }

void G4eCoulombScatteringModel::SetupParticle ( const G4ParticleDefinition * p )

inlineprotected

Definition at line 183 of file G4eCoulombScatteringModel.hh.

References G4ParticleDefinition::GetPDGMass(), mass, particle, G4WentzelOKandVIxSection::SetupParticle(), and wokvi.

Referenced by ComputeCrossSectionPerAtom(), Initialise(), MinPrimaryEnergy(), and SampleSecondaries().

 {
   // Initialise mass and charge
   if(p != particle) {
     particle = p;
     mass = particle->GetPDGMass();
     wokvi->SetupParticle(p);
   }
 }